/lib/BuildTasks/MSBuild.Community.Tasks.xml

https://github.com/AGBrown/AutofacABContrib · XML · 10475 lines · 10471 code · 4 blank · 0 comment · 0 complexity · 0b2337134507212a5aac862f6dcbc90b MD5 · raw file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>MSBuild.Community.Tasks</name>
  5. </assembly>
  6. <members>
  7. <member name="T:MSBuild.Community.Tasks.AspNet.InstallAspNet">
  8. <summary>
  9. Installs and register script mappings for ASP.NET
  10. </summary>
  11. <remarks>Uses the aspnet_regiis.exe tool included with the .NET Framework.</remarks>
  12. <example>
  13. Install the latest version of ASP.NET on the server:
  14. <code>
  15. <![CDATA[ <InstallAspNet /> ]]>
  16. </code>
  17. </example><example>
  18. Install the latest version of ASP.NET on the server, but do not update script maps:
  19. <code>
  20. <![CDATA[ <InstallAspNet ApplyScriptMaps="Never" /> ]]>
  21. </code>
  22. </example><example>
  23. Install the script maps for ASP.NET 2.0 on a web directory on the default website:
  24. <code>
  25. <![CDATA[ <InstallAspNet Path="MyApplication" Version="Version20" /> ]]>
  26. </code>
  27. </example><example>
  28. Install the script maps for ASP.NET 1.1 on a web directory on a non-default website:
  29. <code>
  30. <![CDATA[ <InstallAspNet Path="MyApplication" Version="W3SVC/3/Root/Version11" /> ]]>
  31. </code>
  32. </example><example>
  33. Install client side script only for the latest version:
  34. <code>
  35. <![CDATA[ <InstallAspNet ClientScriptsOnly="True" /> ]]>
  36. </code>
  37. </example>
  38. </member>
  39. <member name="M:MSBuild.Community.Tasks.AspNet.InstallAspNet.GenerateFullPathToTool">
  40. <summary>
  41. Returns the fully qualified path to the executable file.
  42. </summary>
  43. <returns>
  44. The fully qualified path to the executable file.
  45. </returns>
  46. </member>
  47. <member name="M:MSBuild.Community.Tasks.AspNet.InstallAspNet.GenerateCommandLineCommands">
  48. <summary>
  49. Returns a string value containing the command line arguments
  50. to pass directly to the executable file.
  51. </summary>
  52. <returns>
  53. A string value containing the command line arguments to pass
  54. directly to the executable file.
  55. </returns>
  56. </member>
  57. <member name="M:MSBuild.Community.Tasks.AspNet.InstallAspNet.Execute">
  58. <summary>
  59. When overridden in a derived class, executes the task.
  60. </summary>
  61. <returns>
  62. True if the task successfully executed; otherwise, false.
  63. </returns>
  64. </member>
  65. <member name="M:MSBuild.Community.Tasks.AspNet.InstallAspNet.IsValidPropertyCombinations">
  66. <summary>
  67. Determines if the current property values can be used together
  68. </summary>
  69. <returns><see langword="true"/> when properties can be used together.</returns>
  70. <exclude />
  71. </member>
  72. <member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Version">
  73. <summary>
  74. The version of ASP.NET to install
  75. </summary>
  76. <remarks>
  77. The default behavior is to use the latest version of ASP.NET available on the computer.
  78. <list type="table">
  79. <listheader><term>Version</term></listheader>
  80. <item><term>Version11</term><description>ASP.NET v1.1</description></item>
  81. <item><term>Version20</term><description>ASP.NET v2.0</description></item>
  82. <item><term>VersionLatest</term><description>The latest version of ASP.NET available</description></item>
  83. </list>
  84. </remarks>
  85. </member>
  86. <member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ApplyScriptMaps">
  87. <summary>
  88. The method used to determine if ASP.NET script mappings should be applied
  89. </summary>
  90. <remarks>
  91. The default behavior is to register script mappings on all sites except those with a newer version of ASP.NET.
  92. <list type="table">
  93. <listheader><term>Value</term></listheader>
  94. <item><term>Never</term><description>Register ASP.NET on the computer without updating any script mappings.</description></item>
  95. <item><term>IfNoneExist</term><description>Register script mappings only on for sites that do not have any existing ASP.NET script mappings (not available for ASP.NET v1.1)</description></item>
  96. <item><term>UnlessNewerExist</term><description>Register script mappings on all sites except those with a newer version of ASP.NET.</description></item>
  97. <item><term>Always</term><description>Register script mappings on all sites, even if they already have a newer version of ASP.NET.</description></item>
  98. </list>
  99. </remarks>
  100. </member>
  101. <member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ClientScriptsOnly">
  102. <summary>
  103. When <see langword="true"/>, the aspnet_client scripts will be installed. No script mappings will be updated.
  104. </summary>
  105. <remarks>This cannot be <see langword="true"/> if a value for <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Path"/> or <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ApplyScriptMaps"/> has been specified.</remarks>
  106. </member>
  107. <member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Path">
  108. <summary>
  109. The web application that should have its script maps updated.
  110. </summary>
  111. <remarks>
  112. The path must be of the form W3SVC/[instance]/Root/[webdirectory], for example W3SVC/1/Root/SampleApp1.
  113. As a shortcut, you can specify just the web directory name,
  114. if the web directory is installed in the default website instance (W3SVC/1/Root).
  115. <para>You should not specify a value for <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ApplyScriptMaps"/> when specifying a path.</para>
  116. </remarks>
  117. </member>
  118. <member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Recursive">
  119. <summary>
  120. When <see langword="true"/>, script maps are applied recursively under <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Path"/>.
  121. </summary>
  122. <remarks>This property is only valid when specifying a value for <see cref="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.Path"/>. It is <see langword="true"/> by default.</remarks>
  123. </member>
  124. <member name="P:MSBuild.Community.Tasks.AspNet.InstallAspNet.ToolName">
  125. <summary>
  126. Gets the name of the executable file to run.
  127. </summary>
  128. <value></value>
  129. <returns>The name of the executable file to run.</returns>
  130. </member>
  131. <member name="T:MSBuild.Community.Tasks.AssemblyInfo">
  132. <summary>
  133. Generates an AssemblyInfo files
  134. </summary>
  135. <example>
  136. <para>Generates a common version file.</para>
  137. <code><![CDATA[
  138. <AssemblyInfo CodeLanguage="CS"
  139. OutputFile="VersionInfo.cs"
  140. AssemblyVersion="1.0.0.0"
  141. AssemblyFileVersion="1.0.0.0" />
  142. ]]></code>
  143. <para>Generates a complete version file.</para>
  144. <code><![CDATA[
  145. <AssemblyInfo CodeLanguage="CS"
  146. OutputFile="$(MSBuildProjectDirectory)\Test\GlobalInfo.cs"
  147. AssemblyTitle="AssemblyInfoTask"
  148. AssemblyDescription="AssemblyInfo Description"
  149. AssemblyConfiguration=""
  150. AssemblyCompany="Company Name, LLC"
  151. AssemblyProduct="AssemblyInfoTask"
  152. AssemblyCopyright="Copyright (c) Company Name, LLC 2006"
  153. AssemblyTrademark=""
  154. ComVisible="false"
  155. CLSCompliant="true"
  156. Guid="d038566a-1937-478a-b5c5-b79c4afb253d"
  157. AssemblyVersion="1.0.0.0"
  158. AssemblyFileVersion="1.0.0.0" />
  159. ]]></code>
  160. <para>Generates a complete version file for C++/CLI.</para>
  161. <code><![CDATA[
  162. <AssemblyInfo CodeLanguage="CPP"
  163. OutputFile="$(MSBuildProjectDirectory)\Properties\AssemblyInfo.cpp"
  164. AssemblyTitle="MyAssembly"
  165. AssemblyDescription="MyAssembly Description"
  166. AssemblyConfiguration="$(Configuration)"
  167. AssemblyCompany="Company Name, LLC"
  168. AssemblyProduct="MyAssembly"
  169. AssemblyCopyright="Copyright (c) Company Name, LLC 2008"
  170. AssemblyTrademark=""
  171. ComVisible="false"
  172. CLSCompliant="true"
  173. Guid="d038566a-1937-478a-b5c5-b79c4afb253d"
  174. AssemblyVersion="1.0.0.0"
  175. AssemblyFileVersion="1.0.0.0"
  176. UnmanagedCode="true" />
  177. ]]></code>
  178. </example>
  179. </member>
  180. <member name="F:MSBuild.Community.Tasks.AssemblyInfo.DEFAULT_OUTPUT_FILE">
  181. <summary>
  182. The default value of <see cref="P:MSBuild.Community.Tasks.AssemblyInfo.OutputFile"/>.
  183. The value is <c>"AssemblyInfo.cs"</c>.
  184. </summary>
  185. </member>
  186. <member name="M:MSBuild.Community.Tasks.AssemblyInfo.#ctor">
  187. <summary>
  188. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.AssemblyInfo"/> class.
  189. </summary>
  190. </member>
  191. <member name="M:MSBuild.Community.Tasks.AssemblyInfo.Execute">
  192. <summary>
  193. When overridden in a derived class, executes the task.
  194. </summary>
  195. <returns>
  196. true if the task successfully executed; otherwise, false.
  197. </returns>
  198. </member>
  199. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.CodeLanguage">
  200. <summary>
  201. Gets or sets the code language.
  202. </summary>
  203. <value>The code language.</value>
  204. </member>
  205. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.ComVisible">
  206. <summary>
  207. Gets or sets a value indicating whether [COMVisible].
  208. </summary>
  209. <value><c>true</c> if [COMVisible]; otherwise, <c>false</c>.</value>
  210. </member>
  211. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.CLSCompliant">
  212. <summary>
  213. Gets or sets a value indicating whether [CLSCompliant].
  214. </summary>
  215. <value><c>true</c> if [CLSCompliant]; otherwise, <c>false</c>.</value>
  216. </member>
  217. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.Guid">
  218. <summary>
  219. Gets or sets the GUID.
  220. </summary>
  221. <value>The GUID.</value>
  222. </member>
  223. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyTitle">
  224. <summary>
  225. Gets or sets the assembly title.
  226. </summary>
  227. <value>The assembly title.</value>
  228. </member>
  229. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyDescription">
  230. <summary>
  231. Gets or sets the assembly description.
  232. </summary>
  233. <value>The assembly description.</value>
  234. </member>
  235. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyConfiguration">
  236. <summary>
  237. Gets or sets the assembly configuration.
  238. </summary>
  239. <value>The assembly configuration.</value>
  240. </member>
  241. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyCompany">
  242. <summary>
  243. Gets or sets the assembly company.
  244. </summary>
  245. <value>The assembly company.</value>
  246. </member>
  247. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyProduct">
  248. <summary>
  249. Gets or sets the assembly product.
  250. </summary>
  251. <value>The assembly product.</value>
  252. </member>
  253. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyCopyright">
  254. <summary>
  255. Gets or sets the assembly copyright.
  256. </summary>
  257. <value>The assembly copyright.</value>
  258. </member>
  259. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyTrademark">
  260. <summary>
  261. Gets or sets the assembly trademark.
  262. </summary>
  263. <value>The assembly trademark.</value>
  264. </member>
  265. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyCulture">
  266. <summary>
  267. Gets or sets the assembly culture.
  268. </summary>
  269. <value>The assembly culture.</value>
  270. </member>
  271. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyVersion">
  272. <summary>
  273. Gets or sets the assembly version.
  274. </summary>
  275. <value>The assembly version.</value>
  276. </member>
  277. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyFileVersion">
  278. <summary>
  279. Gets or sets the assembly file version.
  280. </summary>
  281. <value>The assembly file version.</value>
  282. </member>
  283. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyInformationalVersion">
  284. <summary>
  285. Gets or sets the assembly informational version.
  286. </summary>
  287. <value>The assembly informational version.</value>
  288. </member>
  289. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyKeyFile">
  290. <summary>
  291. Gets or sets the assembly key file.
  292. </summary>
  293. </member>
  294. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyKeyName">
  295. <summary>
  296. Gets or sets the assembly key name.
  297. </summary>
  298. </member>
  299. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AssemblyDelaySign">
  300. <summary>
  301. Gets or sets the assembly delay sign value.
  302. </summary>
  303. </member>
  304. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.SkipVerification">
  305. <summary>
  306. Gets or sets the assembly delay sign value.
  307. </summary>
  308. </member>
  309. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.UnmanagedCode">
  310. <summary>
  311. Gets or sets the assembly delay sign value.
  312. </summary>
  313. </member>
  314. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.GenerateClass">
  315. <summary>
  316. Gets or sets a value indicating whether to generate the ThisAssmebly class.
  317. </summary>
  318. </member>
  319. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.NeutralResourcesLanguage">
  320. <summary>
  321. Gets or sets the neutral language which is used as a fallback language configuration
  322. if the locale on the computer isn't supported. Example is setting this to "en-US".
  323. </summary>
  324. </member>
  325. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.UltimateResourceFallbackLocation">
  326. <summary>
  327. Gets or sets the ultimate resource fallback location.
  328. </summary>
  329. <value>The ultimate resource fallback location.</value>
  330. </member>
  331. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.InternalsVisibleTo">
  332. <summary>
  333. Makes it possible to make certain assemblies able to use constructs marked as internal.
  334. Example might be setting this value to "UnitTests" assembly. The typical use case might
  335. be constructors in classes which shouldn't be available to other assemblies, but the unit
  336. tests should be able to use them.
  337. </summary>
  338. </member>
  339. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.AllowPartiallyTrustedCallers">
  340. <summary>
  341. Gets or sets whether to allow strong-named assemblies to be called by partially trusted code.
  342. </summary>
  343. </member>
  344. <member name="P:MSBuild.Community.Tasks.AssemblyInfo.OutputFile">
  345. <summary>
  346. Gets or sets the output file.
  347. </summary>
  348. <value>The output file.</value>
  349. </member>
  350. <member name="T:MSBuild.Community.Tasks.Attrib">
  351. <summary>
  352. Changes the attributes of files and/or directories
  353. </summary>
  354. <example>
  355. <para>Make file Readonly, Hidden and System.</para>
  356. <code><![CDATA[
  357. <Attrib Files="Test\version.txt"
  358. ReadOnly="true" Hidden="true" System="true"/>
  359. ]]></code>
  360. <para>Clear Hidden and System attributes.</para>
  361. <code><![CDATA[
  362. <Attrib Files="Test\version.txt"
  363. Hidden="false" System="false"/>
  364. ]]></code>
  365. <para>Make file Normal.</para>
  366. <code><![CDATA[
  367. <Attrib Files="Test\version.txt"
  368. Normal="true"/>
  369. ]]></code>
  370. </example>
  371. </member>
  372. <member name="M:MSBuild.Community.Tasks.Attrib.Execute">
  373. <summary>
  374. Executes the task.
  375. </summary>
  376. <returns><see langword="true"/> if the task ran successfully;
  377. otherwise <see langword="false"/>.</returns>
  378. </member>
  379. <member name="P:MSBuild.Community.Tasks.Attrib.Files">
  380. <summary>
  381. Gets or sets the list of files to change attributes on.
  382. </summary>
  383. <value>The files to change attributes on.</value>
  384. </member>
  385. <member name="P:MSBuild.Community.Tasks.Attrib.Directories">
  386. <summary>
  387. Gets or sets the list of directories to change attributes on.
  388. </summary>
  389. <value>The directories to change attributes on.</value>
  390. </member>
  391. <member name="P:MSBuild.Community.Tasks.Attrib.Archive">
  392. <summary>
  393. Gets or sets file's archive status.
  394. </summary>
  395. <value><c>true</c> if archive; otherwise, <c>false</c>.</value>
  396. </member>
  397. <member name="P:MSBuild.Community.Tasks.Attrib.Compressed">
  398. <summary>
  399. Gets or sets a value indicating file is compressed.
  400. </summary>
  401. <value><c>true</c> if compressed; otherwise, <c>false</c>.</value>
  402. </member>
  403. <member name="P:MSBuild.Community.Tasks.Attrib.Encrypted">
  404. <summary>
  405. Gets or sets a value indicating file is encrypted.
  406. </summary>
  407. <value><c>true</c> if encrypted; otherwise, <c>false</c>.</value>
  408. </member>
  409. <member name="P:MSBuild.Community.Tasks.Attrib.Hidden">
  410. <summary>
  411. Gets or sets a value indicating file is hidden, and thus is not included in an ordinary directory listing.
  412. </summary>
  413. <value><c>true</c> if hidden; otherwise, <c>false</c>.</value>
  414. </member>
  415. <member name="P:MSBuild.Community.Tasks.Attrib.Normal">
  416. <summary>
  417. Gets or sets a value indicating file is normal and has no other attributes set.
  418. </summary>
  419. <value><c>true</c> if normal; otherwise, <c>false</c>.</value>
  420. </member>
  421. <member name="P:MSBuild.Community.Tasks.Attrib.ReadOnly">
  422. <summary>
  423. Gets or sets a value indicating file is read-only.
  424. </summary>
  425. <value><c>true</c> if read-only; otherwise, <c>false</c>.</value>
  426. </member>
  427. <member name="P:MSBuild.Community.Tasks.Attrib.System">
  428. <summary>
  429. Gets or sets a value indicating file is a system file.
  430. </summary>
  431. <value><c>true</c> if system; otherwise, <c>false</c>.</value>
  432. </member>
  433. <member name="T:MSBuild.Community.Tasks.ByteDescriptions">
  434. <summary>
  435. Describes certain byte measurements as nice strings.
  436. </summary>
  437. </member>
  438. <member name="T:MSBuild.Community.Tasks.Computer">
  439. <summary>
  440. Provides information about the build computer.
  441. </summary>
  442. <example>Get build computer information.
  443. <code><![CDATA[
  444. <Computer>
  445. <Output TaskParameter="Name" PropertyName="BuildMachineName" />
  446. <Output TaskParameter="IPAddress" PropertyName="BuildMachineIPAddress" />
  447. <Output TaskParameter="OSPlatform" PropertyName="BuildMachineOSPlatform" />
  448. <Output TaskParameter="OSVersion" PropertyName="BuildMachineOSVersion" />
  449. </Computer>
  450. ]]></code>
  451. </example>
  452. </member>
  453. <member name="M:MSBuild.Community.Tasks.Computer.#ctor">
  454. <summary>
  455. Initializes a new instance of the <see cref="T:Computer"/> class.
  456. </summary>
  457. </member>
  458. <member name="M:MSBuild.Community.Tasks.Computer.Execute">
  459. <summary>
  460. Executes the task.
  461. </summary>
  462. <returns>
  463. <see langword="true"/> if the task ran successfully; otherwise <see langword="false"/>.
  464. </returns>
  465. </member>
  466. <member name="P:MSBuild.Community.Tasks.Computer.Name">
  467. <summary>
  468. Gets the host name of the build computer.
  469. </summary>
  470. </member>
  471. <member name="P:MSBuild.Community.Tasks.Computer.IPAddress">
  472. <summary>
  473. Gets the IP address of the build computer.
  474. </summary>
  475. </member>
  476. <member name="P:MSBuild.Community.Tasks.Computer.OSPlatform">
  477. <summary>
  478. Gets the platform identifier of the build computer's operating system .
  479. </summary>
  480. </member>
  481. <member name="P:MSBuild.Community.Tasks.Computer.OSVersion">
  482. <summary>
  483. Gets the version number of the build computer's operating system.
  484. </summary>
  485. </member>
  486. <member name="T:MSBuild.Community.Tasks.Beep">
  487. <summary>
  488. A task to play the sound of a beep through the console speaker.
  489. </summary>
  490. <remarks>
  491. By default, the beep plays at a frequency of 800 hertz for a duration of 200 milliseconds.
  492. </remarks><example>
  493. To play the sound of a beep at a frequency of 800 hertz and for a duration of 200 milliseconds, use
  494. <code>
  495. <![CDATA[<Beep />]]>
  496. </code>
  497. </example><example>
  498. To play the sound of a beep at a frequency of 440 hertz and for a duration of 300 milliseconds, use
  499. <code>
  500. <![CDATA[<Beep Frequency="440" Duration="300" />]]>
  501. </code>
  502. </example>
  503. </member>
  504. <member name="M:MSBuild.Community.Tasks.Beep.Execute">
  505. <summary>
  506. Plays the sound of a beep
  507. at the given <see cref="P:MSBuild.Community.Tasks.Beep.Frequency"/> and for the given <see cref="P:MSBuild.Community.Tasks.Beep.Duration"/>
  508. through the console speaker.
  509. </summary>
  510. <returns>
  511. Always returns <see langword="true"/>, even when the sound could not be played.
  512. </returns>
  513. </member>
  514. <member name="P:MSBuild.Community.Tasks.Beep.Frequency">
  515. <summary>
  516. Gets or sets the frequency of the beep, ranging from 37 to 32767 hertz.
  517. Defaults to 800 hertz.
  518. </summary>
  519. </member>
  520. <member name="P:MSBuild.Community.Tasks.Beep.Duration">
  521. <summary>
  522. Gets or sets the of the beep measured in milliseconds.
  523. Defaults to 200 milliseconds.
  524. </summary>
  525. </member>
  526. <member name="T:MSBuild.Community.Tasks.DeleteTree">
  527. <summary>
  528. Delete a directory tree. This task supports wild card directory selection.
  529. </summary>
  530. <example>
  531. <para>Delete all bin and obj directories.</para>
  532. <code><![CDATA[
  533. <DeleteTree Directories="**\bin;**\obj" />
  534. ]]></code>
  535. <para>Delete all bin and obj directories that start with MSBuild.Community.</para>
  536. <code><![CDATA[
  537. <DeleteTree Directories="MSBuild.Community.*\**\bin;MSBuild.Community.*\**\obj" />
  538. ]]></code>
  539. </example>
  540. </member>
  541. <member name="M:MSBuild.Community.Tasks.DeleteTree.#ctor">
  542. <summary>
  543. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.DeleteTree"/> class.
  544. </summary>
  545. </member>
  546. <member name="M:MSBuild.Community.Tasks.DeleteTree.Execute">
  547. <summary>
  548. When overridden in a derived class, executes the task.
  549. </summary>
  550. <returns>
  551. true if the task successfully executed; otherwise, false.
  552. </returns>
  553. </member>
  554. <member name="P:MSBuild.Community.Tasks.DeleteTree.Directories">
  555. <summary>
  556. Gets or sets the directories to be deleted.
  557. </summary>
  558. <value>The directories to be deleted.</value>
  559. <remarks>
  560. Directories can contain wild cards.
  561. </remarks>
  562. </member>
  563. <member name="P:MSBuild.Community.Tasks.DeleteTree.Recursive">
  564. <summary>
  565. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.DeleteTree"/> is recursive.
  566. </summary>
  567. <value><c>true</c> if recursive; otherwise, <c>false</c>.</value>
  568. </member>
  569. <member name="P:MSBuild.Community.Tasks.DeleteTree.DeletedDirectories">
  570. <summary>
  571. Gets the deleted directories.
  572. </summary>
  573. <value>The deleted directories.</value>
  574. </member>
  575. <member name="T:MSBuild.Community.Tasks.FtpUpload">
  576. <summary>
  577. Uploads a group of files using File Transfer Protocol (FTP).
  578. </summary>
  579. <remarks>
  580. Set either LocalFiles or LocalFile but not both.
  581. </remarks>
  582. <example>Upload a file.
  583. <code><![CDATA[
  584. <FtpUpload
  585. LocalFile="MSBuild.Community.Tasks.zip"
  586. RemoteUri="ftp://localhost/" />
  587. ]]></code>
  588. Upload all the files in an ItemGroup:
  589. <code><![CDATA[
  590. <FtpUpload
  591. Username="username"
  592. Password="password"
  593. UsePassive="true"
  594. RemoteUri="ftp://webserver.com/httpdocs/"
  595. LocalFiles="@(FilesToUpload)"
  596. RemoteFiles="@(FilesToUpload->'%(RecursiveDir)%(Filename)%(Extension)')" />
  597. ]]></code>
  598. </example>
  599. </member>
  600. <member name="T:MSBuild.Community.Tasks.IFtpWebRequestCreator">
  601. <summary>
  602. Describes a factory for IFtpWebRequest.
  603. </summary>
  604. </member>
  605. <member name="M:MSBuild.Community.Tasks.IFtpWebRequestCreator.Create(System.Uri,System.String)">
  606. <summary>
  607. Instantiates an FtpWebRequest.
  608. </summary>
  609. </member>
  610. <member name="M:MSBuild.Community.Tasks.FtpUpload.#ctor">
  611. <summary>
  612. Initializes a new instance of the <see cref="T:FtpUpload"/> class.
  613. </summary>
  614. </member>
  615. <member name="M:MSBuild.Community.Tasks.FtpUpload.#ctor(MSBuild.Community.Tasks.IFtpWebRequestCreator)">
  616. <summary>
  617. Initializes a new instance that will inject the specified dependency.
  618. </summary>
  619. <param name="requestCreator"></param>
  620. </member>
  621. <member name="M:MSBuild.Community.Tasks.FtpUpload.Execute">
  622. <summary>
  623. When overridden in a derived class, executes the task.
  624. </summary>
  625. <returns>
  626. true if the task successfully executed; otherwise, false.
  627. </returns>
  628. </member>
  629. <member name="P:MSBuild.Community.Tasks.FtpUpload.LocalFile">
  630. <summary>
  631. Gets or sets the single file to upload. Use
  632. this or LocalFiles, but not both.
  633. </summary>
  634. </member>
  635. <member name="P:MSBuild.Community.Tasks.FtpUpload.LocalFiles">
  636. <summary>
  637. Gets or sets the local files to upload. Use this
  638. or LocalFile, but not both.
  639. </summary>
  640. <value>The local file.</value>
  641. </member>
  642. <member name="P:MSBuild.Community.Tasks.FtpUpload.RemoteFiles">
  643. <summary>
  644. Gets or sets the remote files to upload.
  645. Each item in this list should have a corresponding item in LocalFiles.
  646. </summary>
  647. </member>
  648. <member name="P:MSBuild.Community.Tasks.FtpUpload.RemoteUri">
  649. <summary>
  650. Gets or sets the remote URI to upload.
  651. </summary>
  652. <value>The remote URI.</value>
  653. </member>
  654. <member name="P:MSBuild.Community.Tasks.FtpUpload.Username">
  655. <summary>
  656. Gets or sets the username.
  657. </summary>
  658. <value>The username.</value>
  659. </member>
  660. <member name="P:MSBuild.Community.Tasks.FtpUpload.Password">
  661. <summary>
  662. Gets or sets the password.
  663. </summary>
  664. <value>The password.</value>
  665. </member>
  666. <member name="P:MSBuild.Community.Tasks.FtpUpload.UsePassive">
  667. <summary>
  668. Gets or sets the behavior of a client application's data transfer process.
  669. </summary>
  670. <value><c>true</c> if [use passive]; otherwise, <c>false</c>.</value>
  671. </member>
  672. <member name="T:MSBuild.Community.Tasks.IFtpWebRequest">
  673. <summary>
  674. This class references an interface that looks like FtpWebRequest
  675. in order to support unit testing without an actual FTP Server.
  676. </summary>
  677. </member>
  678. <member name="M:MSBuild.Community.Tasks.IFtpWebRequest.SetContentLength(System.Int64)">
  679. <summary>
  680. Sets the ContentLength property of the FtpWebRequest.
  681. </summary>
  682. <param name="length"></param>
  683. </member>
  684. <member name="M:MSBuild.Community.Tasks.IFtpWebRequest.GetRequestStream">
  685. <summary>
  686. Calls GetRequestStream on the FtpWebRequest.
  687. </summary>
  688. <returns></returns>
  689. </member>
  690. <member name="M:MSBuild.Community.Tasks.IFtpWebRequest.GetStatusDescriptionAndCloseResponse">
  691. <summary>
  692. Gets the StatusDescription property of the response, then closes the response
  693. on the FtpWebRequest.
  694. </summary>
  695. <returns></returns>
  696. </member>
  697. <member name="M:MSBuild.Community.Tasks.IFtpWebRequest.GetAndCloseResponse">
  698. <summary>
  699. Gets the response from the FTP server and closes it.
  700. </summary>
  701. </member>
  702. <member name="M:MSBuild.Community.Tasks.IFtpWebRequest.GetResponseStream">
  703. <summary>
  704. Gets the response stream from the FtpWebRequest.
  705. </summary>
  706. <returns></returns>
  707. </member>
  708. <member name="T:MSBuild.Community.Tasks.RealFtpWebRequest">
  709. <summary>
  710. An adapter to make the real FtpWebRequest look like
  711. an IFtpWebRequest.
  712. </summary>
  713. </member>
  714. <member name="M:MSBuild.Community.Tasks.RealFtpWebRequest.#ctor(System.Net.FtpWebRequest)">
  715. <summary>
  716. Initializes a new instance of the RealFtpWebRequest class.
  717. </summary>
  718. </member>
  719. <member name="T:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase">
  720. <summary>
  721. Ftp client base class.
  722. </summary>
  723. </member>
  724. <member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._clientSocket">
  725. <summary>
  726. The socket that will connect to the FTP server.
  727. </summary>
  728. </member>
  729. <member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._bufferSize">
  730. <summary>
  731. The size of the data buffer.
  732. </summary>
  733. </member>
  734. <member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._lastReply">
  735. <summary>
  736. The last recieved FTP response over the client socket.
  737. </summary>
  738. </member>
  739. <member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._password">
  740. <summary>
  741. The password to use to login.
  742. </summary>
  743. </member>
  744. <member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._port">
  745. <summary>
  746. The port number of the FTP server.
  747. </summary>
  748. </member>
  749. <member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._serverhost">
  750. <summary>
  751. The hostname of the FTP server.
  752. </summary>
  753. </member>
  754. <member name="F:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase._username">
  755. <summary>
  756. The username to use to login.
  757. </summary>
  758. </member>
  759. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.#ctor">
  760. <summary>
  761. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase"/> class.
  762. </summary>
  763. </member>
  764. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Connect">
  765. <summary>
  766. Connects this FTP server socket.
  767. </summary>
  768. <exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Thrown when unable to connect.</exception>
  769. </member>
  770. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Login">
  771. <summary>
  772. Login to the FTP server with the specified credentials.
  773. </summary>
  774. </member>
  775. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ChangeWorkingDirectory(System.String)">
  776. <summary>
  777. Changes the working directory.
  778. </summary>
  779. <param name="remoteDirectory">The remote directory.</param>
  780. <exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the process or the FTP server doesn't support the CWD command. See the Message of the exception for details.</exception>
  781. <remarks>Sends the CWD command.</remarks>
  782. </member>
  783. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.GetWorkingDirectory">
  784. <summary>
  785. Gets the working directory.
  786. </summary>
  787. <returns>The current working directory.</returns>
  788. </member>
  789. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.CdUp">
  790. <summary>
  791. Change to the parent of the current working directory.
  792. </summary>
  793. <exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the process or the FTP server doesn't support the CDUP command. See the Message of the exception for details.</exception>
  794. <remarks>Sends the CDUP command.</remarks>
  795. </member>
  796. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.FileExists(System.String)">
  797. <summary>
  798. Determs whether a remote file exists.
  799. </summary>
  800. <param name="remoteFile">The remote file.</param>
  801. <returns></returns>
  802. <exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the operation or if the FTP server doesn't support the SIZE command. See the Message of the exception for details.</exception>
  803. </member>
  804. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.DirectoryExists(System.String)">
  805. <summary>
  806. Determs whether a remote directory exists.
  807. </summary>
  808. <param name="remoteDirectory">The remote directory.</param>
  809. <remarks>
  810. This method is based on the succeedness of a CWD command, this can give wrong indication at a rare number of FTP server!
  811. </remarks>
  812. <exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Thrown if the opperation couldn't be executed.</exception>
  813. <returns><c>true</c> if the directory exists remotely; otherwise <c>false</c></returns>
  814. </member>
  815. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.RemoveDirectory(System.String)">
  816. <summary>
  817. Removes a remote directory.
  818. </summary>
  819. <param name="directoryName">The remote directory name.</param>
  820. <exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the process or the FTP server doesn't support the RMD command. See the Message of the exception for details.</exception>
  821. <remarks>Sends the RMD command.</remarks>
  822. </member>
  823. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.MakeDirectory(System.String)">
  824. <summary>
  825. Creates a remote directory in the current working folder.
  826. </summary>
  827. <param name="directoryName">Name of the directory.</param>
  828. <exception cref="T:MSBuild.Community.Tasks.Ftp.FtpException">Occurs if there where connection problems during the process or the FTP server doesn't support the MMD command. See the Message of the exception for details.</exception>
  829. </member>
  830. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Close">
  831. <summary>
  832. Closes the connection to the server.
  833. </summary>
  834. </member>
  835. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Store(System.String,System.String)">
  836. <summary>
  837. Stores the specified localFile.
  838. </summary>
  839. <param name="localFile">The localfile.</param>
  840. <param name="remoteFileName">The remotefile.</param>
  841. </member>
  842. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.SendCommand(System.String,System.String)">
  843. <summary>
  844. Send a command to the FTP server.
  845. </summary>
  846. <param name="command">The command, for example PWD.</param>
  847. <param name="value">The value.</param>
  848. </member>
  849. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.SendCommand(System.String)">
  850. <summary>
  851. Send a command to the FTP server.
  852. </summary>
  853. <param name="rawCommand">The full command to send.</param>
  854. </member>
  855. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.SendCommandAndReadResponse(System.String,System.String)">
  856. <summary>
  857. Send a command to the FTP server and returns the response.
  858. </summary>
  859. <param name="command">The command, for example PWD.</param>
  860. <param name="value">The value</param>
  861. <returns>The reply of the FTP server for this command.</returns>
  862. </member>
  863. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.SendCommandAndReadResponse(System.String)">
  864. <summary>
  865. Send a command to the FTP server and returns the response.
  866. </summary>
  867. <param name="rawCommand">The raw command to send.</param>
  868. <returns>The reply of the FTP server for this command.</returns>
  869. </member>
  870. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.GetDirectoryDetails">
  871. <summary>
  872. Get the full directory details of the current directory.
  873. </summary>
  874. <returns>A array that contains all the FTP files located in the currenct directory.</returns>
  875. </member>
  876. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.CreateDataStreamAndSendCommand(System.String)">
  877. <summary>
  878. Create a data stream and send a raw command.
  879. </summary>
  880. <param name="rawCommand">The raw command to send.</param>
  881. <returns>The data stream that was created.</returns>
  882. </member>
  883. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ParseDataEndPointFromMessage(System.String)">
  884. <summary>
  885. Parses the data IP end point from datarequest message.
  886. </summary>
  887. <param name="message">The message.</param>
  888. <returns></returns>
  889. </member>
  890. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.GetDirectoryDetails(System.String)">
  891. <summary>
  892. Get the full directory details of the current directory.
  893. </summary>
  894. <param name="remoteDirectory">The remove directory, emtpy or <c>null</c> will get the details of the current directory.</param>
  895. <returns>A array that contains all the FTP files located in the currenct directory.</returns>
  896. </member>
  897. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ReadResponse">
  898. <summary>
  899. Reads the ftp response from the client socket.
  900. </summary>
  901. <returns>The response of the FTP server.</returns>
  902. </member>
  903. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ReadResponseString">
  904. <summary>
  905. Reads the response string from the client socket.
  906. </summary>
  907. <returns>The response of the client socket.</returns>
  908. </member>
  909. <member name="M:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.CloseAndTrowException(System.Exception)">
  910. <summary>
  911. Make sure the connections are closed and trow the specified exception.
  912. </summary>
  913. <param name="exception">The exception to throw.</param>
  914. </member>
  915. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ServerHost">
  916. <summary>
  917. Gets or sets the server host.
  918. </summary>
  919. <value>The server host.</value>
  920. <exception cref="T:System.ArgumentOutOfRangeException">The lenght of the given value is greater then 126 characters.</exception>
  921. </member>
  922. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Port">
  923. <summary>
  924. Gets or sets the port number.
  925. </summary>
  926. <value>The port numer.</value>
  927. </member>
  928. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ClientSocket">
  929. <summary>
  930. Gets or sets the client socket.
  931. </summary>
  932. <value>The client socket.</value>
  933. </member>
  934. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Connected">
  935. <summary>
  936. Gets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase"/> is connected.
  937. </summary>
  938. <value><c>true</c> if connected; otherwise, <c>false</c>.</value>
  939. </member>
  940. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.ConversationEncoding">
  941. <summary>
  942. Gets the encoding to use with communication with the server.
  943. </summary>
  944. <value>The encoding.</value>
  945. </member>
  946. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.LastReply">
  947. <summary>
  948. Gets the last recieved FTP response over the client socket.
  949. </summary>
  950. <value>The last recieved FTP response over the client socket.</value>
  951. </member>
  952. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Username">
  953. <summary>
  954. Gets or sets the username to login.
  955. </summary>
  956. <value>The username.</value>
  957. </member>
  958. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.Password">
  959. <summary>
  960. Gets or sets the password to login.
  961. </summary>
  962. <value>The password.</value>
  963. </member>
  964. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.LogFtpMessageConversation">
  965. <summary>
  966. Gets or sets a value indicating whether the FTP message conversation should be logged.
  967. </summary>
  968. <value>
  969. <c>true</c> if the FTP message conversation should be logged; otherwise, <c>false</c>.
  970. </value>
  971. </member>
  972. <member name="P:MSBuild.Community.Tasks.Ftp.FtpClientTaskBase.BufferSize">
  973. <summary>
  974. Gets or sets the size of the data buffer.
  975. </summary>
  976. </member>
  977. <member name="T:MSBuild.Community.Tasks.Ftp.FtpCreateRemoteDirectory">
  978. <summary>
  979. Creates a full remote directory on the remote server if not exists using the File Transfer Protocol (FTP).
  980. This can be one directory or a full path to create.
  981. </summary>
  982. <example>Create remote directory:
  983. <code><![CDATA[
  984. <FtpCreateRemoteDirectoty
  985. ServerHost="ftp.myserver.com"
  986. Port="42"
  987. RemoteDirectory="Directory\Subdirectory\MyOtherSubdirectory"
  988. Username="user"
  989. Password="p@ssw0rd"
  990. />
  991. ]]></code>
  992. </example>
  993. <remarks>The full remote directory path will be created. All directories that doesn't exists on the remote server will be created.</remarks>
  994. </member>
  995. <member name="F:MSBuild.Community.Tasks.Ftp.FtpCreateRemoteDirectory._remoteDirectory">
  996. <summary>
  997. The remote directory to create.
  998. </summary>
  999. </member>
  1000. <member name="M:MSBuild.Community.Tasks.Ftp.FtpCreateRemoteDirectory.Execute">
  1001. <summary>
  1002. When overridden in a derived class, executes the task.
  1003. </summary>
  1004. <returns>
  1005. true if the task successfully executed; otherwise, false.
  1006. </returns>
  1007. </member>
  1008. <member name="P:MSBuild.Community.Tasks.Ftp.FtpCreateRemoteDirectory.RemoteDirectory">
  1009. <summary>
  1010. Gets or sets the remote directory to create.
  1011. </summary>
  1012. <value>The remote directory.</value>
  1013. <example>This can be one directory name, like <c>"Directory"</c>, or a directory path, like <c>"Directory\Subdirectoy"</c>.
  1014. </example>
  1015. </member>
  1016. <member name="T:MSBuild.Community.Tasks.Ftp.FtpDirectoryExists">
  1017. <summary>
  1018. Determ if a remote directory exists on a FTP server or not.
  1019. </summary>
  1020. <example>Determ of Directory\1 exists:
  1021. <code><![CDATA[
  1022. <Target Name="CheckIfDirectoryExists">
  1023. <FtpDirectoryExists
  1024. ServerHost="ftp.myserver.com"
  1025. Port="42"
  1026. RemoteDirectory="1\2\3"
  1027. Username="user"
  1028. Password="p@ssw0rd"
  1029. >
  1030. <Output TaskParameter="Exists" PropertyName="Exists" />
  1031. </FtpDirectoryExists>
  1032. <Message Text="Directory '1\2\3' exists: $(Exists)"/>
  1033. ]]></code>
  1034. If the directory exists on the server you should see the following output in the console:
  1035. <c>Directory '1\2\3' exists: true</c>
  1036. </example>
  1037. <remarks>The full remote directory path will be created. All directories that doesn't exists on the remote server will be created.</remarks>
  1038. </member>
  1039. <member name="F:MSBuild.Community.Tasks.Ftp.FtpDirectoryExists._remoteDirectory">
  1040. <summary>
  1041. The remote directory to create.
  1042. </summary>
  1043. </member>
  1044. <member name="F:MSBuild.Community.Tasks.Ftp.FtpDirectoryExists._exists">
  1045. <summary>
  1046. Flag that indicates whether the directory exists on the server.
  1047. </summary>
  1048. </member>
  1049. <member name="M:MSBuild.Community.Tasks.Ftp.FtpDirectoryExists.Execute">
  1050. <summary>
  1051. Executes the current task.
  1052. </summary>
  1053. <returns>
  1054. true if the task successfully executed; otherwise, false.
  1055. </returns>
  1056. </member>
  1057. <member name="P:MSBuild.Community.Tasks.Ftp.FtpDirectoryExists.RemoteDirectory">
  1058. <summary>
  1059. Gets or sets the remote directory to create.
  1060. </summary>
  1061. <value>The remote directory.</value>
  1062. <example>This can be one directory name, like <c>"Directory"</c>, or a directory path, like <c>"Directory\Subdirectoy"</c>.
  1063. </example>
  1064. </member>
  1065. <member name="P:MSBuild.Community.Tasks.Ftp.FtpDirectoryExists.Exists">
  1066. <summary>
  1067. Gets an indication whether the directory exists on the server.
  1068. </summary>
  1069. <value><c>true</c> when the directory exists on the server; otherwise <c>false</c>.</value>
  1070. </member>
  1071. <member name="T:MSBuild.Community.Tasks.Ftp.FtpException">
  1072. <summary>
  1073. Exception returned by FTP server.
  1074. </summary>
  1075. </member>
  1076. <member name="M:MSBuild.Community.Tasks.Ftp.FtpException.#ctor(System.String)">
  1077. <summary>
  1078. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Ftp.FtpException"/> class.
  1079. </summary>
  1080. <param name="message">The message.</param>
  1081. </member>
  1082. <member name="M:MSBuild.Community.Tasks.Ftp.FtpException.#ctor(System.String,System.Exception)">
  1083. <summary>
  1084. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Ftp.FtpException"/> class.
  1085. </summary>
  1086. <param name="message">The message.</param>
  1087. <param name="innerException">The inner exception.</param>
  1088. </member>
  1089. <member name="T:MSBuild.Community.Tasks.Ftp.FtpEntry">
  1090. <summary>
  1091. Represents an remote file or directory on a FTP server.
  1092. </summary>
  1093. </member>
  1094. <member name="F:MSBuild.Community.Tasks.Ftp.FtpEntry._isDirectory">
  1095. <summary>
  1096. Indicates whether this instance represents a directory.
  1097. </summary>
  1098. </member>
  1099. <member name="F:MSBuild.Community.Tasks.Ftp.FtpEntry._name">
  1100. <summary>
  1101. Represents the file or directory name.
  1102. </summary>
  1103. </member>
  1104. <member name="M:MSBuild.Community.Tasks.Ftp.FtpEntry.#ctor">
  1105. <summary>
  1106. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Ftp.FtpEntry"/> class.
  1107. </summary>
  1108. </member>
  1109. <member name="M:MSBuild.Community.Tasks.Ftp.FtpEntry.#ctor(System.Boolean,System.String)">
  1110. <summary>
  1111. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Ftp.FtpEntry"/> class.
  1112. </summary>
  1113. <param name="isDirectory">if set to <c>true</c> this instance represents a directory; otherwise, <c>false</c>.</param>
  1114. <param name="name">The name.</param>
  1115. </member>
  1116. <member name="M:MSBuild.Community.Tasks.Ftp.FtpEntry.ParseDirList(System.String[])">
  1117. <summary>
  1118. Parses the dir list.
  1119. </summary>
  1120. <param name="entryLines">The entry lines.</param>
  1121. <returns></returns>
  1122. </member>
  1123. <member name="P:MSBuild.Community.Tasks.Ftp.FtpEntry.IsDirectory">
  1124. <summary>
  1125. Gets or sets a value indicating whether this instance represents a directory.
  1126. </summary>
  1127. <value>
  1128. <c>true</c> if this instance represents a directory; otherwise, <c>false</c>.
  1129. </value>
  1130. </member>
  1131. <member name="P:MSBuild.Community.Tasks.Ftp.FtpEntry.Name">
  1132. <summary>
  1133. Gets or sets the name.
  1134. </summary>
  1135. <value>The name.</value>
  1136. </member>
  1137. <member name="T:MSBuild.Community.Tasks.Ftp.FtpReply">
  1138. <summary>
  1139. Represenatation of a FTP reply message.
  1140. </summary>
  1141. </member>
  1142. <member name="F:MSBuild.Community.Tasks.Ftp.FtpReply._resultCode">
  1143. <summary>
  1144. The result code of the FTP response.
  1145. </summary>
  1146. </member>
  1147. <member name="F:MSBuild.Community.Tasks.Ftp.FtpReply._message">
  1148. <summary>
  1149. The response message.
  1150. </summary>
  1151. </member>
  1152. <member name="M:MSBuild.Community.Tasks.Ftp.FtpReply.#ctor(System.Int32,System.String)">
  1153. <summary>
  1154. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Ftp.FtpReply"/> class.
  1155. </summary>
  1156. <param name="resultCode">The result code of the FTP response.</param>
  1157. <param name="message">The response message.</param>
  1158. </member>
  1159. <member name="P:MSBuild.Community.Tasks.Ftp.FtpReply.ResultCode">
  1160. <summary>
  1161. Gets or sets the result code.
  1162. </summary>
  1163. <value>The result code.</value>
  1164. </member>
  1165. <member name="P:MSBuild.Community.Tasks.Ftp.FtpReply.Message">
  1166. <summary>
  1167. Gets or sets the message.
  1168. </summary>
  1169. <value>The message.</value>
  1170. </member>
  1171. <member name="T:MSBuild.Community.Tasks.Ftp.FtpUploadDirectoryContent">
  1172. <summary>
  1173. Uploads a full directory content to a remote directory.
  1174. </summary>
  1175. <example>Uploads directory content, including all subdirectories and subdirectory content:
  1176. <code><![CDATA[
  1177. <Target Name="DeployWebsite">
  1178. <FtpUploadDirectoryContent
  1179. ServerHost="ftp.myserver.com"
  1180. Port="42"
  1181. Username="user"
  1182. Password="p@ssw0rd"
  1183. LocalDirectory="c:\build\mywebsite"
  1184. RemoteDirectory="root\www\mywebsite"
  1185. Recursive="true"
  1186. />
  1187. ]]></code>
  1188. To go a little step further. If the local directory looked like this:
  1189. <code>
  1190. [mywebsite]
  1191. [images]
  1192. 1.gif
  1193. 2.gif
  1194. 3.gif
  1195. [js]
  1196. clientscript.js
  1197. nofocus.js
  1198. [css]
  1199. print.css
  1200. main.css
  1201. index.htm
  1202. contact.htm
  1203. downloads.htm
  1204. </code>
  1205. All directories and there content will be uploaded and a excact copy of the content of <c>mywebsite</c> directory will be created remotely.
  1206. <remarks>
  1207. If <see cref="P:MSBuild.Community.Tasks.Ftp.FtpUploadDirectoryContent.Recursive"/> is set the <c>false</c>; only index.htm, contact.htm and downloads.htm will be uploaded and no subdirectories will be created remotely.
  1208. </remarks>
  1209. </example>
  1210. </member>
  1211. <member name="M:MSBuild.Community.Tasks.Ftp.FtpUploadDirectoryContent.Execute">
  1212. <summary>
  1213. When overridden in a derived class, executes the task.
  1214. </summary>
  1215. <returns>
  1216. true if the task successfully executed; otherwise, false.
  1217. </returns>
  1218. </member>
  1219. <member name="M:MSBuild.Community.Tasks.Ftp.FtpUploadDirectoryContent.UploadDirectory(System.String,System.Boolean)">
  1220. <summary>
  1221. Upload a directory and its file contents.
  1222. </summary>
  1223. <param name="localPath">The local path.</param>
  1224. <param name="recurse">if set to <c>true</c> all subdurectiries will be included.</param>
  1225. </member>
  1226. <member name="M:MSBuild.Community.Tasks.Ftp.FtpUploadDirectoryContent.UploadDirectory(System.String,System.String,System.Boolean)">
  1227. <summary>
  1228. Upload a directory and its file contents.
  1229. </summary>
  1230. <param name="localPath">The local path.</param>
  1231. <param name="mask">Only upload files that compli to the mask.</param>
  1232. <param name="recursive">if set to <c>true</c> all subdurectiries will be included.</param>
  1233. </member>
  1234. <member name="P:MSBuild.Community.Tasks.Ftp.FtpUploadDirectoryContent.LocalDirectory">
  1235. <summary>
  1236. Gets or sets the local directory that contains the content to upload.
  1237. </summary>
  1238. <value>The local directory.</value>
  1239. </member>
  1240. <member name="P:MSBuild.Community.Tasks.Ftp.FtpUploadDirectoryContent.RemoteDirectory">
  1241. <summary>
  1242. Gets or sets the remote directory destination for the local files.
  1243. </summary>
  1244. <value>The remote directory.</value>
  1245. </member>
  1246. <member name="P:MSBuild.Community.Tasks.Ftp.FtpUploadDirectoryContent.Recursive">
  1247. <summary>
  1248. Gets or sets a value indicating whether the subdirectories of the local directory should be created remotely and the content of these should also be uploaded.
  1249. </summary>
  1250. <value><c>true</c> if recursive; otherwise, <c>false</c>.</value>
  1251. </member>
  1252. <member name="T:MSBuild.Community.Tasks.Fusion.UninstallStatus">
  1253. <summary>
  1254. The status of an uninstall.
  1255. </summary>
  1256. </member>
  1257. <member name="F:MSBuild.Community.Tasks.Fusion.UninstallStatus.None">
  1258. <summary>
  1259. No status.
  1260. </summary>
  1261. </member>
  1262. <member name="F:MSBuild.Community.Tasks.Fusion.UninstallStatus.Uninstalled">
  1263. <summary>
  1264. Uninstalled successfully.
  1265. </summary>
  1266. </member>
  1267. <member name="F:MSBuild.Community.Tasks.Fusion.UninstallStatus.StillInUse">
  1268. <summary>
  1269. Assembly is still in use.
  1270. </summary>
  1271. </member>
  1272. <member name="F:MSBuild.Community.Tasks.Fusion.UninstallStatus.AlreadyUninstalled">
  1273. <summary>
  1274. Assembly already uninstalled or not found.
  1275. </summary>
  1276. </member>
  1277. <member name="F:MSBuild.Community.Tasks.Fusion.UninstallStatus.DeletePending">
  1278. <summary>
  1279. Assembly delete is pending.
  1280. </summary>
  1281. </member>
  1282. <member name="F:MSBuild.Community.Tasks.Fusion.UninstallStatus.HasInstallReferences">
  1283. <summary>
  1284. Assembly has a reference to an installed application.
  1285. </summary>
  1286. </member>
  1287. <member name="F:MSBuild.Community.Tasks.Fusion.UninstallStatus.ReferenceNotFound">
  1288. <summary>
  1289. Assembly not found.
  1290. </summary>
  1291. </member>
  1292. <member name="T:MSBuild.Community.Tasks.Fusion.FusionWrapper">
  1293. <summary>
  1294. A class wrapping fusion api calls
  1295. </summary>
  1296. </member>
  1297. <member name="M:MSBuild.Community.Tasks.Fusion.FusionWrapper.InstallAssembly(System.String,System.Boolean)">
  1298. <summary>
  1299. Installs the assembly.
  1300. </summary>
  1301. <param name="assemblyPath">The assembly path.</param>
  1302. <param name="force">if set to <c>true</c> force.</param>
  1303. </member>
  1304. <member name="M:MSBuild.Community.Tasks.Fusion.FusionWrapper.UninstallAssembly(System.String,System.Boolean)">
  1305. <summary>
  1306. Uninstalls the assembly.
  1307. </summary>
  1308. <param name="assemblyName">Name of the assembly.</param>
  1309. <param name="force">if set to <c>true</c> force.</param>
  1310. <returns>Returns <c>true</c> if uninstall successful.</returns>
  1311. </member>
  1312. <member name="M:MSBuild.Community.Tasks.Fusion.FusionWrapper.UninstallAssembly(System.String,System.Boolean,MSBuild.Community.Tasks.Fusion.UninstallStatus@)">
  1313. <summary>
  1314. Uninstalls the assembly.
  1315. </summary>
  1316. <param name="assemblyName">Name of the assembly.</param>
  1317. <param name="force">if set to <c>true</c> force.</param>
  1318. <param name="result">The UninstallStatus result.</param>
  1319. <returns>Returns <c>true</c> if uninstall successful.</returns>
  1320. </member>
  1321. <member name="M:MSBuild.Community.Tasks.Fusion.FusionWrapper.GetAssemblyPath(System.String)">
  1322. <summary>
  1323. Gets the assembly path.
  1324. </summary>
  1325. <param name="assemblyName">Name of the assembly.</param>
  1326. <returns>The path to the assembly in the GAC.</returns>
  1327. </member>
  1328. <member name="M:MSBuild.Community.Tasks.Fusion.FusionWrapper.GetAssemblyName(System.String)">
  1329. <summary>
  1330. Gets the name of the assembly.
  1331. </summary>
  1332. <param name="assemblyName">Name of the assembly.</param>
  1333. <returns>An <see cref="T:System.Reflection.AssemblyName"/> instance.</returns>
  1334. </member>
  1335. <member name="T:MSBuild.Community.Tasks.Git.GitClient">
  1336. <summary>
  1337. A task for Git commands.
  1338. </summary>
  1339. </member>
  1340. <member name="M:MSBuild.Community.Tasks.Git.GitClient.GenerateCommandLineCommands">
  1341. <summary>
  1342. Returns a string value containing the command line arguments to pass directly to the executable file.
  1343. </summary>
  1344. <returns>
  1345. A string value containing the command line arguments to pass directly to the executable file.
  1346. </returns>
  1347. </member>
  1348. <member name="M:MSBuild.Community.Tasks.Git.GitClient.GenerateCommand(Microsoft.Build.Utilities.CommandLineBuilder)">
  1349. <summary>
  1350. Generates the command.
  1351. </summary>
  1352. <param name="builder">The builder.</param>
  1353. </member>
  1354. <member name="M:MSBuild.Community.Tasks.Git.GitClient.GenerateArguments(Microsoft.Build.Utilities.CommandLineBuilder)">
  1355. <summary>
  1356. Generates the arguments.
  1357. </summary>
  1358. <param name="builder">The builder.</param>
  1359. </member>
  1360. <member name="M:MSBuild.Community.Tasks.Git.GitClient.GenerateFullPathToTool">
  1361. <summary>
  1362. Returns the fully qualified path to the executable file.
  1363. </summary>
  1364. <returns>
  1365. The fully qualified path to the executable file.
  1366. </returns>
  1367. </member>
  1368. <member name="M:MSBuild.Community.Tasks.Git.GitClient.LogToolCommand(System.String)">
  1369. <summary>
  1370. Logs the starting point of the run to all registered loggers.
  1371. </summary>
  1372. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  1373. </member>
  1374. <member name="M:MSBuild.Community.Tasks.Git.GitClient.ValidateParameters">
  1375. <summary>
  1376. Indicates whether all task paratmeters are valid.
  1377. </summary>
  1378. <returns>
  1379. true if all task parameters are valid; otherwise, false.
  1380. </returns>
  1381. </member>
  1382. <member name="M:MSBuild.Community.Tasks.Git.GitClient.GetWorkingDirectory">
  1383. <summary>
  1384. Returns the directory in which to run the executable file.
  1385. </summary>
  1386. <returns>
  1387. The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
  1388. </returns>
  1389. </member>
  1390. <member name="P:MSBuild.Community.Tasks.Git.GitClient.Command">
  1391. <summary>
  1392. Gets or sets the command to run.
  1393. </summary>
  1394. </member>
  1395. <member name="P:MSBuild.Community.Tasks.Git.GitClient.Arguments">
  1396. <summary>
  1397. Gets or sets the raw arguments to pass to the git command.
  1398. </summary>
  1399. </member>
  1400. <member name="P:MSBuild.Community.Tasks.Git.GitClient.LocalPath">
  1401. <summary>
  1402. Gets or sets the local or working path for git command.
  1403. </summary>
  1404. </member>
  1405. <member name="P:MSBuild.Community.Tasks.Git.GitClient.StandardOutputLoggingImportance">
  1406. <summary>
  1407. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  1408. </summary>
  1409. <value></value>
  1410. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  1411. </member>
  1412. <member name="P:MSBuild.Community.Tasks.Git.GitClient.ToolName">
  1413. <summary>
  1414. Gets the name of the executable file to run.
  1415. </summary>
  1416. <returns>
  1417. The name of the executable file to run.
  1418. </returns>
  1419. </member>
  1420. <member name="T:MSBuild.Community.Tasks.Git.GitVersion">
  1421. <summary>
  1422. A task for git to get the current commit hash.
  1423. </summary>
  1424. </member>
  1425. <member name="M:MSBuild.Community.Tasks.Git.GitVersion.#ctor">
  1426. <summary>
  1427. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Git.GitVersion"/> class.
  1428. </summary>
  1429. </member>
  1430. <member name="M:MSBuild.Community.Tasks.Git.GitVersion.GenerateArguments(Microsoft.Build.Utilities.CommandLineBuilder)">
  1431. <summary>
  1432. Generates the arguments.
  1433. </summary>
  1434. <param name="builder">The builder.</param>
  1435. </member>
  1436. <member name="M:MSBuild.Community.Tasks.Git.GitVersion.LogEventsFromTextOutput(System.String,Microsoft.Build.Framework.MessageImportance)">
  1437. <summary>
  1438. Parses a single line of text to identify any errors or warnings in canonical format.
  1439. </summary>
  1440. <param name="singleLine">A single line of text for the method to parse.</param>
  1441. <param name="messageImportance">A value of <see cref="T:Microsoft.Build.Framework.MessageImportance"/> that indicates the importance level with which to log the message.</param>
  1442. </member>
  1443. <member name="P:MSBuild.Community.Tasks.Git.GitVersion.Revision">
  1444. <summary>
  1445. Gets or sets the revision to get the version from. Default is HEAD.
  1446. </summary>
  1447. </member>
  1448. <member name="P:MSBuild.Community.Tasks.Git.GitVersion.CommitHash">
  1449. <summary>
  1450. Gets or sets the commit hash.
  1451. </summary>
  1452. </member>
  1453. <member name="P:MSBuild.Community.Tasks.Git.GitVersion.Short">
  1454. <summary>
  1455. Gets or sets a value indicating whether to abbreviate to a shorter unique name.
  1456. </summary>
  1457. <value>
  1458. <c>true</c> if short; otherwise, <c>false</c>.
  1459. </value>
  1460. </member>
  1461. <member name="T:MSBuild.Community.Tasks.HtmlHelp.ChmCompiler">
  1462. <summary>
  1463. Html Help 1x compiler task.
  1464. </summary>
  1465. </member>
  1466. <member name="M:MSBuild.Community.Tasks.HtmlHelp.ChmCompiler.GenerateFullPathToTool">
  1467. <summary>
  1468. Returns the fully qualified path to the executable file.
  1469. </summary>
  1470. <returns>
  1471. The fully qualified path to the executable file.
  1472. </returns>
  1473. </member>
  1474. <member name="M:MSBuild.Community.Tasks.HtmlHelp.ChmCompiler.LogToolCommand(System.String)">
  1475. <summary>
  1476. Logs the starting point of the run to all registered loggers.
  1477. </summary>
  1478. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  1479. </member>
  1480. <member name="M:MSBuild.Community.Tasks.HtmlHelp.ChmCompiler.GenerateCommandLineCommands">
  1481. <summary>
  1482. Returns a string value containing the command line arguments to pass directly to the executable file.
  1483. </summary>
  1484. <returns>
  1485. A string value containing the command line arguments to pass directly to the executable file.
  1486. </returns>
  1487. </member>
  1488. <member name="M:MSBuild.Community.Tasks.HtmlHelp.ChmCompiler.HandleTaskExecutionErrors">
  1489. <summary>
  1490. Handles execution errors raised by the executable file.
  1491. </summary>
  1492. <returns>
  1493. true if the method runs successfully; otherwise, false.
  1494. </returns>
  1495. </member>
  1496. <member name="P:MSBuild.Community.Tasks.HtmlHelp.ChmCompiler.ProjectFile">
  1497. <summary>
  1498. Gets or sets the project file path.
  1499. </summary>
  1500. <value>The project file path.</value>
  1501. </member>
  1502. <member name="P:MSBuild.Community.Tasks.HtmlHelp.ChmCompiler.ToolName">
  1503. <summary>
  1504. Gets the name of the executable file to run.
  1505. </summary>
  1506. <value></value>
  1507. <returns>The name of the executable file to run.</returns>
  1508. </member>
  1509. <member name="P:MSBuild.Community.Tasks.HtmlHelp.ChmCompiler.StandardOutputLoggingImportance">
  1510. <summary>
  1511. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  1512. </summary>
  1513. <value></value>
  1514. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  1515. </member>
  1516. <member name="T:MSBuild.Community.Tasks.HtmlHelp.HxCompiler">
  1517. <summary>
  1518. A Html Help 2.0 compiler task.
  1519. </summary>
  1520. </member>
  1521. <member name="M:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.GenerateFullPathToTool">
  1522. <summary>
  1523. Returns the fully qualified path to the executable file.
  1524. </summary>
  1525. <returns>
  1526. The fully qualified path to the executable file.
  1527. </returns>
  1528. </member>
  1529. <member name="M:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.LogToolCommand(System.String)">
  1530. <summary>
  1531. Logs the starting point of the run to all registered loggers.
  1532. </summary>
  1533. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  1534. </member>
  1535. <member name="M:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.GenerateCommandLineCommands">
  1536. <summary>
  1537. Returns a string value containing the command line arguments to pass directly to the executable file.
  1538. </summary>
  1539. <returns>
  1540. A string value containing the command line arguments to pass directly to the executable file.
  1541. </returns>
  1542. </member>
  1543. <member name="M:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.HandleTaskExecutionErrors">
  1544. <summary>
  1545. Handles execution errors raised by the executable file.
  1546. </summary>
  1547. <returns>
  1548. true if the method runs successfully; otherwise, false.
  1549. </returns>
  1550. </member>
  1551. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.ProjectFile">
  1552. <summary>
  1553. Gets or sets the project file path.
  1554. </summary>
  1555. <value>The project file path.</value>
  1556. </member>
  1557. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.LogFile">
  1558. <summary>
  1559. Gets or sets the log file.
  1560. </summary>
  1561. <value>The log file.</value>
  1562. </member>
  1563. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.ProjectRoot">
  1564. <summary>
  1565. Gets or sets the project root.
  1566. </summary>
  1567. <value>The project root.</value>
  1568. </member>
  1569. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.OutputFile">
  1570. <summary>
  1571. Gets or sets the output file.
  1572. </summary>
  1573. <value>The output file.</value>
  1574. </member>
  1575. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.NoInfoMessages">
  1576. <summary>
  1577. Gets or sets a value indicating whether no info messages will be output.
  1578. </summary>
  1579. <value><c>true</c> if no info messages; otherwise, <c>false</c>.</value>
  1580. </member>
  1581. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.NoWarningMessages">
  1582. <summary>
  1583. Gets or sets a value indicating whether no warning messages will be output.
  1584. </summary>
  1585. <value><c>true</c> if no warning messages; otherwise, <c>false</c>.</value>
  1586. </member>
  1587. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.NoErrorMessages">
  1588. <summary>
  1589. Gets or sets a value indicating whether no error messages will be output.
  1590. </summary>
  1591. <value><c>true</c> if no error messages; otherwise, <c>false</c>.</value>
  1592. </member>
  1593. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.QuiteMode">
  1594. <summary>
  1595. Gets or sets a value indicating quite mode.
  1596. </summary>
  1597. <value><c>true</c> if quite mode; otherwise, <c>false</c>.</value>
  1598. </member>
  1599. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.UncompileFile">
  1600. <summary>
  1601. Gets or sets the uncompile file.
  1602. </summary>
  1603. <value>The uncompile file.</value>
  1604. </member>
  1605. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.UncompileDirectory">
  1606. <summary>
  1607. Gets or sets the uncompile directory.
  1608. </summary>
  1609. <value>The uncompile directory.</value>
  1610. </member>
  1611. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.ToolName">
  1612. <summary>
  1613. Gets the name of the executable file to run.
  1614. </summary>
  1615. <value></value>
  1616. <returns>The name of the executable file to run.</returns>
  1617. </member>
  1618. <member name="P:MSBuild.Community.Tasks.HtmlHelp.HxCompiler.StandardOutputLoggingImportance">
  1619. <summary>
  1620. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  1621. </summary>
  1622. <value></value>
  1623. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  1624. </member>
  1625. <member name="T:MSBuild.Community.Tasks.InnoSetup">
  1626. <summary>
  1627. MSBuild task to create installer with InnoSetup
  1628. </summary>
  1629. <example>Create installer
  1630. <code><![CDATA[
  1631. <InnoSetup
  1632. ScriptFile="setup.iss"
  1633. OutputFileName="MySetup.exe"
  1634. OutputPath="C:\SetupDir"
  1635. Quiet="True" />
  1636. ]]></code>
  1637. </example>
  1638. </member>
  1639. <member name="M:MSBuild.Community.Tasks.InnoSetup.GenerateFullPathToTool">
  1640. <summary>
  1641. Returns the fully qualified path to the executable file.
  1642. </summary>
  1643. <returns>
  1644. The fully qualified path to the executable file.
  1645. </returns>
  1646. </member>
  1647. <member name="M:MSBuild.Community.Tasks.InnoSetup.LogToolCommand(System.String)">
  1648. <summary>
  1649. Logs the starting point of the run to all registered loggers.
  1650. </summary>
  1651. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  1652. </member>
  1653. <member name="M:MSBuild.Community.Tasks.InnoSetup.GenerateCommandLineCommands">
  1654. <summary>
  1655. Returns a string value containing the command line arguments to pass directly to the executable file.
  1656. </summary>
  1657. <returns>
  1658. A string value containing the command line arguments to pass directly to the executable file.
  1659. </returns>
  1660. </member>
  1661. <member name="M:MSBuild.Community.Tasks.InnoSetup.Execute">
  1662. <summary>
  1663. </summary>
  1664. <returns></returns>
  1665. </member>
  1666. <member name="P:MSBuild.Community.Tasks.InnoSetup.ScriptFile">
  1667. <summary>
  1668. Filename of Inno Setup script (.iss)
  1669. </summary>
  1670. <value>InnoSetup file, example: C:\Setup.iss</value>
  1671. </member>
  1672. <member name="P:MSBuild.Community.Tasks.InnoSetup.OutputFileName">
  1673. <summary>
  1674. Specify output filename
  1675. </summary>
  1676. <value>Name for setup, examples: MySetup.exe</value>
  1677. </member>
  1678. <member name="P:MSBuild.Community.Tasks.InnoSetup.OutputPath">
  1679. <summary>
  1680. Specify output path
  1681. </summary>
  1682. <value>Path for output setup, example: C:\Setups</value>
  1683. </member>
  1684. <member name="P:MSBuild.Community.Tasks.InnoSetup.Quiet">
  1685. <summary>
  1686. Quiet compile
  1687. </summary>
  1688. <value>True o False</value>
  1689. </member>
  1690. <member name="P:MSBuild.Community.Tasks.InnoSetup.ToolName">
  1691. <summary>
  1692. Gets the name of the executable file to run.
  1693. </summary>
  1694. <value></value>
  1695. <returns>The name of the executable file to run.</returns>
  1696. </member>
  1697. <member name="P:MSBuild.Community.Tasks.InnoSetup.StandardOutputLoggingImportance">
  1698. <summary>
  1699. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  1700. </summary>
  1701. <value></value>
  1702. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  1703. </member>
  1704. <member name="T:MSBuild.Community.Tasks.MergeModes">
  1705. <summary>
  1706. Defines the modes for merging files.
  1707. </summary>
  1708. </member>
  1709. <member name="F:MSBuild.Community.Tasks.MergeModes.Binary">
  1710. <summary>
  1711. Merges files as binary data.
  1712. </summary>
  1713. </member>
  1714. <member name="F:MSBuild.Community.Tasks.MergeModes.Text">
  1715. <summary>
  1716. Merges files as text.
  1717. </summary>
  1718. </member>
  1719. <member name="F:MSBuild.Community.Tasks.MergeModes.TextLine">
  1720. <summary>
  1721. Merges files as text line by line.
  1722. </summary>
  1723. </member>
  1724. <member name="T:MSBuild.Community.Tasks.Merge">
  1725. <summary>
  1726. Merge files into the destination file.
  1727. </summary>
  1728. <example>Merge CSS files together for better browser performance.
  1729. <code><![CDATA[
  1730. <Merge Mode="TextLine"
  1731. SourceFiles="Main.css;Login.css"
  1732. DestinationFile="All.css" />
  1733. ]]></code>
  1734. </example>
  1735. </member>
  1736. <member name="M:MSBuild.Community.Tasks.Merge.Execute">
  1737. <summary>
  1738. When overridden in a derived class, executes the task.
  1739. </summary>
  1740. <returns>
  1741. true if the task successfully executed; otherwise, false.
  1742. </returns>
  1743. </member>
  1744. <member name="P:MSBuild.Community.Tasks.Merge.Mode">
  1745. <summary>
  1746. Gets or sets the mode to use when merging.
  1747. </summary>
  1748. <value>The merge mode.</value>
  1749. <enum cref="T:MSBuild.Community.Tasks.MergeModes"/>
  1750. </member>
  1751. <member name="P:MSBuild.Community.Tasks.Merge.SourceFiles">
  1752. <summary>
  1753. Gets or sets the source files to merge.
  1754. </summary>
  1755. <value>The source files to merge.</value>
  1756. </member>
  1757. <member name="P:MSBuild.Community.Tasks.Merge.DestinationFile">
  1758. <summary>
  1759. Gets or sets the destination file where the
  1760. <see cref="P:MSBuild.Community.Tasks.Merge.SourceFiles"/> are merged to.
  1761. </summary>
  1762. <value>The destination file.</value>
  1763. </member>
  1764. <member name="T:MSBuild.Community.Tasks.Net.HttpRequest">
  1765. <summary>
  1766. Makes an HTTP request, optionally validating the result and writing it to a file.
  1767. </summary>
  1768. <remarks>
  1769. Execute a http request to hit the database update.
  1770. Target attributes to set:
  1771. Url (required),
  1772. FailOnNon2xxResponse (200 responses generally means successful http request. default=true),
  1773. EnsureResponseContains (string to check for),
  1774. WriteResponseTo (file name to write to),
  1775. </remarks>
  1776. <example>
  1777. Example of a update request ensuring "Database upgrade check completed successfully." was returned.
  1778. <code><![CDATA[
  1779. <HttpRequest Url="http://mydomain.com/index.php?checkdb=1"
  1780. EnsureResponseContains="Database upgrade check completed successfully."
  1781. FailOnNon2xxResponse="true" />
  1782. ]]></code>
  1783. </example>
  1784. </member>
  1785. <member name="M:MSBuild.Community.Tasks.Net.HttpRequest.#ctor">
  1786. <summary>
  1787. Constructor to set the default parameters for http request
  1788. </summary>
  1789. </member>
  1790. <member name="M:MSBuild.Community.Tasks.Net.HttpRequest.Execute">
  1791. <summary>
  1792. Entry Point inherited from Task
  1793. </summary>
  1794. </member>
  1795. <member name="P:MSBuild.Community.Tasks.Net.HttpRequest.Url">
  1796. <summary>
  1797. The URL to make an HTTP request against.
  1798. </summary>
  1799. </member>
  1800. <member name="P:MSBuild.Community.Tasks.Net.HttpRequest.EnsureResponseContains">
  1801. <summary>
  1802. Optional: if set then the task fails if the response text doesn't contain the text specified.
  1803. </summary>
  1804. </member>
  1805. <member name="P:MSBuild.Community.Tasks.Net.HttpRequest.FailOnNon2xxResponse">
  1806. <summary>
  1807. Default is true. When true, if the web server returns a status code less than 200 or greater than 299 then the task fails.
  1808. </summary>
  1809. </member>
  1810. <member name="P:MSBuild.Community.Tasks.Net.HttpRequest.WriteResponseTo">
  1811. <summary>
  1812. Optional; the name of the file to write the response to.
  1813. </summary>
  1814. </member>
  1815. <member name="T:MSBuild.Community.Tasks.NuGet.NuGetBase">
  1816. <summary>
  1817. A base class for NuGet tasks.
  1818. </summary>
  1819. </member>
  1820. <member name="M:MSBuild.Community.Tasks.NuGet.NuGetBase.GenerateFullPathToTool">
  1821. <summary>
  1822. Returns the fully qualified path to the executable file.
  1823. </summary>
  1824. <returns>
  1825. The fully qualified path to the executable file.
  1826. </returns>
  1827. </member>
  1828. <member name="M:MSBuild.Community.Tasks.NuGet.NuGetBase.GetWorkingDirectory">
  1829. <summary>
  1830. Returns the directory in which to run the executable file.
  1831. </summary>
  1832. <returns>
  1833. The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
  1834. </returns>
  1835. </member>
  1836. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetBase.WorkingDirectory">
  1837. <summary>
  1838. Gets or sets the working directory.
  1839. </summary>
  1840. <value>The working directory.</value>
  1841. <returns>
  1842. The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
  1843. </returns>
  1844. </member>
  1845. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetBase.ToolName">
  1846. <summary>
  1847. Gets the name of the executable file to run.
  1848. </summary>
  1849. <value></value>
  1850. <returns>The name of the executable file to run.</returns>
  1851. </member>
  1852. <member name="T:MSBuild.Community.Tasks.NuGet.NuGetPack">
  1853. <summary>
  1854. Creates a NuGet package based on the specified nuspec or project file.
  1855. </summary>
  1856. </member>
  1857. <member name="M:MSBuild.Community.Tasks.NuGet.NuGetPack.GenerateCommandLineCommands">
  1858. <summary>
  1859. Returns a string value containing the command line arguments to pass directly to the executable file.
  1860. </summary>
  1861. <returns>
  1862. A string value containing the command line arguments to pass directly to the executable file.
  1863. </returns>
  1864. </member>
  1865. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPack.File">
  1866. <summary>
  1867. The location of the nuspec or project file to create a package.
  1868. </summary>
  1869. </member>
  1870. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPack.OutputDirectory">
  1871. <summary>
  1872. Specifies the directory for the created NuGet package.
  1873. </summary>
  1874. </member>
  1875. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPack.Version">
  1876. <summary>
  1877. Overrides the version number from the nuspec file.
  1878. </summary>
  1879. </member>
  1880. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPack.BasePath">
  1881. <summary>
  1882. The base path of the files defined in the nuspec file.
  1883. </summary>
  1884. </member>
  1885. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPack.Verbose">
  1886. <summary>
  1887. Shows verbose output for package building.
  1888. </summary>
  1889. <value><c>true</c> if verbose; otherwise, <c>false</c>.</value>
  1890. </member>
  1891. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPack.Symbols">
  1892. <summary>
  1893. Determines if a package containing sources and symbols should be created. When specified with a nuspec,
  1894. creates a regular NuGet package file and the corresponding symbols package.
  1895. </summary>
  1896. <value>
  1897. <c>true</c> if symbols; otherwise, <c>false</c>.
  1898. </value>
  1899. </member>
  1900. <member name="T:MSBuild.Community.Tasks.NuGet.NuGetPush">
  1901. <summary>
  1902. Pushes a package to the server and optionally publishes it.
  1903. </summary>
  1904. </member>
  1905. <member name="M:MSBuild.Community.Tasks.NuGet.NuGetPush.GenerateCommandLineCommands">
  1906. <summary>
  1907. Returns a string value containing the command line arguments to pass directly to the executable file.
  1908. </summary>
  1909. <returns>
  1910. A string value containing the command line arguments to pass directly to the executable file.
  1911. </returns>
  1912. </member>
  1913. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPush.File">
  1914. <summary>
  1915. The path to the package to push the package to the server.
  1916. </summary>
  1917. </member>
  1918. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPush.APIKey">
  1919. <summary>
  1920. The API key to use for push to the server.
  1921. </summary>
  1922. </member>
  1923. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPush.Source">
  1924. <summary>
  1925. Specifies the server URL.
  1926. </summary>
  1927. </member>
  1928. <member name="P:MSBuild.Community.Tasks.NuGet.NuGetPush.CreateOnly">
  1929. <summary>
  1930. Specifies if the package should be created and uploaded to the server but not published to the server. False by default.
  1931. </summary>
  1932. <value>
  1933. <c>true</c> if create only; otherwise, <c>false</c>.
  1934. </value>
  1935. </member>
  1936. <member name="M:MSBuild.Community.Tasks.PathUtil.RelativePathTo(System.String,System.String)">
  1937. <summary>
  1938. Creates a relative path from one file
  1939. or folder to another.
  1940. </summary>
  1941. <param name="fromDirectory">
  1942. Contains the directory that defines the
  1943. start of the relative path.
  1944. </param>
  1945. <param name="toPath">
  1946. Contains the path that defines the
  1947. endpoint of the relative path.
  1948. </param>
  1949. <returns>
  1950. The relative path from the start
  1951. directory to the end path.
  1952. </returns>
  1953. <exception cref="T:System.ArgumentNullException">
  1954. Thrown if <paramref name="fromDirectory"/> or <paramref name="toPath"/> are null.
  1955. </exception>
  1956. </member>
  1957. <member name="T:MSBuild.Community.Tasks.RegexCompiler">
  1958. <summary>
  1959. Compiles regular expressions and saves them to disk in an assembly.
  1960. </summary>
  1961. <remarks>
  1962. <para>
  1963. When defining the regular expressions in an MSBuild project file, the ItemGroup
  1964. item must have a metadata tag called 'Pattern' that is the actually regular expression.
  1965. Other optional metadata tags are the following.
  1966. <list type="table">
  1967. <listheader>
  1968. <term>Metadata Tags</term>
  1969. <description>Description</description>
  1970. </listheader>
  1971. <item>
  1972. <term>Pattern</term>
  1973. <description>The actually regular expression pattern to be compiled. (Required)</description>
  1974. </item>
  1975. <item>
  1976. <term>Options</term>
  1977. <description>The RegexOptions for the expression.</description>
  1978. </item>
  1979. <item>
  1980. <term>Namespace</term>
  1981. <description>The class namespace for the compile class.</description>
  1982. </item>
  1983. <item>
  1984. <term>IsPublic</term>
  1985. <description>A flag if the generated expression should be public.</description>
  1986. </item>
  1987. </list>
  1988. </para>
  1989. </remarks><example>
  1990. Creates an assembly with the compiled regular expressions.
  1991. <code>
  1992. <![CDATA[
  1993. <ItemGroup>
  1994. <RegexPatterns Include="TextRegex">
  1995. <Pattern>\G[^&lt;]+</Pattern>
  1996. <Options>RegexOptions.Singleline | RegexOptions.Multiline</Options>
  1997. </RegexPatterns>
  1998. <RegexPatterns Include="CommentRegex">
  1999. <Pattern>\G&lt;%--(([^-]*)-)*?-%&gt;</Pattern>
  2000. <Options>RegexOptions.Singleline | RegexOptions.Multiline</Options>
  2001. </RegexPatterns>
  2002. <RegexPatterns Include="CodeRegex">
  2003. <Pattern>\G&lt;%(?![@%])(?&lt;code&gt;.*?)%&gt;</Pattern>
  2004. <Options>RegexOptions.Singleline | RegexOptions.Multiline</Options>
  2005. <Namespace>MSBuild.Community.RegularExpressions</Namespace>
  2006. </RegexPatterns>
  2007. </ItemGroup>
  2008. <Target Name="RegexCompiler">
  2009. <RegexCompiler
  2010. OutputDirectory="Test"
  2011. RegularExpressions="@(RegexPatterns)"
  2012. Namespace="MSBuild.RegularExpressions"
  2013. AssemblyName="MSBuild.RegularExpressions.dll"
  2014. AssemblyTitle="MSBuild.RegularExpressions"
  2015. AssemblyDescription="MSBuild Community Tasks Regular Expressions"
  2016. AssemblyCompany="Company Name, LLC"
  2017. AssemblyProduct="MSBuildTasks"
  2018. AssemblyCopyright="Copyright (c) MSBuildTasks 2008"
  2019. AssemblyVersion="1.0.0.0"
  2020. AssemblyFileVersion="1.0.0.0" />
  2021. </Target>
  2022. ]]>
  2023. </code>
  2024. </example>
  2025. </member>
  2026. <member name="M:MSBuild.Community.Tasks.RegexCompiler.#ctor">
  2027. <summary>
  2028. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.RegexCompiler"/> class.
  2029. </summary>
  2030. </member>
  2031. <member name="M:MSBuild.Community.Tasks.RegexCompiler.Execute">
  2032. <summary>
  2033. When overridden in a derived class, executes the task.
  2034. </summary>
  2035. <returns>
  2036. true if the task successfully executed; otherwise, false.
  2037. </returns>
  2038. </member>
  2039. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyName">
  2040. <summary>
  2041. Gets or sets the name of the assembly to be created by the regex compiler.
  2042. </summary>
  2043. <value>The name of the assembly.</value>
  2044. </member>
  2045. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyTitle">
  2046. <summary>
  2047. Gets or sets the assembly title.
  2048. </summary>
  2049. <value>The assembly title.</value>
  2050. </member>
  2051. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyDescription">
  2052. <summary>
  2053. Gets or sets the assembly description.
  2054. </summary>
  2055. <value>The assembly description.</value>
  2056. </member>
  2057. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyCompany">
  2058. <summary>
  2059. Gets or sets the assembly company.
  2060. </summary>
  2061. <value>The assembly company.</value>
  2062. </member>
  2063. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyProduct">
  2064. <summary>
  2065. Gets or sets the assembly product.
  2066. </summary>
  2067. <value>The assembly product.</value>
  2068. </member>
  2069. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyCopyright">
  2070. <summary>
  2071. Gets or sets the assembly copyright.
  2072. </summary>
  2073. <value>The assembly copyright.</value>
  2074. </member>
  2075. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyCulture">
  2076. <summary>
  2077. Gets or sets the assembly culture.
  2078. </summary>
  2079. <value>The assembly culture.</value>
  2080. </member>
  2081. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyVersion">
  2082. <summary>
  2083. Gets or sets the assembly version.
  2084. </summary>
  2085. <value>The assembly version.</value>
  2086. </member>
  2087. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyFileVersion">
  2088. <summary>
  2089. Gets or sets the assembly file version.
  2090. </summary>
  2091. <value>The assembly file version.</value>
  2092. </member>
  2093. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyInformationalVersion">
  2094. <summary>
  2095. Gets or sets the assembly informational version.
  2096. </summary>
  2097. <value>The assembly informational version.</value>
  2098. </member>
  2099. <member name="P:MSBuild.Community.Tasks.RegexCompiler.AssemblyKeyFile">
  2100. <summary>
  2101. Gets or sets the assembly key file.
  2102. </summary>
  2103. <value>The assembly key file.</value>
  2104. </member>
  2105. <member name="P:MSBuild.Community.Tasks.RegexCompiler.OutputDirectory">
  2106. <summary>
  2107. Gets or sets the directory where the assembly will be saved.
  2108. </summary>
  2109. <value>The output directory.</value>
  2110. </member>
  2111. <member name="P:MSBuild.Community.Tasks.RegexCompiler.OutputFile">
  2112. <summary>
  2113. Gets or sets the output file.
  2114. </summary>
  2115. <value>The output file.</value>
  2116. </member>
  2117. <member name="P:MSBuild.Community.Tasks.RegexCompiler.RegularExpressions">
  2118. <summary>
  2119. Gets or sets the regular expressions.
  2120. </summary>
  2121. <value>The regular expressions.</value>
  2122. </member>
  2123. <member name="P:MSBuild.Community.Tasks.RegexCompiler.RegularExpressionsFile">
  2124. <summary>
  2125. Gets or sets the file defining the regular expressions.
  2126. </summary>
  2127. <value>The regular expressions file.</value>
  2128. </member>
  2129. <member name="P:MSBuild.Community.Tasks.RegexCompiler.IsPublic">
  2130. <summary>
  2131. Gets or sets a value indicating whether the default value is public for regular expression instances.
  2132. </summary>
  2133. <value><c>true</c> if regular expression instance is public; otherwise, <c>false</c>.</value>
  2134. </member>
  2135. <member name="P:MSBuild.Community.Tasks.RegexCompiler.Namespace">
  2136. <summary>
  2137. Gets or sets the default namespace for regular expression instances.
  2138. </summary>
  2139. <value>The namespace for regular expression instances.</value>
  2140. </member>
  2141. <member name="P:MSBuild.Community.Tasks.RegexCompiler.Options">
  2142. <summary>
  2143. Gets or sets the default regular expression options.
  2144. </summary>
  2145. <value>The default regular expression options.</value>
  2146. </member>
  2147. <member name="T:MSBuild.Community.Tasks.Sandcastle.BuildAssembler">
  2148. <summary>
  2149. BuildAssembler task for Sandcastle.
  2150. </summary>
  2151. </member>
  2152. <member name="T:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase">
  2153. <summary>
  2154. A base class for Sandcastle Tools,
  2155. </summary>
  2156. </member>
  2157. <member name="M:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.#ctor">
  2158. <summary>
  2159. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase"/> class.
  2160. </summary>
  2161. </member>
  2162. <member name="M:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.GenerateFullPathToTool">
  2163. <summary>
  2164. Returns the fully qualified path to the executable file.
  2165. </summary>
  2166. <returns>
  2167. The fully qualified path to the executable file.
  2168. </returns>
  2169. </member>
  2170. <member name="M:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.LogToolCommand(System.String)">
  2171. <summary>
  2172. Logs the starting point of the run to all registered loggers.
  2173. </summary>
  2174. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  2175. </member>
  2176. <member name="M:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.LogEventsFromTextOutput(System.String,Microsoft.Build.Framework.MessageImportance)">
  2177. <summary>
  2178. Logs the events from text output.
  2179. </summary>
  2180. <param name="singleLine">The single line.</param>
  2181. <param name="messageImportance">The message importance.</param>
  2182. </member>
  2183. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.SandcastleEnviroment">
  2184. <summary>
  2185. Gets or sets the sandcastle enviroment.
  2186. </summary>
  2187. <value>The sandcastle enviroment.</value>
  2188. </member>
  2189. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.EnviromentVariables">
  2190. <summary>
  2191. Gets or sets the enviroment variables.
  2192. </summary>
  2193. <value>The enviroment variables.</value>
  2194. </member>
  2195. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.SandcastleRoot">
  2196. <summary>
  2197. Gets or sets the sandcastle install root directory.
  2198. </summary>
  2199. <value>The sandcastle root directory.</value>
  2200. </member>
  2201. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.NoInfoMessages">
  2202. <summary>
  2203. Gets or sets a value indicating whether no info messages will be output.
  2204. </summary>
  2205. <value><c>true</c> if no info messages; otherwise, <c>false</c>.</value>
  2206. </member>
  2207. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.NoWarnMessages">
  2208. <summary>
  2209. Gets or sets a value indicating whether no warning messages will be output.
  2210. </summary>
  2211. <value><c>true</c> if no warning messages; otherwise, <c>false</c>.</value>
  2212. </member>
  2213. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.StandardOutputLoggingImportance">
  2214. <summary>
  2215. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  2216. </summary>
  2217. <value></value>
  2218. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  2219. </member>
  2220. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleToolBase.EnvironmentOverride">
  2221. <summary>
  2222. Gets the override value of the PATH environment variable.
  2223. </summary>
  2224. <value></value>
  2225. <returns>The override value of the PATH environment variable.</returns>
  2226. </member>
  2227. <member name="M:MSBuild.Community.Tasks.Sandcastle.BuildAssembler.GenerateCommandLineCommands">
  2228. <summary>
  2229. Returns a string value containing the command line arguments to pass directly to the executable file.
  2230. </summary>
  2231. <returns>
  2232. A string value containing the command line arguments to pass directly to the executable file.
  2233. </returns>
  2234. </member>
  2235. <member name="P:MSBuild.Community.Tasks.Sandcastle.BuildAssembler.ConfigFile">
  2236. <summary>
  2237. Gets or sets the configuration file.
  2238. </summary>
  2239. <value>The configuration file.</value>
  2240. </member>
  2241. <member name="P:MSBuild.Community.Tasks.Sandcastle.BuildAssembler.ManifestFile">
  2242. <summary>
  2243. Gets or sets the manifest file.
  2244. </summary>
  2245. <value>The manifest file.</value>
  2246. </member>
  2247. <member name="P:MSBuild.Community.Tasks.Sandcastle.BuildAssembler.ToolName">
  2248. <summary>
  2249. Gets the name of the executable file to run.
  2250. </summary>
  2251. <value></value>
  2252. <returns>The name of the executable file to run.</returns>
  2253. </member>
  2254. <member name="T:MSBuild.Community.Tasks.Sandcastle.ChmBuilder">
  2255. <summary>
  2256. ChmBuilder task for Sandcastle.
  2257. </summary>
  2258. </member>
  2259. <member name="M:MSBuild.Community.Tasks.Sandcastle.ChmBuilder.GenerateCommandLineCommands">
  2260. <summary>
  2261. Returns a string value containing the command line arguments to pass directly to the executable file.
  2262. </summary>
  2263. <returns>
  2264. A string value containing the command line arguments to pass directly to the executable file.
  2265. </returns>
  2266. </member>
  2267. <member name="P:MSBuild.Community.Tasks.Sandcastle.ChmBuilder.HtmlDirectory">
  2268. <summary>
  2269. Gets or sets the HTML directory.
  2270. </summary>
  2271. <value>The HTML directory.</value>
  2272. </member>
  2273. <member name="P:MSBuild.Community.Tasks.Sandcastle.ChmBuilder.ProjectName">
  2274. <summary>
  2275. Gets or sets the name of the project.
  2276. </summary>
  2277. <value>The name of the project.</value>
  2278. </member>
  2279. <member name="P:MSBuild.Community.Tasks.Sandcastle.ChmBuilder.TocFile">
  2280. <summary>
  2281. Gets or sets the toc file.
  2282. </summary>
  2283. <value>The toc file.</value>
  2284. </member>
  2285. <member name="P:MSBuild.Community.Tasks.Sandcastle.ChmBuilder.OutputDirectory">
  2286. <summary>
  2287. Gets or sets the output file.
  2288. </summary>
  2289. <value>The output file.</value>
  2290. </member>
  2291. <member name="P:MSBuild.Community.Tasks.Sandcastle.ChmBuilder.Metadata">
  2292. <summary>
  2293. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Sandcastle.ChmBuilder"/> is metadata.
  2294. </summary>
  2295. <value><c>true</c> if metadata; otherwise, <c>false</c>.</value>
  2296. </member>
  2297. <member name="P:MSBuild.Community.Tasks.Sandcastle.ChmBuilder.LanguageId">
  2298. <summary>
  2299. Gets or sets the language id.
  2300. </summary>
  2301. <value>The language id.</value>
  2302. </member>
  2303. <member name="P:MSBuild.Community.Tasks.Sandcastle.ChmBuilder.ToolName">
  2304. <summary>
  2305. Gets the name of the executable file to run.
  2306. </summary>
  2307. <value></value>
  2308. <returns>The name of the executable file to run.</returns>
  2309. </member>
  2310. <member name="T:MSBuild.Community.Tasks.Sandcastle.DBCSFix">
  2311. <summary>
  2312. DBCSFix task for Sandcastle.
  2313. </summary>
  2314. </member>
  2315. <member name="M:MSBuild.Community.Tasks.Sandcastle.DBCSFix.GenerateCommandLineCommands">
  2316. <summary>
  2317. Returns a string value containing the command line arguments to pass directly to the executable file.
  2318. </summary>
  2319. <returns>
  2320. A string value containing the command line arguments to pass directly to the executable file.
  2321. </returns>
  2322. </member>
  2323. <member name="P:MSBuild.Community.Tasks.Sandcastle.DBCSFix.ChmDirectory">
  2324. <summary>
  2325. Gets or sets the CHM directory.
  2326. </summary>
  2327. <value>The CHM directory.</value>
  2328. </member>
  2329. <member name="P:MSBuild.Community.Tasks.Sandcastle.DBCSFix.LanguageId">
  2330. <summary>
  2331. Gets or sets the language id.
  2332. </summary>
  2333. <value>The language id.</value>
  2334. </member>
  2335. <member name="P:MSBuild.Community.Tasks.Sandcastle.DBCSFix.ToolName">
  2336. <summary>
  2337. Gets the name of the executable file to run.
  2338. </summary>
  2339. <value></value>
  2340. <returns>The name of the executable file to run.</returns>
  2341. </member>
  2342. <member name="T:MSBuild.Community.Tasks.Sandcastle.MRefBuilder">
  2343. <summary>
  2344. MRefBuilder task for Sandcastle.
  2345. </summary>
  2346. </member>
  2347. <member name="M:MSBuild.Community.Tasks.Sandcastle.MRefBuilder.GenerateCommandLineCommands">
  2348. <summary>
  2349. Returns a string value containing the command line arguments to pass directly to the executable file.
  2350. </summary>
  2351. <returns>
  2352. A string value containing the command line arguments to pass directly to the executable file.
  2353. </returns>
  2354. </member>
  2355. <member name="P:MSBuild.Community.Tasks.Sandcastle.MRefBuilder.OutputFile">
  2356. <summary>
  2357. Gets or sets the output file.
  2358. </summary>
  2359. <value>The output file.</value>
  2360. </member>
  2361. <member name="P:MSBuild.Community.Tasks.Sandcastle.MRefBuilder.ConfigFile">
  2362. <summary>
  2363. Gets or sets the config file.
  2364. </summary>
  2365. <value>The config file.</value>
  2366. </member>
  2367. <member name="P:MSBuild.Community.Tasks.Sandcastle.MRefBuilder.References">
  2368. <summary>
  2369. Gets or sets the references.
  2370. </summary>
  2371. <value>The references.</value>
  2372. </member>
  2373. <member name="P:MSBuild.Community.Tasks.Sandcastle.MRefBuilder.Assemblies">
  2374. <summary>
  2375. Gets or sets the assemblies.
  2376. </summary>
  2377. <value>The assemblies.</value>
  2378. </member>
  2379. <member name="P:MSBuild.Community.Tasks.Sandcastle.MRefBuilder.IncludeInternal">
  2380. <summary>
  2381. Gets or sets a value indicating whether to include internal members.
  2382. </summary>
  2383. <value><c>true</c> to include internal; otherwise, <c>false</c>.</value>
  2384. </member>
  2385. <member name="P:MSBuild.Community.Tasks.Sandcastle.MRefBuilder.ToolName">
  2386. <summary>
  2387. Gets the name of the executable file to run.
  2388. </summary>
  2389. <value></value>
  2390. <returns>The name of the executable file to run.</returns>
  2391. </member>
  2392. <member name="T:MSBuild.Community.Tasks.Sandcastle.Sandcastle">
  2393. <summary>
  2394. The Sandcastle task.
  2395. </summary>
  2396. <example>Create the Html Help for MSBuild Community Task project.
  2397. <code><![CDATA[
  2398. <Sandcastle TopicStyle="vs2005"
  2399. WorkingDirectory="$(MSBuildProjectDirectory)\Help"
  2400. Assemblies="@(Assemblies)"
  2401. Comments="@(Comments)"
  2402. References="@(References)"
  2403. ChmName="MSBuildTasks"
  2404. HxName="MSBuildTasks" />
  2405. ]]></code>
  2406. </example>
  2407. </member>
  2408. <member name="M:MSBuild.Community.Tasks.Sandcastle.Sandcastle.#ctor">
  2409. <summary>
  2410. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Sandcastle.Sandcastle"/> class.
  2411. </summary>
  2412. </member>
  2413. <member name="M:MSBuild.Community.Tasks.Sandcastle.Sandcastle.Execute">
  2414. <summary>
  2415. When overridden in a derived class, executes the task.
  2416. </summary>
  2417. <returns>
  2418. true if the task successfully executed; otherwise, false.
  2419. </returns>
  2420. </member>
  2421. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.SandcastleRoot">
  2422. <summary>
  2423. Gets or sets the sandcastle install root directory.
  2424. </summary>
  2425. <value>The sandcastle root directory.</value>
  2426. </member>
  2427. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.WorkingDirectory">
  2428. <summary>
  2429. Gets or sets the working directory.
  2430. </summary>
  2431. <value>The working directory.</value>
  2432. </member>
  2433. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.TopicStyle">
  2434. <summary>
  2435. Gets or sets the html help topic style.
  2436. </summary>
  2437. <value>The html help topic style.</value>
  2438. <remarks>
  2439. The styles supported are hana, prototype and vs2005.
  2440. The default style is vs2005.
  2441. </remarks>
  2442. </member>
  2443. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.Clean">
  2444. <summary>
  2445. Gets or sets a value indicating whether working directory is cleaned.
  2446. </summary>
  2447. <value><c>true</c> if clean; otherwise, <c>false</c>.</value>
  2448. </member>
  2449. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.References">
  2450. <summary>
  2451. Gets or sets the references.
  2452. </summary>
  2453. <value>The references.</value>
  2454. </member>
  2455. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.Assemblies">
  2456. <summary>
  2457. Gets or sets the assemblies.
  2458. </summary>
  2459. <value>The assemblies.</value>
  2460. </member>
  2461. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.Comments">
  2462. <summary>
  2463. Gets or sets the comments.
  2464. </summary>
  2465. <value>The comments.</value>
  2466. </member>
  2467. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.SandcastleConfig">
  2468. <summary>
  2469. Gets or sets the build assembler config file.
  2470. </summary>
  2471. <value>The build assembler config.</value>
  2472. </member>
  2473. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.ChmName">
  2474. <summary>
  2475. Gets or sets the name of the CHM.
  2476. </summary>
  2477. <value>The name of the CHM.</value>
  2478. </member>
  2479. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.LanguageId">
  2480. <summary>
  2481. Gets or sets the language id.
  2482. </summary>
  2483. <value>The language id.</value>
  2484. </member>
  2485. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.HxName">
  2486. <summary>
  2487. Gets or sets a value indicating a Html Help 2x project will be created.
  2488. </summary>
  2489. <value>The name of the Html Help 2x project.</value>
  2490. </member>
  2491. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.NoInfoMessages">
  2492. <summary>
  2493. Gets or sets a value indicating whether no info messages will be output.
  2494. </summary>
  2495. <value><c>true</c> if no info messages; otherwise, <c>false</c>.</value>
  2496. </member>
  2497. <member name="P:MSBuild.Community.Tasks.Sandcastle.Sandcastle.NoWarnMessages">
  2498. <summary>
  2499. Gets or sets a value indicating whether no warning messages will be output.
  2500. </summary>
  2501. <value><c>true</c> if no warning messages; otherwise, <c>false</c>.</value>
  2502. </member>
  2503. <member name="T:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment">
  2504. <summary>
  2505. A class representing the sandcastle enviroment.
  2506. </summary>
  2507. </member>
  2508. <member name="M:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment.#ctor">
  2509. <summary>
  2510. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment"/> class.
  2511. </summary>
  2512. </member>
  2513. <member name="M:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment.#ctor(System.String)">
  2514. <summary>
  2515. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment"/> class.
  2516. </summary>
  2517. <param name="sandcastleRoot">The sandcastle root.</param>
  2518. </member>
  2519. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment.SandcastleRoot">
  2520. <summary>
  2521. Gets or sets the sandcastle root.
  2522. </summary>
  2523. <value>The sandcastle root.</value>
  2524. </member>
  2525. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment.ToolsDirectory">
  2526. <summary>
  2527. Gets or sets the tools directory.
  2528. </summary>
  2529. <value>The tools directory.</value>
  2530. </member>
  2531. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment.TransformsDirectory">
  2532. <summary>
  2533. Gets or sets the transforms directory.
  2534. </summary>
  2535. <value>The transforms directory.</value>
  2536. </member>
  2537. <member name="P:MSBuild.Community.Tasks.Sandcastle.SandcastleEnviroment.PresentationDirectory">
  2538. <summary>
  2539. Gets or sets the presentation directory.
  2540. </summary>
  2541. <value>The presentation directory.</value>
  2542. </member>
  2543. <member name="T:MSBuild.Community.Tasks.Sandcastle.XslTransform">
  2544. <summary>
  2545. XslTransform task for Sandcastle.
  2546. </summary>
  2547. </member>
  2548. <member name="M:MSBuild.Community.Tasks.Sandcastle.XslTransform.GenerateCommandLineCommands">
  2549. <summary>
  2550. Returns a string value containing the command line arguments to pass directly to the executable file.
  2551. </summary>
  2552. <returns>
  2553. A string value containing the command line arguments to pass directly to the executable file.
  2554. </returns>
  2555. </member>
  2556. <member name="P:MSBuild.Community.Tasks.Sandcastle.XslTransform.OutputFile">
  2557. <summary>
  2558. Gets or sets the output file.
  2559. </summary>
  2560. <value>The output file.</value>
  2561. </member>
  2562. <member name="P:MSBuild.Community.Tasks.Sandcastle.XslTransform.XsltFiles">
  2563. <summary>
  2564. Gets or sets the XSLT files.
  2565. </summary>
  2566. <value>The XSLT files.</value>
  2567. </member>
  2568. <member name="P:MSBuild.Community.Tasks.Sandcastle.XslTransform.XmlFile">
  2569. <summary>
  2570. Gets or sets the XML files.
  2571. </summary>
  2572. <value>The XML files.</value>
  2573. </member>
  2574. <member name="P:MSBuild.Community.Tasks.Sandcastle.XslTransform.Arguments">
  2575. <summary>
  2576. Gets or sets the arguments.
  2577. </summary>
  2578. <value>The arguments.</value>
  2579. </member>
  2580. <member name="P:MSBuild.Community.Tasks.Sandcastle.XslTransform.ToolName">
  2581. <summary>
  2582. Gets the name of the executable file to run.
  2583. </summary>
  2584. <value></value>
  2585. <returns>The name of the executable file to run.</returns>
  2586. </member>
  2587. <member name="T:MSBuild.Community.Tasks.Services.IFilesSystem">
  2588. <summary>
  2589. The contract for a service that will provide access to the file system.
  2590. </summary>
  2591. <exclude />
  2592. </member>
  2593. <member name="M:MSBuild.Community.Tasks.Services.IFilesSystem.FileExists(System.String)">
  2594. <summary>
  2595. Determines whether the specified file exists.
  2596. </summary>
  2597. <param name="path">The path of the file to check.</param>
  2598. <returns><c>True</c> if the file exists on the filesystem.</returns>
  2599. </member>
  2600. <member name="M:MSBuild.Community.Tasks.Services.IFilesSystem.ReadTextFromFile(System.String)">
  2601. <summary>
  2602. Returns the contents of a file.
  2603. </summary>
  2604. <param name="fileName">The path of the file to read.</param>
  2605. <returns>The text with the specified file.</returns>
  2606. </member>
  2607. <member name="M:MSBuild.Community.Tasks.Services.IFilesSystem.WriteTextToFile(System.String,System.String)">
  2608. <summary>
  2609. Writes text to a file.
  2610. </summary>
  2611. <param name="fileName">The path of the file to write.</param>
  2612. <param name="contents">The text to write to the file.</param>
  2613. </member>
  2614. <member name="T:MSBuild.Community.Tasks.Services.FileSystem">
  2615. <summary>
  2616. Provides access to the file system.
  2617. </summary>
  2618. <exclude />
  2619. </member>
  2620. <member name="M:MSBuild.Community.Tasks.Services.FileSystem.FileExists(System.String)">
  2621. <summary>
  2622. Determines whether the specified file exists.
  2623. </summary>
  2624. <param name="path">The path of the file to check.</param>
  2625. <returns><c>True</c> if the file exists on the filesystem.</returns>
  2626. </member>
  2627. <member name="M:MSBuild.Community.Tasks.Services.FileSystem.ReadTextFromFile(System.String)">
  2628. <summary>
  2629. Returns the contents of a file.
  2630. </summary>
  2631. <param name="fileName">The path of the file to read.</param>
  2632. <returns>The text with the specified file.</returns>
  2633. </member>
  2634. <member name="M:MSBuild.Community.Tasks.Services.FileSystem.WriteTextToFile(System.String,System.String)">
  2635. <summary>
  2636. Writes text to a file.
  2637. </summary>
  2638. <param name="fileName">The path of the file to write.</param>
  2639. <param name="contents">The text to write to the file.</param>
  2640. </member>
  2641. <member name="T:MSBuild.Community.Tasks.GacUtilCommands">
  2642. <summary>
  2643. The list of the commands available to the GacUtil Task
  2644. </summary>
  2645. </member>
  2646. <member name="F:MSBuild.Community.Tasks.GacUtilCommands.Install">
  2647. <summary>Install the list of assemblies into the GAC.</summary>
  2648. </member>
  2649. <member name="F:MSBuild.Community.Tasks.GacUtilCommands.Uninstall">
  2650. <summary>Uninstall the list of assembly names from the GAC.</summary>
  2651. </member>
  2652. <member name="T:MSBuild.Community.Tasks.GacUtil">
  2653. <summary>
  2654. MSBuild task to install and uninstall assemblies into the GAC
  2655. </summary>
  2656. <example>Install a dll into the GAC.
  2657. <code><![CDATA[
  2658. <GacUtil
  2659. Command="Install"
  2660. Assemblies="MSBuild.Community.Tasks.dll"
  2661. Force="true" />
  2662. ]]></code>
  2663. </example>
  2664. <example>Uninstall a dll from the GAC.
  2665. <code><![CDATA[
  2666. <GacUtil
  2667. Command="Uninstall"
  2668. Assemblies="MSBuild.Community.Tasks"
  2669. Force="true" />
  2670. ]]></code>
  2671. </example>
  2672. </member>
  2673. <member name="M:MSBuild.Community.Tasks.GacUtil.Execute">
  2674. <summary>
  2675. Runs the executable file with the specified task parameters.
  2676. </summary>
  2677. <returns>
  2678. true if the task runs successfully; otherwise, false.
  2679. </returns>
  2680. </member>
  2681. <member name="P:MSBuild.Community.Tasks.GacUtil.Command">
  2682. <summary>
  2683. Gets or sets the command.
  2684. </summary>
  2685. <value>The command.</value>
  2686. <enum cref="T:MSBuild.Community.Tasks.GacUtilCommands"/>
  2687. </member>
  2688. <member name="P:MSBuild.Community.Tasks.GacUtil.RelatedFileExtensions">
  2689. <summary>
  2690. Gets or sets the related file extensions to copy when <see cref="P:MSBuild.Community.Tasks.GacUtil.IncludeRelatedFiles"/> is true.
  2691. </summary>
  2692. <value>The related file extensions.</value>
  2693. <remarks>
  2694. The default extensions are .pdb and .xml.
  2695. </remarks>
  2696. </member>
  2697. <member name="P:MSBuild.Community.Tasks.GacUtil.IncludeRelatedFiles">
  2698. <summary>
  2699. Gets or sets a value indicating whether related files are included when installing in GAC.
  2700. </summary>
  2701. <value><c>true</c> if related files are included when installing in GAC; otherwise, <c>false</c>.</value>
  2702. <remarks>
  2703. Setting IncludeRelatedFiles to true will copy the pdb and xml files from the same folder as the
  2704. assembly to the location in the GAC that the assembly was installed to. This is useful in some
  2705. debugging scenarios were you need to debug assemblies that are GAC'd.
  2706. </remarks>
  2707. </member>
  2708. <member name="P:MSBuild.Community.Tasks.GacUtil.Quiet">
  2709. <summary>
  2710. Gets or sets a value indicating whether warning messages are output.
  2711. </summary>
  2712. <value><c>true</c> to not log warning messages; otherwise, <c>false</c>.</value>
  2713. </member>
  2714. <member name="P:MSBuild.Community.Tasks.GacUtil.Force">
  2715. <summary>
  2716. Gets or sets a value indicating whether to force reinstall of an assembly.
  2717. </summary>
  2718. <value><c>true</c> if force; otherwise, <c>false</c>.</value>
  2719. </member>
  2720. <member name="P:MSBuild.Community.Tasks.GacUtil.Assemblies">
  2721. <summary>
  2722. Gets or sets the assembly name or file.
  2723. </summary>
  2724. <value>The assembly name or file.</value>
  2725. <remarks>
  2726. When the command is install, Assemblies should be a file path to the assembly
  2727. to install in the GAC. When command is uninstall, Assemblies should be a
  2728. the full name of the assembly to uninstall.
  2729. </remarks>
  2730. </member>
  2731. <member name="P:MSBuild.Community.Tasks.GacUtil.InstalledPaths">
  2732. <summary>
  2733. Gets the installed assembly paths.
  2734. </summary>
  2735. <value>The installed paths.</value>
  2736. </member>
  2737. <member name="P:MSBuild.Community.Tasks.GacUtil.InstalledNames">
  2738. <summary>
  2739. Gets the installed assembly names.
  2740. </summary>
  2741. <value>The installed names.</value>
  2742. </member>
  2743. <member name="P:MSBuild.Community.Tasks.GacUtil.Successful">
  2744. <summary>
  2745. Gets the number of assemblies successfully installed/uninstalled.
  2746. </summary>
  2747. <value>The number successful assemblies.</value>
  2748. </member>
  2749. <member name="P:MSBuild.Community.Tasks.GacUtil.Failed">
  2750. <summary>
  2751. Gets the number of assemblies that failed to installed/uninstalled.
  2752. </summary>
  2753. <value>The number failed assemblies.</value>
  2754. </member>
  2755. <member name="P:MSBuild.Community.Tasks.GacUtil.Skipped">
  2756. <summary>
  2757. Gets the number of assemblies that were skipped during installed/uninstalled.
  2758. </summary>
  2759. <value>The number of skipped assemblies.</value>
  2760. </member>
  2761. <member name="T:MSBuild.Community.Tasks.JavaScript.JSCompress">
  2762. <summary>
  2763. Compresses JavaScript source by removing comments and unnecessary
  2764. whitespace. It typically reduces the size of the script by half,
  2765. resulting in faster downloads and code that is harder to read.
  2766. </summary>
  2767. <remarks>
  2768. This task does not change the behavior of the program that it is
  2769. compressing. The resulting code will be harder to debug as well as
  2770. harder to read.
  2771. </remarks>
  2772. </member>
  2773. <member name="M:MSBuild.Community.Tasks.JavaScript.JSCompress.Execute">
  2774. <summary>
  2775. When overridden in a derived class, executes the task.
  2776. </summary>
  2777. <returns>
  2778. true if the task successfully executed; otherwise, false.
  2779. </returns>
  2780. </member>
  2781. <member name="P:MSBuild.Community.Tasks.JavaScript.JSCompress.Files">
  2782. <summary>
  2783. Gets or sets the files to source-compress.
  2784. </summary>
  2785. </member>
  2786. <member name="P:MSBuild.Community.Tasks.JavaScript.JSCompress.Encoding">
  2787. <summary>
  2788. Encoding to use to read and write files.
  2789. </summary>
  2790. </member>
  2791. <member name="P:MSBuild.Community.Tasks.JavaScript.JSCompress.CompressedFiles">
  2792. <summary>
  2793. Gets the files that were successfully source-compressed.
  2794. </summary>
  2795. </member>
  2796. <member name="T:MSBuild.Community.Tasks.Oracle.AddTnsName">
  2797. <summary>
  2798. Defines a database host within the Oracle TNSNAMES.ORA file.
  2799. </summary>
  2800. <example>Add an entry to the system default TNSNAMES.ORA file and update any entry that already exists:
  2801. <code><![CDATA[ <AddTnsName AllowUpdates="True" EntryName="northwind.world" EntryText="(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = northwinddb01)(PORT = 1521))) (CONNECT_DATA = (SERVICE_NAME = northwind.world)))" /> ]]>
  2802. </code>
  2803. </example>
  2804. <example>Add an entry to a specific file and fail if the entry already exists:
  2805. <code><![CDATA[ <AddTnsName TnsNamesFile="c:\oracle\network\admin\tnsnames.ora" AllowUpdates="False" EntryName="northwind.world" EntryText="(DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = northwinddb01)(PORT = 1521))) (CONNECT_DATA = (SERVICE_NAME = northwind.world)))" /> ]]>
  2806. </code>
  2807. </example>
  2808. </member>
  2809. <member name="M:MSBuild.Community.Tasks.Oracle.AddTnsName.#ctor(MSBuild.Community.Tasks.Services.IRegistry,MSBuild.Community.Tasks.Services.IFilesSystem)">
  2810. <summary>
  2811. Creates a new instance of the AddTnsName task using dependency injection.
  2812. </summary>
  2813. <param name="registry">A service that provides access to the Windows registry.</param>
  2814. <param name="fileSystem">A service that provides access to the file system.</param>
  2815. </member>
  2816. <member name="M:MSBuild.Community.Tasks.Oracle.AddTnsName.#ctor">
  2817. <summary>
  2818. Creates a new instance of the AddTnsName task using the default system services.
  2819. </summary>
  2820. </member>
  2821. <member name="M:MSBuild.Community.Tasks.Oracle.AddTnsName.Execute">
  2822. <summary>
  2823. When overridden in a derived class, executes the task.
  2824. </summary>
  2825. <returns>
  2826. true if the task successfully executed; otherwise, false.
  2827. </returns>
  2828. </member>
  2829. <member name="M:MSBuild.Community.Tasks.Oracle.AddTnsName.GetEffectivePathToTnsNamesFile">
  2830. <summary>
  2831. Determines which TNSNAMES.ORA file to update based on task input and the current system environment.
  2832. </summary>
  2833. <returns>The path of the TNSNAMES.ORA file that will be used by the task.</returns>
  2834. <exclude />
  2835. </member>
  2836. <member name="P:MSBuild.Community.Tasks.Oracle.AddTnsName.TnsNamesFile">
  2837. <summary>
  2838. The path to a specific TNSNAMES.ORA file to update.
  2839. </summary>
  2840. <remarks>If not specified, the default is %ORACLE_HOME%\network\admin\tnsnames.ora</remarks>
  2841. </member>
  2842. <member name="P:MSBuild.Community.Tasks.Oracle.AddTnsName.OriginalFileText">
  2843. <summary>
  2844. The contents of the TNSNAMES.ORA file before any changes are made.
  2845. </summary>
  2846. </member>
  2847. <member name="P:MSBuild.Community.Tasks.Oracle.AddTnsName.ModifiedFile">
  2848. <summary>
  2849. The path to the TNSNAMES.ORA that was used by task.
  2850. </summary>
  2851. </member>
  2852. <member name="P:MSBuild.Community.Tasks.Oracle.AddTnsName.EntryName">
  2853. <summary>
  2854. The name of the host entry to add.
  2855. </summary>
  2856. <remarks>To be properly recognized by Oracle, the value must contain a period, followed by a suffix. For example: mydatabase.world</remarks>
  2857. </member>
  2858. <member name="P:MSBuild.Community.Tasks.Oracle.AddTnsName.ModifiedFileText">
  2859. <summary>
  2860. The contents of the TNSNAMES.ORA file after the task executes.
  2861. </summary>
  2862. </member>
  2863. <member name="P:MSBuild.Community.Tasks.Oracle.AddTnsName.EntryText">
  2864. <summary>
  2865. The definition of the host entry to add.
  2866. </summary>
  2867. <remarks>To be properly recognized by Oracle, the value must be surrounded by parentheses.</remarks>
  2868. </member>
  2869. <member name="P:MSBuild.Community.Tasks.Oracle.AddTnsName.AllowUpdates">
  2870. <summary>
  2871. When true, the task will update an existing entry with <see cref="P:MSBuild.Community.Tasks.Oracle.AddTnsName.EntryName"/>.
  2872. If false, the task will fail if <see cref="P:MSBuild.Community.Tasks.Oracle.AddTnsName.EntryName"/> already exists.
  2873. </summary>
  2874. </member>
  2875. <member name="T:MSBuild.Community.Tasks.Oracle.TnsEntry">
  2876. <summary>
  2877. Contains information about a TNS definition
  2878. </summary>
  2879. <exclude />
  2880. </member>
  2881. <member name="M:MSBuild.Community.Tasks.Oracle.TnsEntry.#ctor(System.Int32,System.Int32)">
  2882. <summary>
  2883. Creates a new instance of a TnsEntry
  2884. </summary>
  2885. <param name="startPosition">The position of the entry within a TNSNAMES.ORA file</param>
  2886. <param name="length">The length of the entry definition within the TNSNAMES.ORA file</param>
  2887. </member>
  2888. <member name="P:MSBuild.Community.Tasks.Oracle.TnsEntry.StartPosition">
  2889. <summary>
  2890. The position of the entry within a TNSNAMES.ORA file
  2891. </summary>
  2892. </member>
  2893. <member name="P:MSBuild.Community.Tasks.Oracle.TnsEntry.Length">
  2894. <summary>
  2895. The length of the entry definition within the TNSNAMES.ORA file
  2896. </summary>
  2897. </member>
  2898. <member name="T:MSBuild.Community.Tasks.Oracle.TnsParser">
  2899. <summary>
  2900. Locates host entries within a TNSNAMES.ORA file
  2901. </summary>
  2902. <exclude />
  2903. </member>
  2904. <member name="M:MSBuild.Community.Tasks.Oracle.TnsParser.#ctor(System.String)">
  2905. <summary>
  2906. Initializes a new instance of the parser using the contents of a TNSNAMES.ORA file.
  2907. </summary>
  2908. <param name="content"></param>
  2909. </member>
  2910. <member name="M:MSBuild.Community.Tasks.Oracle.TnsParser.FindEntry(System.String)">
  2911. <summary>
  2912. Locates a host entry by its name.
  2913. </summary>
  2914. <param name="name">The name of the entry to find.</param>
  2915. <returns>A <see cref="T:MSBuild.Community.Tasks.Oracle.TnsEntry"/> which contains information about the location of the entry within the file.</returns>
  2916. </member>
  2917. <member name="T:MSBuild.Community.Tasks.RoboCopy">
  2918. <summary>
  2919. Task wrapping the Window Resource Kit Robocopy.exe command.
  2920. </summary>
  2921. <example>Deploy website to web server.
  2922. <code><![CDATA[
  2923. <RoboCopy
  2924. SourceFolder="$(MSBuildProjectDirectory)"
  2925. DestinationFolder="\\server\webroot\"
  2926. Mirror="true"
  2927. ExcludeFolders=".svn;obj;Test"
  2928. ExcludeFiles="*.cs;*.resx;*.csproj;*.webinfo;*.log"
  2929. NoJobHeader="true"
  2930. />
  2931. ]]></code>
  2932. </example>
  2933. </member>
  2934. <member name="M:MSBuild.Community.Tasks.RoboCopy.HandleTaskExecutionErrors">
  2935. <summary>
  2936. Handles execution errors raised by the executable file.
  2937. </summary>
  2938. <returns>
  2939. true if the method runs successfully; otherwise, false.
  2940. </returns>
  2941. </member>
  2942. <member name="M:MSBuild.Community.Tasks.RoboCopy.GenerateCommandLineCommands">
  2943. <summary>
  2944. Returns a string value containing the command line arguments to pass directly to the executable file.
  2945. </summary>
  2946. <returns>
  2947. A string value containing the command line arguments to pass directly to the executable file.
  2948. </returns>
  2949. </member>
  2950. <member name="M:MSBuild.Community.Tasks.RoboCopy.GenerateFullPathToTool">
  2951. <summary>
  2952. Returns the fully qualified path to the executable file.
  2953. </summary>
  2954. <returns>
  2955. The fully qualified path to the executable file.
  2956. </returns>
  2957. </member>
  2958. <member name="M:MSBuild.Community.Tasks.RoboCopy.LogToolCommand(System.String)">
  2959. <summary>
  2960. Logs the starting point of the run to all registered loggers.
  2961. </summary>
  2962. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  2963. </member>
  2964. <member name="P:MSBuild.Community.Tasks.RoboCopy.SourceFolder">
  2965. <summary>
  2966. Source directory
  2967. </summary>
  2968. <remarks>
  2969. You can use drive:\path or \\server\share\path
  2970. </remarks>
  2971. </member>
  2972. <member name="P:MSBuild.Community.Tasks.RoboCopy.SourceFiles">
  2973. <summary>
  2974. Names of files to act upon.
  2975. </summary>
  2976. <remarks>
  2977. You can use wildcard characters (? and *). If no
  2978. files are listed, Robocopy defaults to all files (*.*).
  2979. </remarks>
  2980. </member>
  2981. <member name="P:MSBuild.Community.Tasks.RoboCopy.DestinationFolder">
  2982. <summary>
  2983. Destination directory.
  2984. </summary>
  2985. <remarks>
  2986. You can use drive:\path or \\server\share\path
  2987. </remarks>
  2988. </member>
  2989. <member name="P:MSBuild.Community.Tasks.RoboCopy.Subdirectories">
  2990. <summary>
  2991. /S Copies subdirectories (excluding empty ones).
  2992. </summary>
  2993. </member>
  2994. <member name="P:MSBuild.Community.Tasks.RoboCopy.AllSubdirectories">
  2995. <summary>
  2996. /E Copies all subdirectories (including empty ones).
  2997. </summary>
  2998. </member>
  2999. <member name="P:MSBuild.Community.Tasks.RoboCopy.RestartableMode">
  3000. <summary>
  3001. /Z Copies files in restartable mode (that is, restarts the copy process from the point of failure).
  3002. </summary>
  3003. </member>
  3004. <member name="P:MSBuild.Community.Tasks.RoboCopy.BackupMode">
  3005. <summary>
  3006. /B Copies files in Backup mode (Backup copies are not restartable, but can copy some files that restartable mode cannot).
  3007. </summary>
  3008. </member>
  3009. <member name="P:MSBuild.Community.Tasks.RoboCopy.CopyFlags">
  3010. <summary>
  3011. /COPY:copyflags Copies the file information specified by copyflags.
  3012. </summary>
  3013. <remarks>
  3014. D file Data, S file Security (NTFS ACLs), A file Attributes,
  3015. O file Ownership information, T file Timestamps, U file Auditing infomation.
  3016. </remarks>
  3017. </member>
  3018. <member name="P:MSBuild.Community.Tasks.RoboCopy.CopyAll">
  3019. <summary>
  3020. /COPYALL Copies Everything. Equivalent to /COPY:DATSOU.
  3021. </summary>
  3022. </member>
  3023. <member name="P:MSBuild.Community.Tasks.RoboCopy.NoCopy">
  3024. <summary>
  3025. /NOCOPY Copies Nothing. Can be useful with /PURGE.
  3026. </summary>
  3027. </member>
  3028. <member name="P:MSBuild.Community.Tasks.RoboCopy.Security">
  3029. <summary>
  3030. /SEC Copies NTFS security information. (Source and destination volumes must both be NTFS). Equivalent to /COPY:DATS.
  3031. </summary>
  3032. </member>
  3033. <member name="P:MSBuild.Community.Tasks.RoboCopy.MoveFiles">
  3034. <summary>
  3035. /MOV Moves files (that is, deletes source files after copying).
  3036. </summary>
  3037. </member>
  3038. <member name="P:MSBuild.Community.Tasks.RoboCopy.Move">
  3039. <summary>
  3040. /MOVE Moves files and directories (that is, deletes source files and directories after copying).
  3041. </summary>
  3042. </member>
  3043. <member name="P:MSBuild.Community.Tasks.RoboCopy.Purge">
  3044. <summary>
  3045. /PURGE Deletes destination files and directories that no longer exist in the source.
  3046. </summary>
  3047. </member>
  3048. <member name="P:MSBuild.Community.Tasks.RoboCopy.Mirror">
  3049. <summary>
  3050. /MIR Mirrors a directory tree (equivalent to running both /E and /PURGE).
  3051. </summary>
  3052. </member>
  3053. <member name="P:MSBuild.Community.Tasks.RoboCopy.Create">
  3054. <summary>
  3055. /CREATE Creates a directory tree structure containing zero-length files only (that is, no file data is copied).
  3056. </summary>
  3057. </member>
  3058. <member name="P:MSBuild.Community.Tasks.RoboCopy.FatFileNames">
  3059. <summary>
  3060. /FAT Creates destination files using only 8.3 FAT file names.
  3061. </summary>
  3062. </member>
  3063. <member name="P:MSBuild.Community.Tasks.RoboCopy.FatFileTimes">
  3064. <summary>
  3065. /FFT Assume FAT File Times (2-second granularity).
  3066. </summary>
  3067. </member>
  3068. <member name="P:MSBuild.Community.Tasks.RoboCopy.IncludeAttributes">
  3069. <summary>
  3070. /IA:{R|A|S|H|C|N|E|T|O} Includes files with the specified attributes.
  3071. </summary>
  3072. <remarks>
  3073. The following file attributes can be acted upon:
  3074. R Read only, A Archive, S System, H Hidden,
  3075. C Compressed, N Not content indexed, E Encrypted,
  3076. T Temporary, O - Offline
  3077. </remarks>
  3078. </member>
  3079. <member name="P:MSBuild.Community.Tasks.RoboCopy.ExcluedAttributes">
  3080. <summary>
  3081. /XA:{R|A|S|H|C|N|E|T|O} Excludes files with the specified attributes.
  3082. </summary>
  3083. <remarks>
  3084. The following file attributes can be acted upon:
  3085. R Read only, A Archive, S System, H Hidden,
  3086. C Compressed, N Not content indexed, E Encrypted,
  3087. T Temporary, O - Offline
  3088. </remarks>
  3089. </member>
  3090. <member name="P:MSBuild.Community.Tasks.RoboCopy.IncludeArchive">
  3091. <summary>
  3092. /A Copies only files with the archive attribute set.
  3093. </summary>
  3094. </member>
  3095. <member name="P:MSBuild.Community.Tasks.RoboCopy.IncludeArchiveClear">
  3096. <summary>
  3097. /M Copies only files with the archive attribute set and then resets (turns off) the archive attribute in the source files.
  3098. </summary>
  3099. </member>
  3100. <member name="P:MSBuild.Community.Tasks.RoboCopy.ExcludeJunctions">
  3101. <summary>
  3102. /XJ Excludes Junction points.
  3103. </summary>
  3104. </member>
  3105. <member name="P:MSBuild.Community.Tasks.RoboCopy.ExcludeFiles">
  3106. <summary>
  3107. /XF file [file] Excludes files with the specified names, paths, or wildcard characters.
  3108. </summary>
  3109. </member>
  3110. <member name="P:MSBuild.Community.Tasks.RoboCopy.ExcludeFolders">
  3111. <summary>
  3112. /XD dir [dir] Excludes directories with the specified names, paths, or wildcard characters.
  3113. </summary>
  3114. </member>
  3115. <member name="P:MSBuild.Community.Tasks.RoboCopy.Verbose">
  3116. <summary>
  3117. /V Produces verbose output (including skipped files).
  3118. </summary>
  3119. </member>
  3120. <member name="P:MSBuild.Community.Tasks.RoboCopy.NoFileLogging">
  3121. <summary>
  3122. /NFL Turns off logging of file names. File names are still shown, however, if file copy errors occur.
  3123. </summary>
  3124. </member>
  3125. <member name="P:MSBuild.Community.Tasks.RoboCopy.NoFolderLogging">
  3126. <summary>
  3127. /NDL Turns off logging of directory names. Full file pathnames (as opposed to simple file names) will be shown if /NDL is used.
  3128. </summary>
  3129. </member>
  3130. <member name="P:MSBuild.Community.Tasks.RoboCopy.NoJobHeader">
  3131. <summary>
  3132. /NJH Turns of logging of the job header.
  3133. </summary>
  3134. </member>
  3135. <member name="P:MSBuild.Community.Tasks.RoboCopy.NoJobSummary">
  3136. <summary>
  3137. /NJS Turns off logging of the job summary.
  3138. </summary>
  3139. </member>
  3140. <member name="P:MSBuild.Community.Tasks.RoboCopy.NoProgress">
  3141. <summary>
  3142. /NP Turns off copy progress indicator (% copied).
  3143. </summary>
  3144. </member>
  3145. <member name="P:MSBuild.Community.Tasks.RoboCopy.LogFile">
  3146. <summary>
  3147. /LOG:file Redirects output to the specified file, overwriting the file if it already exists.
  3148. </summary>
  3149. </member>
  3150. <member name="P:MSBuild.Community.Tasks.RoboCopy.AppendLogFile">
  3151. <summary>
  3152. /LOG+:file Redirects output to the specified file, appending it to the file if it already exists.
  3153. </summary>
  3154. </member>
  3155. <member name="P:MSBuild.Community.Tasks.RoboCopy.Options">
  3156. <summary>
  3157. Manually entered options.
  3158. </summary>
  3159. </member>
  3160. <member name="P:MSBuild.Community.Tasks.RoboCopy.ToolName">
  3161. <summary>
  3162. Gets the name of the executable file to run.
  3163. </summary>
  3164. <value></value>
  3165. <returns>The name of the executable file to run.</returns>
  3166. </member>
  3167. <member name="P:MSBuild.Community.Tasks.RoboCopy.StandardOutputLoggingImportance">
  3168. <summary>
  3169. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  3170. </summary>
  3171. <value></value>
  3172. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  3173. </member>
  3174. <member name="T:MSBuild.Community.Tasks.Sound">
  3175. <summary>
  3176. A task to play a sound from a .wav file path or URL.
  3177. </summary>
  3178. <remarks>
  3179. You must specify either
  3180. a file or URL (<see cref="P:MSBuild.Community.Tasks.Sound.SoundLocation"/>),
  3181. a file relative to the <see cref="P:System.Environment.SystemDirectory"/> (<see cref="P:MSBuild.Community.Tasks.Sound.SystemSoundFile"/>),
  3182. or a file within the <see cref="F:System.Environment.SpecialFolder.MyMusic"/> folder (<see cref="P:MSBuild.Community.Tasks.Sound.MyMusicFile"/>).
  3183. </remarks><example>
  3184. To play the windows XP startup sound, use
  3185. <code>
  3186. <![CDATA[<Sound SystemSoundFile="..\Media\Windows XP Startup.wav" />]]>
  3187. </code>
  3188. </example><example>
  3189. To play a wav file from the "MyMusic" folder, use
  3190. <code>
  3191. <![CDATA[<Sound MyMusicFile="25881_acclivity_3beeps1000.wav" />]]>
  3192. </code>
  3193. </example>
  3194. </member>
  3195. <member name="M:MSBuild.Community.Tasks.Sound.Execute">
  3196. <summary>
  3197. Loads the .wav file given by <see cref="P:MSBuild.Community.Tasks.Sound.SoundLocation"/>
  3198. and plays the sound using a new thread.
  3199. </summary>
  3200. <returns>
  3201. Returns <see langword="true"/> if the .wav file can successfully be played;
  3202. otherwise, returns <see langword="false"/>.
  3203. </returns>
  3204. </member>
  3205. <member name="P:MSBuild.Community.Tasks.Sound.SoundLocation">
  3206. <summary>
  3207. Gets or sets the file path or URL of the .wav file to load.
  3208. </summary>
  3209. </member>
  3210. <member name="P:MSBuild.Community.Tasks.Sound.SystemSoundFile">
  3211. <summary>
  3212. Sets the file path of the .wav file to load
  3213. as a relative path to <see cref="P:System.Environment.SystemDirectory"/>.
  3214. </summary>
  3215. <example>
  3216. For example, on a Windows XP platform, you can call
  3217. <code><![CDATA[<Sound SystemSoundFile="..\Media\Windows XP Startup.wav" />]]></code>
  3218. </example>
  3219. </member>
  3220. <member name="P:MSBuild.Community.Tasks.Sound.MyMusicFile">
  3221. <summary>
  3222. Sets the file path of the .wav file to load
  3223. as a relative path to <see cref="F:System.Environment.SpecialFolder.MyMusic"/>.
  3224. </summary>
  3225. </member>
  3226. <member name="P:MSBuild.Community.Tasks.Sound.LoadTimeout">
  3227. <summary>
  3228. Gets or sets the time, in milliseconds, in which the .wav file must load.
  3229. </summary>
  3230. <value>The number of milliseconds to wait. The default is 10000 (10 seconds).</value>
  3231. <remarks>
  3232. After this time has expired, the loading is canceled and the task execution fails.
  3233. </remarks>
  3234. </member>
  3235. <member name="P:MSBuild.Community.Tasks.Sound.Synchron">
  3236. <summary>
  3237. Gets or sets a value indicating whether to play the sound synchronously.
  3238. </summary>
  3239. <value>
  3240. <see langword="true"/> if playing the sound using the caller's thread (default);
  3241. otherwise, <see langword="false"/> if playing the sound using a new thread.
  3242. </value>
  3243. </member>
  3244. <member name="T:MSBuild.Community.Tasks.SourceServer.FileBase">
  3245. <summary>
  3246. A base class that has a file.
  3247. </summary>
  3248. </member>
  3249. <member name="M:MSBuild.Community.Tasks.SourceServer.FileBase.#ctor(System.String)">
  3250. <summary>
  3251. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.SourceServer.FileBase"/> class.
  3252. </summary>
  3253. <param name="fileName">Name of the file.</param>
  3254. </member>
  3255. <member name="M:MSBuild.Community.Tasks.SourceServer.FileBase.#ctor(System.IO.FileInfo)">
  3256. <summary>
  3257. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.SourceServer.FileBase"/> class.
  3258. </summary>
  3259. <param name="fileInfo">The file info.</param>
  3260. </member>
  3261. <member name="M:MSBuild.Community.Tasks.SourceServer.FileBase.ToString">
  3262. <summary>
  3263. Returns a <see cref="T:System.String"/> that represents this instance.
  3264. </summary>
  3265. <returns>
  3266. A <see cref="T:System.String"/> that represents this instance.
  3267. </returns>
  3268. </member>
  3269. <member name="M:MSBuild.Community.Tasks.SourceServer.FileBase.op_Implicit(MSBuild.Community.Tasks.SourceServer.FileBase)~System.String">
  3270. <summary>
  3271. Performs an implicit conversion from <see cref="T:MSBuild.Community.Tasks.SourceServer.FileBase"/> to <see cref="T:System.String"/>.
  3272. </summary>
  3273. <param name="file">The output file.</param>
  3274. <returns>The result of the conversion.</returns>
  3275. </member>
  3276. <member name="P:MSBuild.Community.Tasks.SourceServer.FileBase.File">
  3277. <summary>
  3278. Gets or sets the file.
  3279. </summary>
  3280. <value>The file.</value>
  3281. </member>
  3282. <member name="T:MSBuild.Community.Tasks.SourceServer.PdbStrCommands">
  3283. <summary>
  3284. Commands for the <see cref="T:MSBuild.Community.Tasks.SourceServer.PdbStr"/> tasks.
  3285. </summary>
  3286. </member>
  3287. <member name="F:MSBuild.Community.Tasks.SourceServer.PdbStrCommands.read">
  3288. <summary>
  3289. Read stream from pdb symbol file.
  3290. </summary>
  3291. </member>
  3292. <member name="F:MSBuild.Community.Tasks.SourceServer.PdbStrCommands.write">
  3293. <summary>
  3294. Write stream to pdb symbol file.
  3295. </summary>
  3296. </member>
  3297. <member name="T:MSBuild.Community.Tasks.SourceServer.PdbStr">
  3298. <summary>
  3299. A task for the pdbstr from source server.
  3300. </summary>
  3301. </member>
  3302. <member name="M:MSBuild.Community.Tasks.SourceServer.PdbStr.GenerateCommandLineCommands">
  3303. <summary>
  3304. Returns a string value containing the command line arguments to pass directly to the executable file.
  3305. </summary>
  3306. <returns>
  3307. A string value containing the command line arguments to pass directly to the executable file.
  3308. </returns>
  3309. </member>
  3310. <member name="M:MSBuild.Community.Tasks.SourceServer.PdbStr.GenerateFullPathToTool">
  3311. <summary>
  3312. Returns the fully qualified path to the executable file.
  3313. </summary>
  3314. <returns>
  3315. The fully qualified path to the executable file.
  3316. </returns>
  3317. </member>
  3318. <member name="P:MSBuild.Community.Tasks.SourceServer.PdbStr.PdbFile">
  3319. <summary>
  3320. Gets or sets the PDB file.
  3321. </summary>
  3322. <value>The PDB file.</value>
  3323. </member>
  3324. <member name="P:MSBuild.Community.Tasks.SourceServer.PdbStr.StreamFile">
  3325. <summary>
  3326. Gets or sets the stream file.
  3327. </summary>
  3328. <value>The stream file.</value>
  3329. </member>
  3330. <member name="P:MSBuild.Community.Tasks.SourceServer.PdbStr.StreamName">
  3331. <summary>
  3332. Gets or sets the name of the stream.
  3333. </summary>
  3334. <value>The name of the stream.</value>
  3335. </member>
  3336. <member name="P:MSBuild.Community.Tasks.SourceServer.PdbStr.Command">
  3337. <summary>
  3338. Gets or sets the command.
  3339. </summary>
  3340. <value>The command.</value>
  3341. <enum cref="T:MSBuild.Community.Tasks.SourceServer.PdbStrCommands"/>
  3342. </member>
  3343. <member name="P:MSBuild.Community.Tasks.SourceServer.PdbStr.ToolName">
  3344. <summary>
  3345. Gets the name of the executable file to run.
  3346. </summary>
  3347. <value></value>
  3348. <returns>
  3349. The name of the executable file to run.
  3350. </returns>
  3351. </member>
  3352. <member name="T:MSBuild.Community.Tasks.SourceServer.SourceFile">
  3353. <summary>
  3354. A class representing a source file.
  3355. </summary>
  3356. </member>
  3357. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceFile.#ctor(System.String)">
  3358. <summary>
  3359. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.SourceServer.SourceFile"/> class.
  3360. </summary>
  3361. <param name="fileName">Name of the file.</param>
  3362. </member>
  3363. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceFile.#ctor(System.IO.FileInfo)">
  3364. <summary>
  3365. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.SourceServer.SourceFile"/> class.
  3366. </summary>
  3367. <param name="fileInfo">The file info.</param>
  3368. </member>
  3369. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceFile.ToSourceString(System.String)">
  3370. <summary>
  3371. Creates the source string.
  3372. </summary>
  3373. <param name="format">The format.</param>
  3374. <returns></returns>
  3375. </member>
  3376. <member name="P:MSBuild.Community.Tasks.SourceServer.SourceFile.Properties">
  3377. <summary>
  3378. Gets or sets the properties.
  3379. </summary>
  3380. <value>The properties.</value>
  3381. </member>
  3382. <member name="P:MSBuild.Community.Tasks.SourceServer.SourceFile.IsResolved">
  3383. <summary>
  3384. Gets or sets a value indicating whether this instance is resolved.
  3385. </summary>
  3386. <value>
  3387. <c>true</c> if this instance is resolved; otherwise, <c>false</c>.
  3388. </value>
  3389. </member>
  3390. <member name="T:MSBuild.Community.Tasks.SourceServer.SourceIndexBase">
  3391. <summary>
  3392. A base class for source indexing a pdb symbol file.
  3393. </summary>
  3394. </member>
  3395. <member name="F:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.Successful">
  3396. <remarks />
  3397. </member>
  3398. <member name="F:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.Failed">
  3399. <remarks />
  3400. </member>
  3401. <member name="F:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.Skipped">
  3402. <remarks />
  3403. </member>
  3404. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.Execute">
  3405. <summary>
  3406. When overridden in a derived class, executes the task.
  3407. </summary>
  3408. <returns>
  3409. true if the task successfully executed; otherwise, false.
  3410. </returns>
  3411. </member>
  3412. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.IndexSymbolFile(Microsoft.Build.Framework.ITaskItem)">
  3413. <summary>
  3414. Indexes the symbol file.
  3415. </summary>
  3416. <param name="item">The symbol file task item.</param>
  3417. <returns><c>true</c> if index successfully; otherwise <c>false</c>.</returns>
  3418. </member>
  3419. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.CreateSymbolFile(Microsoft.Build.Framework.ITaskItem)">
  3420. <summary>
  3421. Creates an instance of <see cref="T:MSBuild.Community.Tasks.SourceServer.SymbolFile"/> from the symbol file task item and add the source file list to it.
  3422. </summary>
  3423. <param name="item">The symbol file task item.</param>
  3424. <returns>An instance of <see cref="T:MSBuild.Community.Tasks.SourceServer.SymbolFile"/> or <c>null</c> if there was an error.</returns>
  3425. </member>
  3426. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.AddSourceProperties(MSBuild.Community.Tasks.SourceServer.SymbolFile)">
  3427. <summary>
  3428. Adds the source properties to the symbol file.
  3429. </summary>
  3430. <param name="symbolFile">The symbol file to add the source properties to.</param>
  3431. <returns><c>true</c> if successful; otherwise <c>false</c>.</returns>
  3432. </member>
  3433. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.CreateSourceIndexFile(MSBuild.Community.Tasks.SourceServer.SymbolFile,System.String)">
  3434. <summary>
  3435. Creates the source index file.
  3436. </summary>
  3437. <param name="symbolFile">The symbol file to create the index file from.</param>
  3438. <param name="sourceIndexFile">The source index file.</param>
  3439. <returns><c>true</c> if successful; otherwise <c>false</c>.</returns>
  3440. </member>
  3441. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.WriteSourceIndex(MSBuild.Community.Tasks.SourceServer.SymbolFile,System.String)">
  3442. <summary>
  3443. Writes the source index file to the symbol file.
  3444. </summary>
  3445. <param name="symbolFile">The symbol file.</param>
  3446. <param name="sourceIndexFile">The source index file.</param>
  3447. <returns><c>true</c> if successful; otherwise <c>false</c>.</returns>
  3448. </member>
  3449. <member name="M:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.CopyBuildEngine(Microsoft.Build.Framework.ITask)">
  3450. <summary>
  3451. Copies the build engine to the task.
  3452. </summary>
  3453. <param name="task">The task.</param>
  3454. </member>
  3455. <member name="P:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.SymbolFiles">
  3456. <summary>
  3457. Gets or sets the symbol files to have to source index added.
  3458. </summary>
  3459. <value>The symbol files.</value>
  3460. </member>
  3461. <member name="P:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.SourceServerSdkPath">
  3462. <summary>
  3463. Gets or sets the source server SDK path.
  3464. </summary>
  3465. <value>The source server SDK path.</value>
  3466. </member>
  3467. <member name="P:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.SourceServerName">
  3468. <summary>
  3469. Gets or sets the name of the source server.
  3470. </summary>
  3471. <value>The name of the source server.</value>
  3472. </member>
  3473. <member name="P:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.SourceCommandFormat">
  3474. <summary>
  3475. Gets or sets the source command format. The SRCSRVCMD environment variable.
  3476. </summary>
  3477. <value>The source command format.</value>
  3478. <remarks>
  3479. Describes how to build the command to extract the file from source control.
  3480. This includes the name of the executable file and its command-line parameters.
  3481. See srcsrv.doc for full documentation on SRCSRVCMD.
  3482. </remarks>
  3483. </member>
  3484. <member name="P:MSBuild.Community.Tasks.SourceServer.SourceIndexBase.SourceTargetFormat">
  3485. <summary>
  3486. Gets or sets the source target format. The SRCSRVTRG environment variable.
  3487. </summary>
  3488. <value>The source target format.</value>
  3489. <remarks>
  3490. Describes how to build the target path for the extracted file.
  3491. See srcsrv.doc for full documentation on SRCSRVTRG.
  3492. </remarks>
  3493. </member>
  3494. <member name="T:MSBuild.Community.Tasks.SourceServer.SrcTool">
  3495. <summary>
  3496. A task for the srctool from source server.
  3497. </summary>
  3498. </member>
  3499. <member name="M:MSBuild.Community.Tasks.SourceServer.SrcTool.GenerateCommandLineCommands">
  3500. <summary>
  3501. Returns a string value containing the command line arguments to pass directly to the executable file.
  3502. </summary>
  3503. <returns>
  3504. A string value containing the command line arguments to pass directly to the executable file.
  3505. </returns>
  3506. </member>
  3507. <member name="M:MSBuild.Community.Tasks.SourceServer.SrcTool.LogEventsFromTextOutput(System.String,Microsoft.Build.Framework.MessageImportance)">
  3508. <summary>
  3509. Parses a single line of text to identify any errors or warnings in canonical format.
  3510. </summary>
  3511. <param name="singleLine">A single line of text for the method to parse.</param>
  3512. <param name="messageImportance">A value of <see cref="T:Microsoft.Build.Framework.MessageImportance"/> that indicates the importance level with which to log the message.</param>
  3513. </member>
  3514. <member name="M:MSBuild.Community.Tasks.SourceServer.SrcTool.HandleTaskExecutionErrors">
  3515. <summary>
  3516. Handles execution errors raised by the executable file.
  3517. </summary>
  3518. <returns>
  3519. true if the method runs successfully; otherwise, false.
  3520. </returns>
  3521. </member>
  3522. <member name="M:MSBuild.Community.Tasks.SourceServer.SrcTool.GenerateFullPathToTool">
  3523. <summary>
  3524. Returns the fully qualified path to the executable file.
  3525. </summary>
  3526. <returns>
  3527. The fully qualified path to the executable file.
  3528. </returns>
  3529. </member>
  3530. <member name="M:MSBuild.Community.Tasks.SourceServer.SrcTool.LogToolCommand(System.String)">
  3531. <summary>
  3532. Logs the starting point of the run to all registered loggers.
  3533. </summary>
  3534. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  3535. </member>
  3536. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.PdbFile">
  3537. <summary>
  3538. Gets or sets the PDB file.
  3539. </summary>
  3540. <value>The PDB file.</value>
  3541. </member>
  3542. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.SourceOnly">
  3543. <summary>
  3544. Gets or sets a value indicating whether to dumps raw source data from the PDB. The -r switch.
  3545. </summary>
  3546. <value><c>true</c> if source only; otherwise, <c>false</c>.</value>
  3547. </member>
  3548. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.Filter">
  3549. <summary>
  3550. Gets or sets the filter to only source files that match this regular expression. The -l switch.
  3551. </summary>
  3552. <value>The filter regular expression.</value>
  3553. </member>
  3554. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.Extract">
  3555. <summary>
  3556. Gets or sets a value indicating whether to extracts the files, instead of simply listing them. The -x switch.
  3557. </summary>
  3558. <value><c>true</c> if extract; otherwise, <c>false</c>.</value>
  3559. </member>
  3560. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.ExtractDirectory">
  3561. <summary>
  3562. Gets or sets the directory to extract to. The -d switch.
  3563. </summary>
  3564. <value>The extract directory.</value>
  3565. </member>
  3566. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.CountOnly">
  3567. <summary>
  3568. Gets or sets a value indicating whether to get the count of indexed files. The -c switch.
  3569. </summary>
  3570. <value><c>true</c> if count only; otherwise, <c>false</c>.</value>
  3571. </member>
  3572. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.SourceCount">
  3573. <summary>
  3574. Gets or sets the number of source files.
  3575. </summary>
  3576. <value>The number of source files.</value>
  3577. </member>
  3578. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.SourceFiles">
  3579. <summary>
  3580. Gets the source files. Populated when <see cref="P:MSBuild.Community.Tasks.SourceServer.SrcTool.SourceOnly"/> is <c>true</c>.
  3581. </summary>
  3582. <value>The source files.</value>
  3583. </member>
  3584. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.ExtractedFiles">
  3585. <summary>
  3586. Gets the extracted files. Populated when <see cref="P:MSBuild.Community.Tasks.SourceServer.SrcTool.Extract"/> is <c>true</c>.
  3587. </summary>
  3588. <value>The extracted files.</value>
  3589. </member>
  3590. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.ToolName">
  3591. <summary>
  3592. Gets the name of the executable file to run.
  3593. </summary>
  3594. <value></value>
  3595. <returns>
  3596. The name of the executable file to run.
  3597. </returns>
  3598. </member>
  3599. <member name="P:MSBuild.Community.Tasks.SourceServer.SrcTool.StandardOutputLoggingImportance">
  3600. <summary>
  3601. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  3602. </summary>
  3603. <value></value>
  3604. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  3605. </member>
  3606. <member name="T:MSBuild.Community.Tasks.SourceServer.SvnSourceIndex">
  3607. <summary>
  3608. A subversion source index task.
  3609. </summary>
  3610. </member>
  3611. <member name="M:MSBuild.Community.Tasks.SourceServer.SvnSourceIndex.#ctor">
  3612. <summary>
  3613. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.SourceServer.SvnSourceIndex"/> class.
  3614. </summary>
  3615. </member>
  3616. <member name="M:MSBuild.Community.Tasks.SourceServer.SvnSourceIndex.AddSourceProperties(MSBuild.Community.Tasks.SourceServer.SymbolFile)">
  3617. <summary>
  3618. Adds the source properties to the symbol file.
  3619. </summary>
  3620. <param name="symbolFile">The symbol file to add the source properties to.</param>
  3621. <returns>
  3622. <c>true</c> if successful; otherwise <c>false</c>.
  3623. </returns>
  3624. </member>
  3625. <member name="M:MSBuild.Community.Tasks.SourceServer.SvnSourceIndex.CreateSourceIndexFile(MSBuild.Community.Tasks.SourceServer.SymbolFile,System.String)">
  3626. <summary>
  3627. Creates the source index file.
  3628. </summary>
  3629. <param name="symbolFile">The symbol file to create the index file from.</param>
  3630. <param name="sourceIndexFile">The source index file.</param>
  3631. <returns>
  3632. <c>true</c> if successful; otherwise <c>false</c>.
  3633. </returns>
  3634. </member>
  3635. <member name="T:MSBuild.Community.Tasks.SourceServer.SymbolFile">
  3636. <summary>
  3637. A class representing a symbol file.
  3638. </summary>
  3639. </member>
  3640. <member name="M:MSBuild.Community.Tasks.SourceServer.SymbolFile.#ctor(System.String)">
  3641. <summary>
  3642. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.SourceServer.SymbolFile"/> class.
  3643. </summary>
  3644. <param name="fileName">Name of the file.</param>
  3645. </member>
  3646. <member name="M:MSBuild.Community.Tasks.SourceServer.SymbolFile.#ctor(System.IO.FileInfo)">
  3647. <summary>
  3648. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.SourceServer.SymbolFile"/> class.
  3649. </summary>
  3650. <param name="fileInfo">The file info.</param>
  3651. </member>
  3652. <member name="M:MSBuild.Community.Tasks.SourceServer.SymbolFile.AddSourceFiles(System.Collections.Generic.IEnumerable{System.String})">
  3653. <summary>
  3654. Adds the source files.
  3655. </summary>
  3656. <param name="files">The files.</param>
  3657. </member>
  3658. <member name="P:MSBuild.Community.Tasks.SourceServer.SymbolFile.SourceFiles">
  3659. <summary>
  3660. Gets the source files.
  3661. </summary>
  3662. <value>The source files.</value>
  3663. </member>
  3664. <member name="P:MSBuild.Community.Tasks.SourceServer.SymbolFile.IsIndexed">
  3665. <summary>
  3666. Gets or sets a value indicating whether this instance is indexed.
  3667. </summary>
  3668. <value>
  3669. <c>true</c> if this instance is indexed; otherwise, <c>false</c>.
  3670. </value>
  3671. </member>
  3672. <member name="T:MSBuild.Community.Tasks.SqlServer.SqlPubCommands">
  3673. <summary>
  3674. The SqlPubWiz commands
  3675. </summary>
  3676. </member>
  3677. <member name="F:MSBuild.Community.Tasks.SqlServer.SqlPubCommands.Script">
  3678. <summary>
  3679. Scripts a local database to one or more files
  3680. </summary>
  3681. </member>
  3682. <member name="F:MSBuild.Community.Tasks.SqlServer.SqlPubCommands.Publish">
  3683. <summary>
  3684. Publishes a local database to a web service provided by a hoster.
  3685. </summary>
  3686. </member>
  3687. <member name="T:MSBuild.Community.Tasks.SqlServer.SqlPubWiz">
  3688. <summary>
  3689. The Database Publishing Wizard enables the deployment of
  3690. SQL Server databases (both schema and data) into a shared
  3691. hosting environment.
  3692. </summary>
  3693. <example>Generate the database script for Northwind on localhost.
  3694. <code><![CDATA[
  3695. <SqlPubWiz
  3696. Database="Northwind"
  3697. Output="Northwind.sql"
  3698. SchemaOnly="true" />
  3699. ]]></code>
  3700. </example>
  3701. </member>
  3702. <member name="M:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.GenerateFullPathToTool">
  3703. <summary>
  3704. Returns the fully qualified path to the executable file.
  3705. </summary>
  3706. <returns>
  3707. The fully qualified path to the executable file.
  3708. </returns>
  3709. </member>
  3710. <member name="M:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.GenerateCommandLineCommands">
  3711. <summary>
  3712. Returns a string value containing the command line arguments to pass directly to the executable file.
  3713. </summary>
  3714. <returns>
  3715. A string value containing the command line arguments to pass directly to the executable file.
  3716. </returns>
  3717. </member>
  3718. <member name="M:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.LogToolCommand(System.String)">
  3719. <summary>
  3720. Logs the starting point of the run to all registered loggers.
  3721. </summary>
  3722. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  3723. </member>
  3724. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Command">
  3725. <summary>
  3726. Gets or sets the database publishing command.
  3727. </summary>
  3728. <value>The database publishing command.</value>
  3729. <remarks>
  3730. Use either script or publish. Use script to script a local
  3731. database to a file on the local computer. Use publish to
  3732. transfer database objects directly to a hosted database via
  3733. a web service. script and publish enable some of the same
  3734. options and switches. Some options and switches are only
  3735. enabled only by one of these verbs.
  3736. </remarks>
  3737. </member>
  3738. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ConnectionString">
  3739. <summary>
  3740. Gets or sets the full connection string to the local database.
  3741. </summary>
  3742. <value>The connection string.</value>
  3743. <remarks>
  3744. Provides a full connection string to connect to the local
  3745. database. This connection string encapsulates all connection
  3746. options to the server. Incompatible with <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Username"/>,
  3747. <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Password"/> or, <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Server"/>.
  3748. </remarks>
  3749. </member>
  3750. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Database">
  3751. <summary>
  3752. Gets or sets the name of the local database to be scripted.
  3753. </summary>
  3754. <value>The name of the database to be scripted.</value>
  3755. </member>
  3756. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Username">
  3757. <summary>
  3758. Gets or sets the SQL Server user name to use for connection
  3759. to the source database.
  3760. </summary>
  3761. <value>The SQL Server user name.</value>
  3762. <remarks>
  3763. Specifies the SQL Server User name to use for connection
  3764. to the source database. Requires <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Password"/>.
  3765. Incompatible with <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ConnectionString"/>.
  3766. </remarks>
  3767. </member>
  3768. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Password">
  3769. <summary>
  3770. Gets or sets the password to use for connection
  3771. to the source database.
  3772. </summary>
  3773. <value>The password.</value>
  3774. <remarks>
  3775. Specifies the password to use for connection to the source
  3776. database. Requires <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Username"/>.
  3777. Incompatible with <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ConnectionString"/>.
  3778. </remarks>
  3779. </member>
  3780. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Server">
  3781. <summary>
  3782. Gets or sets the name or IP address for the local database connection.
  3783. </summary>
  3784. <value>The name or IP address of server.</value>
  3785. <remarks>
  3786. Specifies the name or IP address for the local database connection.
  3787. The default is localhost. Incompatible with <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ConnectionString"/>.
  3788. </remarks>
  3789. </member>
  3790. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Output">
  3791. <summary>
  3792. Gets or sets the full file path for the script file generated.
  3793. </summary>
  3794. <value>The full file path.</value>
  3795. <remarks>
  3796. Use only with script. Specifies the full file path for the script
  3797. file generated by the sqlpubwiz.
  3798. </remarks>
  3799. </member>
  3800. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.SchemaOnly">
  3801. <summary>
  3802. Gets or sets a value indicating whether the schema,
  3803. but not the data, should be scripted.
  3804. </summary>
  3805. <value>
  3806. <c>true</c> if only the schema should be scripted;
  3807. otherwise, <c>false</c>.
  3808. </value>
  3809. <remarks>
  3810. Specifies that the schema, but not the data, should be
  3811. scripted. Incompatible with <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.DataOnly"/>.
  3812. If neither <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.SchemaOnly"/> nor <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.DataOnly"/>
  3813. are specified, both the schema and data are scripted.
  3814. </remarks>
  3815. </member>
  3816. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.DataOnly">
  3817. <summary>
  3818. Gets or sets a value indicating whether the data but
  3819. not the schema should be scripted.
  3820. </summary>
  3821. <value>
  3822. <c>true</c> if only the data is scripted;
  3823. otherwise, <c>false</c>.
  3824. </value>
  3825. <remarks>
  3826. Specifies that the data but not the schema should be
  3827. scripted. Incompatible with <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.NoDropExisting"/>
  3828. or <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.SchemaOnly"/>. If neither <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.SchemaOnly"/>
  3829. nor <see cref="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.DataOnly"/> are specified, both the schema
  3830. and data are scripted.
  3831. </remarks>
  3832. </member>
  3833. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.TargetServer">
  3834. <summary>
  3835. Gets or sets the target server the script should target.
  3836. </summary>
  3837. <value>The target server the script should target.</value>
  3838. <remarks>
  3839. Specifies that the script to be generated should target
  3840. a SQL Server 2000 or SQL Server 2005 instance.
  3841. The default is SQL Server 2005.
  3842. </remarks>
  3843. </member>
  3844. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.NoSchemaQualify">
  3845. <summary>
  3846. Gets or sets a value indicating whether objects will
  3847. not be qualified with a schema.
  3848. </summary>
  3849. <value>
  3850. <c>true</c> if objects will not be schema qualified;
  3851. otherwise, <c>false</c>.
  3852. </value>
  3853. </member>
  3854. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.NoDropExisting">
  3855. <summary>
  3856. Gets or sets a value indicating whether the produced
  3857. script should not drop pre-existing objects.
  3858. </summary>
  3859. <value>
  3860. <c>true</c> if pre-existing objects should not be dropped;
  3861. otherwise, <c>false</c>.
  3862. </value>
  3863. </member>
  3864. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.Quiet">
  3865. <summary>
  3866. Gets or sets a value indicating output message suppression.
  3867. </summary>
  3868. <value><c>true</c> to suppress messages; otherwise, <c>false</c>.</value>
  3869. </member>
  3870. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.HosterName">
  3871. <summary>
  3872. Gets or sets the friendly name of previously
  3873. configured hosting Web service.
  3874. </summary>
  3875. <value>The name of the hoster.</value>
  3876. </member>
  3877. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.WebServiceAddress">
  3878. <summary>
  3879. Gets or sets the configuration of the hosting Web service endpoint.
  3880. </summary>
  3881. <value>The web service address.</value>
  3882. </member>
  3883. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ServiceUsername">
  3884. <summary>
  3885. Gets or sets the username on the hosting Web service endpoint.
  3886. </summary>
  3887. <value>The service username.</value>
  3888. </member>
  3889. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ServicePassword">
  3890. <summary>
  3891. Gets or sets the password for the remote Web service endpoint.
  3892. </summary>
  3893. <value>The service password.</value>
  3894. </member>
  3895. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ServiceDatabaseServer">
  3896. <summary>
  3897. Gets or sets the database name to publish to on the remote server.
  3898. </summary>
  3899. <value>The service database server.</value>
  3900. </member>
  3901. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ServiceDatabase">
  3902. <summary>
  3903. Gets or sets the remote database server name.
  3904. </summary>
  3905. <value>The service database.</value>
  3906. </member>
  3907. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.NoTransaction">
  3908. <summary>
  3909. Gets or sets a value indicating whether the publish operation
  3910. should not be executed within a single transaction.
  3911. </summary>
  3912. <value><c>true</c> to not publish in a single transaction; otherwise, <c>false</c>.</value>
  3913. <remarks>
  3914. Specifies that the publish operation should not be executed
  3915. within a single transaction. This reduces logging overhead
  3916. on the target server, but if the publish is interrupted, the
  3917. target database may be left in a partially populated state.
  3918. </remarks>
  3919. </member>
  3920. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.ToolName">
  3921. <summary>
  3922. Gets the name of the executable file to run.
  3923. </summary>
  3924. <value></value>
  3925. <returns>The name of the executable file to run.</returns>
  3926. </member>
  3927. <member name="P:MSBuild.Community.Tasks.SqlServer.SqlPubWiz.StandardOutputLoggingImportance">
  3928. <summary>
  3929. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  3930. </summary>
  3931. <value></value>
  3932. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  3933. </member>
  3934. <member name="T:MSBuild.Community.Tasks.Subversion.SvnCopy">
  3935. <summary>
  3936. Copy a file or folder in Subversion
  3937. </summary>
  3938. <remarks>
  3939. This is most useful for automatically tagging your source code during a build.
  3940. You can create a tag by copying a path from one server location to another.
  3941. </remarks>
  3942. <example>Create a tag of the trunk with the current Cruise Control build number:
  3943. <code><![CDATA[
  3944. <Target Name="TagTheBuild">
  3945. <SvnCopy SourcePath="file:///d:/svn/repo/Test/trunk"
  3946. DestinationPath="file:///d:/svn/repo/Test/tags/BUILD-$(CCNetLabel)"
  3947. Message="Automatic build of $(CCNetProject)" />
  3948. </Target>
  3949. ]]></code>
  3950. </example>
  3951. </member>
  3952. <member name="T:MSBuild.Community.Tasks.Subversion.SvnClient">
  3953. <summary>
  3954. Subversion client base class
  3955. </summary>
  3956. </member>
  3957. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.GenerateSvnCommand">
  3958. <summary>
  3959. Generates the SVN command.
  3960. </summary>
  3961. <returns></returns>
  3962. </member>
  3963. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.GenerateSvnArguments">
  3964. <summary>
  3965. Generates the SVN arguments.
  3966. </summary>
  3967. <returns></returns>
  3968. </member>
  3969. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.Execute">
  3970. <summary>
  3971. Runs the exectuable file with the specified task parameters.
  3972. </summary>
  3973. <returns>
  3974. true if the task runs successfully; otherwise, false.
  3975. </returns>
  3976. </member>
  3977. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.GenerateCommandLineCommands">
  3978. <summary>
  3979. Returns a string value containing the command line arguments to pass directly to the executable file.
  3980. </summary>
  3981. <returns>
  3982. A string value containing the command line arguments to pass directly to the executable file.
  3983. </returns>
  3984. </member>
  3985. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.ValidateParameters">
  3986. <summary>
  3987. Indicates whether all task paratmeters are valid.
  3988. </summary>
  3989. <returns>
  3990. true if all task parameters are valid; otherwise, false.
  3991. </returns>
  3992. </member>
  3993. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.LogEventsFromTextOutput(System.String,Microsoft.Build.Framework.MessageImportance)">
  3994. <summary>
  3995. Logs the events from text output.
  3996. </summary>
  3997. <param name="singleLine">The single line.</param>
  3998. <param name="messageImportance">The message importance.</param>
  3999. </member>
  4000. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.GenerateFullPathToTool">
  4001. <summary>
  4002. Returns the fully qualified path to the executable file.
  4003. </summary>
  4004. <returns>
  4005. The fully qualified path to the executable file.
  4006. </returns>
  4007. </member>
  4008. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.FindToolPath(System.String)">
  4009. <summary>
  4010. Finds the tool path.
  4011. </summary>
  4012. <param name="toolName">Name of the tool.</param>
  4013. <returns></returns>
  4014. </member>
  4015. <member name="M:MSBuild.Community.Tasks.Subversion.SvnClient.LogToolCommand(System.String)">
  4016. <summary>
  4017. Logs the starting point of the run to all registered loggers.
  4018. </summary>
  4019. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  4020. </member>
  4021. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Command">
  4022. <summary>
  4023. Gets or sets the command.
  4024. </summary>
  4025. <value>The command.</value>
  4026. </member>
  4027. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Arguments">
  4028. <summary>
  4029. Gets or sets the arguments.
  4030. </summary>
  4031. <value>The arguments.</value>
  4032. </member>
  4033. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Username">
  4034. <summary>
  4035. Gets or sets the username.
  4036. </summary>
  4037. <value>The username.</value>
  4038. </member>
  4039. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Password">
  4040. <summary>
  4041. Gets or sets the password.
  4042. </summary>
  4043. <value>The password.</value>
  4044. </member>
  4045. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Verbose">
  4046. <summary>
  4047. Gets or sets the verbose.
  4048. </summary>
  4049. <value>The verbose.</value>
  4050. </member>
  4051. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Force">
  4052. <summary>
  4053. Gets or sets the force.
  4054. </summary>
  4055. <value>The force.</value>
  4056. </member>
  4057. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Message">
  4058. <summary>
  4059. Gets or sets the message.
  4060. </summary>
  4061. <value>The message.</value>
  4062. </member>
  4063. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.MessageFile">
  4064. <summary>
  4065. Gets or sets the message file.
  4066. </summary>
  4067. <value>The message file.</value>
  4068. <remarks>
  4069. Uses the contents of the named file for the specified
  4070. subcommand, though different subcommands do different
  4071. things with this content.</remarks>
  4072. </member>
  4073. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.RepositoryPath">
  4074. <summary>
  4075. Gets or sets the repository path.
  4076. </summary>
  4077. <value>The repository path.</value>
  4078. </member>
  4079. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.LocalPath">
  4080. <summary>
  4081. Gets or sets the local path.
  4082. </summary>
  4083. <value>The local path.</value>
  4084. </member>
  4085. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.TargetFile">
  4086. <summary>
  4087. Gets or sets the target file.
  4088. </summary>
  4089. <value>The target file.</value>
  4090. <remarks>
  4091. Tells Subversion to get the list of files that you wish to operate on from
  4092. the filename that you provide instead of listing all the files on the command line.
  4093. </remarks>
  4094. </member>
  4095. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Targets">
  4096. <summary>
  4097. Gets or sets the targets.
  4098. </summary>
  4099. <value>The targets.</value>
  4100. </member>
  4101. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.NonInteractive">
  4102. <summary>
  4103. Gets or sets a value indicating the command is non interactive].
  4104. </summary>
  4105. <value><c>true</c> if non interactive; otherwise, <c>false</c>.</value>
  4106. </member>
  4107. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.NoAuthCache">
  4108. <summary>
  4109. Gets or sets a value indicating no auth cache.
  4110. </summary>
  4111. <value><c>true</c> if no auth cache; otherwise, <c>false</c>.</value>
  4112. </member>
  4113. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.TrustServerCert">
  4114. <summary>
  4115. Gets or sets a value indicating whether to trust the server cert.
  4116. </summary>
  4117. <value><c>true</c> to trust the server cert; otherwise, <c>false</c>.</value>
  4118. </member>
  4119. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Xml">
  4120. <summary>
  4121. Gets or sets a value indicating the output is XML.
  4122. </summary>
  4123. <value><c>true</c> to output in XML; otherwise, <c>false</c>.</value>
  4124. </member>
  4125. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.Revision">
  4126. <summary>
  4127. Gets or sets the revision.
  4128. </summary>
  4129. <value>The revision.</value>
  4130. </member>
  4131. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.StandardOutput">
  4132. <summary>
  4133. Gets the output of SVN command-line client.
  4134. </summary>
  4135. </member>
  4136. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.StandardError">
  4137. <summary>
  4138. Gets the error output of SVN command-line client.
  4139. </summary>
  4140. </member>
  4141. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.StandardOutputLoggingImportance">
  4142. <summary>
  4143. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  4144. </summary>
  4145. <value></value>
  4146. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  4147. </member>
  4148. <member name="P:MSBuild.Community.Tasks.Subversion.SvnClient.ToolName">
  4149. <summary>
  4150. Gets the name of the executable file to run.
  4151. </summary>
  4152. <value></value>
  4153. <returns>The name of the executable file to run.</returns>
  4154. </member>
  4155. <member name="M:MSBuild.Community.Tasks.Subversion.SvnCopy.#ctor">
  4156. <summary>
  4157. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Subversion.SvnCopy"/> class.
  4158. </summary>
  4159. </member>
  4160. <member name="M:MSBuild.Community.Tasks.Subversion.SvnCopy.GenerateSvnCommand">
  4161. <summary>
  4162. Generates the SVN command.
  4163. </summary>
  4164. <returns></returns>
  4165. </member>
  4166. <member name="M:MSBuild.Community.Tasks.Subversion.SvnCopy.ValidateParameters">
  4167. <summary>
  4168. Indicates whether all task paratmeters are valid.
  4169. </summary>
  4170. <returns>
  4171. true if all task parameters are valid; otherwise, false.
  4172. </returns>
  4173. </member>
  4174. <member name="P:MSBuild.Community.Tasks.Subversion.SvnCopy.SourcePath">
  4175. <summary>
  4176. The path of the source file or folder that should be copied
  4177. </summary>
  4178. </member>
  4179. <member name="P:MSBuild.Community.Tasks.Subversion.SvnCopy.DestinationPath">
  4180. <summary>
  4181. The path to which the SourcePath should be copied
  4182. </summary>
  4183. </member>
  4184. <member name="T:MSBuild.Community.Tasks.Subversion.Info">
  4185. <remarks/>
  4186. </member>
  4187. <member name="M:MSBuild.Community.Tasks.Subversion.Info.#ctor">
  4188. <remarks/>
  4189. </member>
  4190. <member name="P:MSBuild.Community.Tasks.Subversion.Info.Entries">
  4191. <remarks/>
  4192. </member>
  4193. <member name="T:MSBuild.Community.Tasks.Subversion.Entry">
  4194. <remarks/>
  4195. </member>
  4196. <member name="M:MSBuild.Community.Tasks.Subversion.Entry.#ctor">
  4197. <remarks/>
  4198. </member>
  4199. <member name="P:MSBuild.Community.Tasks.Subversion.Entry.Url">
  4200. <remarks/>
  4201. </member>
  4202. <member name="P:MSBuild.Community.Tasks.Subversion.Entry.Repository">
  4203. <remarks/>
  4204. </member>
  4205. <member name="P:MSBuild.Community.Tasks.Subversion.Entry.WorkingCopy">
  4206. <remarks/>
  4207. </member>
  4208. <member name="P:MSBuild.Community.Tasks.Subversion.Entry.Commit">
  4209. <remarks/>
  4210. </member>
  4211. <member name="P:MSBuild.Community.Tasks.Subversion.Entry.Kind">
  4212. <remarks/>
  4213. </member>
  4214. <member name="P:MSBuild.Community.Tasks.Subversion.Entry.Path">
  4215. <remarks/>
  4216. </member>
  4217. <member name="P:MSBuild.Community.Tasks.Subversion.Entry.Revision">
  4218. <remarks/>
  4219. </member>
  4220. <member name="T:MSBuild.Community.Tasks.Subversion.EntryCollection">
  4221. <remarks/>
  4222. </member>
  4223. <member name="M:MSBuild.Community.Tasks.Subversion.EntryCollection.#ctor">
  4224. <remarks/>
  4225. </member>
  4226. <member name="M:MSBuild.Community.Tasks.Subversion.EntryCollection.GetKeyForItem(MSBuild.Community.Tasks.Subversion.Entry)">
  4227. <remarks/>
  4228. </member>
  4229. <member name="T:MSBuild.Community.Tasks.Subversion.Repository">
  4230. <remarks/>
  4231. </member>
  4232. <member name="P:MSBuild.Community.Tasks.Subversion.Repository.Root">
  4233. <remarks/>
  4234. </member>
  4235. <member name="P:MSBuild.Community.Tasks.Subversion.Repository.Uuid">
  4236. <remarks/>
  4237. </member>
  4238. <member name="T:MSBuild.Community.Tasks.Subversion.WorkingCopy">
  4239. <remarks/>
  4240. </member>
  4241. <member name="P:MSBuild.Community.Tasks.Subversion.WorkingCopy.Schedule">
  4242. <remarks/>
  4243. </member>
  4244. <member name="P:MSBuild.Community.Tasks.Subversion.WorkingCopy.Depth">
  4245. <remarks/>
  4246. </member>
  4247. <member name="P:MSBuild.Community.Tasks.Subversion.WorkingCopy.TextUpdated">
  4248. <remarks/>
  4249. </member>
  4250. <member name="P:MSBuild.Community.Tasks.Subversion.WorkingCopy.TextUpdatedSpecified">
  4251. <remarks/>
  4252. </member>
  4253. <member name="P:MSBuild.Community.Tasks.Subversion.WorkingCopy.Checksum">
  4254. <remarks/>
  4255. </member>
  4256. <member name="T:MSBuild.Community.Tasks.Subversion.LastCommit">
  4257. <remarks/>
  4258. </member>
  4259. <member name="P:MSBuild.Community.Tasks.Subversion.LastCommit.Author">
  4260. <remarks/>
  4261. </member>
  4262. <member name="P:MSBuild.Community.Tasks.Subversion.LastCommit.Date">
  4263. <remarks/>
  4264. </member>
  4265. <member name="P:MSBuild.Community.Tasks.Subversion.LastCommit.DateSpecified">
  4266. <remarks/>
  4267. </member>
  4268. <member name="P:MSBuild.Community.Tasks.Subversion.LastCommit.Revision">
  4269. <remarks/>
  4270. </member>
  4271. <member name="T:MSBuild.Community.Tasks.Subversion.SvnStatus">
  4272. <summary>
  4273. Subversion status command.
  4274. </summary>
  4275. </member>
  4276. <member name="M:MSBuild.Community.Tasks.Subversion.SvnStatus.#ctor">
  4277. <summary>
  4278. Creates an instance of SvnStatus.
  4279. </summary>
  4280. </member>
  4281. <member name="M:MSBuild.Community.Tasks.Subversion.SvnStatus.Execute">
  4282. <summary>
  4283. Runs the exectuable file with the specified task parameters.
  4284. </summary>
  4285. <returns>
  4286. true if the task runs successfully; otherwise, false.
  4287. </returns>
  4288. </member>
  4289. <member name="P:MSBuild.Community.Tasks.Subversion.SvnStatus.Entries">
  4290. <summary>
  4291. Gets or sets the entries.
  4292. </summary>
  4293. </member>
  4294. <member name="T:MSBuild.Community.Tasks.SymbolServer.SymStoreCommands">
  4295. <summary>
  4296. Commands for the SymStore tasks.
  4297. </summary>
  4298. </member>
  4299. <member name="F:MSBuild.Community.Tasks.SymbolServer.SymStoreCommands.add">
  4300. <summary>
  4301. Add to the symbol server store.
  4302. </summary>
  4303. </member>
  4304. <member name="F:MSBuild.Community.Tasks.SymbolServer.SymStoreCommands.query">
  4305. <summary>
  4306. Query the symbol server store.
  4307. </summary>
  4308. </member>
  4309. <member name="F:MSBuild.Community.Tasks.SymbolServer.SymStoreCommands.delete">
  4310. <summary>
  4311. Delete from the symbol serer store.
  4312. </summary>
  4313. </member>
  4314. <member name="T:MSBuild.Community.Tasks.SymbolServer.SymStore">
  4315. <summary>
  4316. Task that wraps the Symbol Server SymStore.exe application.
  4317. </summary>
  4318. </member>
  4319. <member name="M:MSBuild.Community.Tasks.SymbolServer.SymStore.#ctor">
  4320. <summary>
  4321. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.SymbolServer.SymStore"/> class.
  4322. </summary>
  4323. </member>
  4324. <member name="M:MSBuild.Community.Tasks.SymbolServer.SymStore.GenerateCommandLineCommands">
  4325. <summary>
  4326. Returns a string value containing the command line arguments to pass directly to the executable file.
  4327. </summary>
  4328. <returns>
  4329. A string value containing the command line arguments to pass directly to the executable file.
  4330. </returns>
  4331. </member>
  4332. <member name="M:MSBuild.Community.Tasks.SymbolServer.SymStore.GenerateFullPathToTool">
  4333. <summary>
  4334. Returns the fully qualified path to the executable file.
  4335. </summary>
  4336. <returns>
  4337. The fully qualified path to the executable file.
  4338. </returns>
  4339. </member>
  4340. <member name="M:MSBuild.Community.Tasks.SymbolServer.SymStore.LogToolCommand(System.String)">
  4341. <summary>
  4342. Logs the starting point of the run to all registered loggers.
  4343. </summary>
  4344. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  4345. </member>
  4346. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Command">
  4347. <summary>
  4348. Gets or sets the command.
  4349. </summary>
  4350. <value>The command.</value>
  4351. <enum cref="T:MSBuild.Community.Tasks.SymbolServer.SymStoreCommands"/>
  4352. </member>
  4353. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Append">
  4354. <summary>
  4355. Gets or sets a value indicating SymStore will append new indexing information to an existing index file.
  4356. </summary>
  4357. <value><c>true</c> if append; otherwise, <c>false</c>.</value>
  4358. </member>
  4359. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Comment">
  4360. <summary>
  4361. Gets or sets the comment for the transaction.
  4362. </summary>
  4363. <value>The comment for the transaction.</value>
  4364. </member>
  4365. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Compress">
  4366. <summary>
  4367. Gets or sets a value indicating SymStore will create a compressed version of each file copied to the symbol store instead of using an uncompressed copy of the file.
  4368. </summary>
  4369. <value><c>true</c> if compress; otherwise, <c>false</c>.</value>
  4370. </member>
  4371. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.LogFile">
  4372. <summary>
  4373. Gets or sets a log file to be used for command output. If this is not included, transaction information and other output is sent to stdout.
  4374. </summary>
  4375. <value>The log file to be used for command output.</value>
  4376. </member>
  4377. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Files">
  4378. <summary>
  4379. Gets or sets the network path of files or directories to add.
  4380. </summary>
  4381. <value>The network path of files or directories to add.</value>
  4382. </member>
  4383. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Share">
  4384. <summary>
  4385. Gets or sets the server and share where the symbol files were originally stored.
  4386. </summary>
  4387. <value>The server and share where the symbol files were originally stored.</value>
  4388. </member>
  4389. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.ID">
  4390. <summary>
  4391. Gets or sets the transaction ID string.
  4392. </summary>
  4393. <value>The transaction ID string.</value>
  4394. </member>
  4395. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Local">
  4396. <summary>
  4397. Gets or sets a value indicating whether the file will be in a local directory rather than a network path.
  4398. </summary>
  4399. <value><c>true</c> if local; otherwise, <c>false</c>.</value>
  4400. </member>
  4401. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Verbose">
  4402. <summary>
  4403. Gets or sets a value indicating whether SymStore will display verbose output.
  4404. </summary>
  4405. <value><c>true</c> if verbose; otherwise, <c>false</c>.</value>
  4406. </member>
  4407. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Pointer">
  4408. <summary>
  4409. Gets or sets a value indicating whether SymStore will store a pointer to the file, rather than the file itself.
  4410. </summary>
  4411. <value><c>true</c> if pointer; otherwise, <c>false</c>.</value>
  4412. </member>
  4413. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Recursive">
  4414. <summary>
  4415. Gets or sets a value indicating whether SymStore will add files or directories recursively.
  4416. </summary>
  4417. <value><c>true</c> if recursive; otherwise, <c>false</c>.</value>
  4418. </member>
  4419. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Store">
  4420. <summary>
  4421. Gets or sets the root directory for the symbol store.
  4422. </summary>
  4423. <value>The root directory for the symbol store.</value>
  4424. </member>
  4425. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Product">
  4426. <summary>
  4427. Gets or sets the name of the product.
  4428. </summary>
  4429. <value>The name of the product.</value>
  4430. </member>
  4431. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Version">
  4432. <summary>
  4433. Gets or sets the version of the product.
  4434. </summary>
  4435. <value>The version of the product.</value>
  4436. </member>
  4437. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Message">
  4438. <summary>
  4439. Gets or sets the message to be added to each file.
  4440. </summary>
  4441. <value>The message to be added to each file.</value>
  4442. </member>
  4443. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.Relative">
  4444. <summary>
  4445. Gets or sets a value indicating whether the paths in the file pointers will be relative.
  4446. </summary>
  4447. <value><c>true</c> if relative; otherwise, <c>false</c>.</value>
  4448. </member>
  4449. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.NoReference">
  4450. <summary>
  4451. Gets or sets a value indicating whether to omit the creation of reference pointer files for the files and pointers being stored.
  4452. </summary>
  4453. <value><c>true</c> to omit the creation of reference pointer; otherwise, <c>false</c>.</value>
  4454. </member>
  4455. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.WriteIndex">
  4456. <summary>
  4457. Gets or sets the index file. Causes SymStore not to store the actual symbol files. Instead, SymStore records information in the IndexFile that will enable SymStore to access the symbol files at a later time.
  4458. </summary>
  4459. <value>The write index file.</value>
  4460. </member>
  4461. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.ReadIndex">
  4462. <summary>
  4463. Gets or sets the index file. Causes SymStore to read the data from a file created with WriteIndexFile.
  4464. </summary>
  4465. <value>The read index file.</value>
  4466. </member>
  4467. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.ToolName">
  4468. <summary>
  4469. Gets the name of the executable file to run.
  4470. </summary>
  4471. <value></value>
  4472. <returns>
  4473. The name of the executable file to run.
  4474. </returns>
  4475. </member>
  4476. <member name="P:MSBuild.Community.Tasks.SymbolServer.SymStore.StandardOutputLoggingImportance">
  4477. <summary>
  4478. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  4479. </summary>
  4480. <value></value>
  4481. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  4482. </member>
  4483. <member name="T:MSBuild.Community.Tasks.Tfs.TfsClient">
  4484. <summary>
  4485. A task for Team Foundation Server version control.
  4486. </summary>
  4487. </member>
  4488. <member name="M:MSBuild.Community.Tasks.Tfs.TfsClient.GenerateCommand(Microsoft.Build.Utilities.CommandLineBuilder)">
  4489. <summary>
  4490. Generates the command.
  4491. </summary>
  4492. <param name="builder">The <see cref="T:Microsoft.Build.Utilities.CommandLineBuilder"/>.</param>
  4493. </member>
  4494. <member name="M:MSBuild.Community.Tasks.Tfs.TfsClient.GenerateArguments(Microsoft.Build.Utilities.CommandLineBuilder)">
  4495. <summary>
  4496. Generates the arguments.
  4497. </summary>
  4498. <param name="builder">The <see cref="T:Microsoft.Build.Utilities.CommandLineBuilder"/>.</param>
  4499. </member>
  4500. <member name="M:MSBuild.Community.Tasks.Tfs.TfsClient.GenerateFullPathToTool">
  4501. <summary>
  4502. Returns the fully qualified path to the executable file.
  4503. </summary>
  4504. <returns>
  4505. The fully qualified path to the executable file.
  4506. </returns>
  4507. </member>
  4508. <member name="M:MSBuild.Community.Tasks.Tfs.TfsClient.LogToolCommand(System.String)">
  4509. <summary>
  4510. Logs the starting point of the run to all registered loggers.
  4511. </summary>
  4512. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  4513. </member>
  4514. <member name="M:MSBuild.Community.Tasks.Tfs.TfsClient.GenerateCommandLineCommands">
  4515. <summary>
  4516. Returns a string value containing the command line arguments to pass directly to the executable file.
  4517. </summary>
  4518. <returns>
  4519. A string value containing the command line arguments to pass directly to the executable file.
  4520. </returns>
  4521. </member>
  4522. <member name="M:MSBuild.Community.Tasks.Tfs.TfsClient.LogEventsFromTextOutput(System.String,Microsoft.Build.Framework.MessageImportance)">
  4523. <summary>
  4524. Parses a single line of text to identify any errors or warnings in canonical format.
  4525. </summary>
  4526. <param name="singleLine">A single line of text for the method to parse.</param>
  4527. <param name="messageImportance">A value of <see cref="T:Microsoft.Build.Framework.MessageImportance"/> that indicates the importance level with which to log the message.</param>
  4528. </member>
  4529. <member name="M:MSBuild.Community.Tasks.Tfs.TfsClient.ValidateParameters">
  4530. <summary>
  4531. Indicates whether all task paratmeters are valid.
  4532. </summary>
  4533. <returns>
  4534. true if all task parameters are valid; otherwise, false.
  4535. </returns>
  4536. </member>
  4537. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Command">
  4538. <summary>
  4539. Gets or sets the Team Foundation Server command.
  4540. </summary>
  4541. </member>
  4542. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Files">
  4543. <summary>
  4544. Gets or sets the files.
  4545. </summary>
  4546. </member>
  4547. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Recursive">
  4548. <summary>
  4549. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is recursive.
  4550. </summary>
  4551. <value>
  4552. <c>true</c> if recursive; otherwise, <c>false</c>.
  4553. </value>
  4554. </member>
  4555. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.All">
  4556. <summary>
  4557. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is all.
  4558. </summary>
  4559. <value>
  4560. <c>true</c> if all; otherwise, <c>false</c>.
  4561. </value>
  4562. </member>
  4563. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Overwrite">
  4564. <summary>
  4565. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is overwrite.
  4566. </summary>
  4567. <value>
  4568. <c>true</c> if overwrite; otherwise, <c>false</c>.
  4569. </value>
  4570. </member>
  4571. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Override">
  4572. <summary>
  4573. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is override.
  4574. </summary>
  4575. <value>
  4576. <c>true</c> if override; otherwise, <c>false</c>.
  4577. </value>
  4578. </member>
  4579. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Force">
  4580. <summary>
  4581. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is force.
  4582. </summary>
  4583. <value>
  4584. <c>true</c> if force; otherwise, <c>false</c>.
  4585. </value>
  4586. </member>
  4587. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Preview">
  4588. <summary>
  4589. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is preview.
  4590. </summary>
  4591. <value>
  4592. <c>true</c> if preview; otherwise, <c>false</c>.
  4593. </value>
  4594. </member>
  4595. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Remap">
  4596. <summary>
  4597. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is remap.
  4598. </summary>
  4599. <value>
  4600. <c>true</c> if remap; otherwise, <c>false</c>.
  4601. </value>
  4602. </member>
  4603. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Silent">
  4604. <summary>
  4605. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is silent.
  4606. </summary>
  4607. <value>
  4608. <c>true</c> if silent; otherwise, <c>false</c>.
  4609. </value>
  4610. </member>
  4611. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Saved">
  4612. <summary>
  4613. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is saved.
  4614. </summary>
  4615. <value>
  4616. <c>true</c> if saved; otherwise, <c>false</c>.
  4617. </value>
  4618. </member>
  4619. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Validate">
  4620. <summary>
  4621. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is validate.
  4622. </summary>
  4623. <value>
  4624. <c>true</c> if validate; otherwise, <c>false</c>.
  4625. </value>
  4626. </member>
  4627. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Bypass">
  4628. <summary>
  4629. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Tfs.TfsClient"/> is bypass.
  4630. </summary>
  4631. <value>
  4632. <c>true</c> if bypass; otherwise, <c>false</c>.
  4633. </value>
  4634. </member>
  4635. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Comment">
  4636. <summary>
  4637. Gets or sets the comment.
  4638. </summary>
  4639. </member>
  4640. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Version">
  4641. <summary>
  4642. Gets or sets the version.
  4643. </summary>
  4644. </member>
  4645. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Lock">
  4646. <summary>
  4647. Gets or sets the lock.
  4648. </summary>
  4649. </member>
  4650. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Type">
  4651. <summary>
  4652. Gets or sets the type.
  4653. </summary>
  4654. </member>
  4655. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Author">
  4656. <summary>
  4657. Gets or sets the author.
  4658. </summary>
  4659. </member>
  4660. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Notes">
  4661. <summary>
  4662. Gets or sets the notes.
  4663. </summary>
  4664. </member>
  4665. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Format">
  4666. <summary>
  4667. Gets or sets the format.
  4668. </summary>
  4669. </member>
  4670. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Collection">
  4671. <summary>
  4672. Gets or sets the collection.
  4673. </summary>
  4674. </member>
  4675. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.UserName">
  4676. <summary>
  4677. Gets or sets the name of the user.
  4678. </summary>
  4679. </member>
  4680. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Password">
  4681. <summary>
  4682. Gets or sets the password.
  4683. </summary>
  4684. </member>
  4685. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.WorkspaceName">
  4686. <summary>
  4687. Gets or sets the name of the workspace.
  4688. </summary>
  4689. </member>
  4690. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.WorkspaceOwner">
  4691. <summary>
  4692. Gets or sets the workspace owner.
  4693. </summary>
  4694. </member>
  4695. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.ShelveSetName">
  4696. <summary>
  4697. Gets or sets the name of the shelve set.
  4698. </summary>
  4699. </member>
  4700. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.ShelveSetOwner">
  4701. <summary>
  4702. Gets or sets the shelve set owner.
  4703. </summary>
  4704. </member>
  4705. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.Changeset">
  4706. <summary>
  4707. Gets or sets the changeset.
  4708. </summary>
  4709. </member>
  4710. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.ServerPath">
  4711. <summary>
  4712. Gets or sets the server path.
  4713. </summary>
  4714. </member>
  4715. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.StandardOutputLoggingImportance">
  4716. <summary>
  4717. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  4718. </summary>
  4719. <value></value>
  4720. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  4721. </member>
  4722. <member name="P:MSBuild.Community.Tasks.Tfs.TfsClient.ToolName">
  4723. <summary>
  4724. Gets the name of the executable file to run.
  4725. </summary>
  4726. <returns>
  4727. The name of the executable file to run.
  4728. </returns>
  4729. </member>
  4730. <member name="T:MSBuild.Community.Tasks.Services.IRegistry">
  4731. <summary>
  4732. The contract for a service that will provide access to the registry.
  4733. </summary>
  4734. <exclude />
  4735. </member>
  4736. <member name="M:MSBuild.Community.Tasks.Services.IRegistry.GetSubKeys(Microsoft.Win32.RegistryHive,System.String)">
  4737. <summary>
  4738. Returns the names of the subkeys under the provided key.
  4739. </summary>
  4740. <param name="hive">The hive where <paramref name="key"/> is located.</param>
  4741. <param name="key">The key to search.</param>
  4742. <returns>A list of subkeys.</returns>
  4743. </member>
  4744. <member name="M:MSBuild.Community.Tasks.Services.IRegistry.GetValue(System.String,System.String)">
  4745. <summary>
  4746. Returns the value of an entry in the registry.
  4747. </summary>
  4748. <param name="key">The key of the registry entry that contains <paramref name="valueName"/></param>
  4749. <param name="valueName">The name of the value to return.</param>
  4750. <returns>The value of the registry entry.</returns>
  4751. </member>
  4752. <member name="T:MSBuild.Community.Tasks.Services.Win32Registry">
  4753. <summary>
  4754. Provides access to the Windows registry.
  4755. </summary>
  4756. <exclude />
  4757. </member>
  4758. <member name="M:MSBuild.Community.Tasks.Services.Win32Registry.GetSubKeys(Microsoft.Win32.RegistryHive,System.String)">
  4759. <summary>
  4760. Returns the names of the subkeys under the provided key.
  4761. </summary>
  4762. <param name="hive">The hive where <paramref name="key"/> is located.</param>
  4763. <param name="key">The key to search.</param>
  4764. <returns>A list of subkeys.</returns>
  4765. </member>
  4766. <member name="M:MSBuild.Community.Tasks.Services.Win32Registry.GetValue(System.String,System.String)">
  4767. <summary>
  4768. Returns the value of an entry in the registry.
  4769. </summary>
  4770. <param name="key">The key of the registry entry that contains <paramref name="valueName"/></param>
  4771. <param name="valueName">The name of the value to return.</param>
  4772. <returns>The value of the registry entry.</returns>
  4773. </member>
  4774. <member name="T:MSBuild.Community.Tasks.User">
  4775. <summary>
  4776. Provides information about the build user.
  4777. </summary>
  4778. <example>Get build user information.
  4779. <code><![CDATA[
  4780. <User>
  4781. <Output TaskParameter="UserNameWithDomain" PropertyName="BuildUserID" />
  4782. <Output TaskParameter="FullName" PropertyName="BuildUserName" />
  4783. <Output TaskParameter="Email" PropertyName="BuildUserEmail" />
  4784. <Output TaskParameter="Phone" PropertyName="BuildUserPhone" />
  4785. </User>
  4786. ]]></code>
  4787. </example>
  4788. <remarks>
  4789. The following output parameters are set only if information about the build user can be retrieved
  4790. from the Active Directory if one exists:
  4791. <list type="bullet">
  4792. <item><c>FirstName</c></item>
  4793. <item><c>LastName</c></item>
  4794. <item><c>MiddleInitial</c></item>
  4795. <item><c>FullName</c></item>
  4796. <item><c>Email</c></item>
  4797. <item><c>Phone</c></item>
  4798. </list>
  4799. </remarks>
  4800. </member>
  4801. <member name="M:MSBuild.Community.Tasks.User.#ctor">
  4802. <summary>
  4803. Initializes a new instance of the <see cref="T:User"/> class.
  4804. </summary>
  4805. </member>
  4806. <member name="M:MSBuild.Community.Tasks.User.Execute">
  4807. <summary>
  4808. Executes the task.
  4809. </summary>
  4810. <returns>
  4811. <see langword="true"/> if the task ran successfully; otherwise <see langword="false"/>.
  4812. </returns>
  4813. </member>
  4814. <member name="P:MSBuild.Community.Tasks.User.UserName">
  4815. <summary>
  4816. Gets the user name of the build user.
  4817. </summary>
  4818. </member>
  4819. <member name="P:MSBuild.Community.Tasks.User.DomainName">
  4820. <summary>
  4821. Gets the domain name of the build user.
  4822. </summary>
  4823. </member>
  4824. <member name="P:MSBuild.Community.Tasks.User.FirstName">
  4825. <summary>
  4826. Gets the first name of the build user.
  4827. </summary>
  4828. </member>
  4829. <member name="P:MSBuild.Community.Tasks.User.LastName">
  4830. <summary>
  4831. Gets the last name of the build user.
  4832. </summary>
  4833. </member>
  4834. <member name="P:MSBuild.Community.Tasks.User.MiddleInitial">
  4835. <summary>
  4836. Gets the middle initial of the build user.
  4837. </summary>
  4838. </member>
  4839. <member name="P:MSBuild.Community.Tasks.User.Email">
  4840. <summary>
  4841. Gets the email address of the build user.
  4842. </summary>
  4843. </member>
  4844. <member name="P:MSBuild.Community.Tasks.User.Phone">
  4845. <summary>
  4846. Gets the phone number of the build user.
  4847. </summary>
  4848. </member>
  4849. <member name="P:MSBuild.Community.Tasks.User.UserNameWithDomain">
  4850. <summary>
  4851. Gets the username and domain name of the build user in "[Domain name]\[User name]" format.
  4852. </summary>
  4853. </member>
  4854. <member name="P:MSBuild.Community.Tasks.User.FullName">
  4855. <summary>
  4856. Gets the full name of the build user in "[First name] [Middle initial]. [Last name]" format .
  4857. </summary>
  4858. </member>
  4859. <member name="T:MSBuild.Community.Tasks.Xml.XmlMassUpdate">
  4860. <summary>
  4861. Performs multiple updates on an XML file
  4862. </summary>
  4863. <remarks>
  4864. XmlMassUpdate allows to to specify multiple changes to make to an XML file (the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentFile"/>. By default, the changes are applied to the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentFile"/>, but you can create a new file by providing the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.MergedFile"/> attribute. The change instructions are specified using XML in the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsFile"/>. If the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsFile"/> does not mirror the structure of the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentFile"/> exactly, you can specify the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentRoot"/> and <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsRoot"/> XPath expressions which determine how the files should be mapped to each other.
  4865. <para>
  4866. Any element within the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsRoot"/> will find the corresponding element in the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentRoot"/>. If it does not exist, it will be created with all of its attributes. If it does exist, the attributes will be added or updated as specified.
  4867. </para>
  4868. <para>
  4869. Any attribute declared within the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.UpdateControlNamespace"/> will not be copied to the modified file. Valid attributes are <c>key</c> and <c>action</c>. The <c>key</c> attribute allows you to define an attribute to use as the identifying attribute when you only want to update a single element, and multiple elements with the same name exist. You can also use the <c>action="remove"</c> attribute to specify that an element should be deleted instead of updated.
  4870. </para>
  4871. </remarks><example>
  4872. <para>
  4873. These examples will demonstrate how to make multiple updates to a XML file named web.config. It looks like:
  4874. <code>
  4875. <![CDATA[<?xml version="1.0" encoding="utf-8" ?>
  4876. <configuration>
  4877. <appSettings>
  4878. <add key="ItemsPerPage" value="10" />
  4879. <add key="EnableCaching" value="true" />
  4880. <add key="DefaultServer" value="TIGRIS" />
  4881. </appSettings>
  4882. <system.web>
  4883. <compilation defaultLanguage="c#" debug="true" />
  4884. <customErrors mode="Off" />
  4885. <trace enabled="true" requestLimit="10" pageOutput="true" />
  4886. <globalization requestEncoding="utf-8" responseEncoding="utf-8" />
  4887. </system.web>
  4888. </configuration> ]]>
  4889. </code>
  4890. </para>
  4891. </example><example>
  4892. You can update the file using instructions from an external file (specified as the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsFile"/>):
  4893. <code>
  4894. <![CDATA[<XmlMassUpdate ContentFile="web.config" SubstitutionsFile="changes.xml" ContentRoot="/configuration/system.web" SubstitutionsRoot="/system.web" /> ]]>
  4895. </code>
  4896. The <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsFile"/> is named changes.xml and contains:
  4897. <code>
  4898. <![CDATA[<system.web>
  4899. <compilation debug="false" />
  4900. <customErrors mode="RemoteOnly" defaultRedirect="Error.htm">
  4901. <error statusCode="401" redirect="AccessDenied.aspx" />
  4902. </customErrors>
  4903. <trace enabled="false" />
  4904. </system.web> ]]>
  4905. </code>
  4906. </example><example>
  4907. You can also provide the update instructions within the MSBuild project file itself. It takes advantage of the MSBuild ProjectExtensions element which allows you to add XML to a project file that will be ignored by the MSBuild engine. This example also demonstrates how to use <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.NamespaceDefinitions"/>:
  4908. <code>
  4909. <![CDATA[<ProjectExtensions>
  4910. <system.web>
  4911. <compilation debug="false" />
  4912. <trace enabled="false" />
  4913. </system.web>
  4914. </ProjectExtensions>
  4915. <Target Name="SubstituteFromProj">
  4916. <XmlMassUpdate ContentFile="web.config" ContentRoot="/configuration/system.web"
  4917. NamespaceDefinitions="msb=http://schemas.microsoft.com/developer/msbuild/2003"
  4918. SubstitutionsFile="$(MSBuildProjectFullPath)"
  4919. SubstitutionsRoot="/msb:Project/msb:ProjectExtensions/msb:system.web" />
  4920. </Target> ]]>
  4921. </code>
  4922. </example><example>
  4923. The following example demonstrates how to deal with "keyed" elements. When you need to update an element, and multiple elements exist with the same name, it must be be differentied by one of its attributes. You designate the differentiating attribute using the "key" attribute declared in the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.UpdateControlNamespace"/>.
  4924. If an element matching the keyed attribute is not found, a new element will be created (DefaultSort in the example). This example also demonstrates creating a new file with the merged changes instead of modifying the original file.
  4925. <code>
  4926. <![CDATA[ <XmlMassUpdate ContentFile="web.config" SubstitutionsFile="changes.xml" MergedFile="web.config.keyed.xml" /> ]]>
  4927. </code>
  4928. Using a changes.xml file with the following contents:
  4929. <code>
  4930. <![CDATA[<configuration xmlns:xmu="urn:msbuildcommunitytasks-xmlmassupdate">
  4931. <appSettings>
  4932. <add xmu:key="key" key="EnableCaching" value="false" />
  4933. <add xmu:key="key" key="DefaultSort" value="LastName" />
  4934. </appSettings>
  4935. </configuration> ]]>
  4936. </code>
  4937. </example><example>
  4938. Use a changes.xml file with the following contents to demonstrate how to remove an element from the updated file:
  4939. <code>
  4940. <![CDATA[<configuration xmlns:xmu="urn:msbuildcommunitytasks-xmlmassupdate">
  4941. <appSettings>
  4942. <add xmu:key="key" key="ItemsPerPage" xmu:action="remove" />
  4943. <trace xmu:action="remove" />
  4944. </appSettings>
  4945. </configuration> ]]>
  4946. </code>
  4947. </example><example>
  4948. You can also specify the changes to apply from within the target document. By making use of the <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsRoot"/> property, you can store multiple sets of changes to apply based on runtime conditions.
  4949. Consider the following source web.config file:
  4950. <code>
  4951. <![CDATA[<?xml version="1.0" encoding="utf-8" ?>
  4952. <configuration>
  4953. <system.web>
  4954. <compilation defaultLanguage="c#" debug="true" />
  4955. <customErrors mode="Off" />
  4956. <trace enabled="true" requestLimit="10" pageOutput="true" />
  4957. <globalization requestEncoding="utf-8" responseEncoding="utf-8" />
  4958. </system.web>
  4959. <substitutions>
  4960. <test>
  4961. <system.web>
  4962. <compilation debug="false" />
  4963. <trace enabled="true" />
  4964. </system.web>
  4965. </test>
  4966. <prod>
  4967. <system.web>
  4968. <compilation debug="false" />
  4969. <trace enabled="false" />
  4970. </system.web>
  4971. </prod>
  4972. </substitutions>
  4973. </configuration> ]]>
  4974. </code>
  4975. You could use the following task definition, which relies on a property "TargetEnvironment" to determine which set of changes to apply:
  4976. <code>
  4977. <![CDATA[ <XmlMassUpdate ContentFile="web.config" ContentRoot="/configuration" SubstitutionsRoot="/configuration/substitutions/$(TargetEnvironment)" /> ]]>
  4978. </code>
  4979. You will need to provide a value of "test" or "prod" to the TargetEnvironment property. The property can be defined in a PropertyGroup section of the MSBuild file, or passed as a command-line parameter.
  4980. <code>
  4981. <![CDATA[ msbuild build.proj /p:TargetEnvironment=prod ]]>
  4982. </code>
  4983. </example>
  4984. </member>
  4985. <member name="M:MSBuild.Community.Tasks.Xml.XmlMassUpdate.Execute">
  4986. <summary>
  4987. When overridden in a derived class, executes the task.
  4988. </summary>
  4989. <returns>
  4990. True if the task successfully executed; otherwise, false.
  4991. </returns>
  4992. </member>
  4993. <member name="M:MSBuild.Community.Tasks.Xml.XmlMassUpdate.LoadSubstitutionsDocument">
  4994. <summary>
  4995. Returns <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsFile"/> as an <see cref="T:System.Xml.XmlDocument"/>.
  4996. </summary>
  4997. <remarks>This method is not intended for use by consumers. It is exposed for testing purposes.</remarks>
  4998. <returns></returns>
  4999. <exclude/>
  5000. </member>
  5001. <member name="M:MSBuild.Community.Tasks.Xml.XmlMassUpdate.LoadContentDocument">
  5002. <summary>
  5003. Returns <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentFile"/> as an <see cref="T:System.Xml.XmlDocument"/>.
  5004. </summary>
  5005. <remarks>This method is not intended for use by consumers. It is exposed for testing purposes.</remarks>
  5006. <returns></returns>
  5007. <exclude/>
  5008. </member>
  5009. <member name="M:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SaveMergedDocument(System.Xml.XmlDocument)">
  5010. <summary>
  5011. Creates <see cref="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.MergedFile"/> from the specified <see cref="T:System.Xml.XmlDocument"/>
  5012. </summary>
  5013. <param name="mergedDocument">The XML to save to a file</param>
  5014. <remarks>This method is not intended for use by consumers. It is exposed for testing purposes.</remarks>
  5015. <returns></returns>
  5016. <exclude/>
  5017. </member>
  5018. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentFile">
  5019. <summary>
  5020. The original file whose content is to be updated
  5021. </summary>
  5022. <remarks>This task is currently under construction and not necessarily feature complete.</remarks>
  5023. </member>
  5024. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsFile">
  5025. <summary>
  5026. The file containing the list of updates to perform
  5027. </summary>
  5028. </member>
  5029. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.MergedFile">
  5030. <summary>
  5031. The file created after performing the updates
  5032. </summary>
  5033. </member>
  5034. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsRoot">
  5035. <summary>
  5036. The XPath expression used to locate the list of substitutions to perform
  5037. </summary>
  5038. <remarks>When not specified, the default is the document root: <c>/</c>
  5039. <para>When there is a set of elements with the same name, and you want to update
  5040. a single element which can be identified by one of its attributes, you need to include an attribute
  5041. named 'key' in the namespace <c>urn:msbuildcommunitytasks-xmlmassupdate</c>. The value of the
  5042. attribute is the name of the attribute that should be used as the unique identifier.</para></remarks>
  5043. </member>
  5044. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentRoot">
  5045. <summary>
  5046. The XPath expression identifying root node that substitions are relative to
  5047. </summary>
  5048. <remarks>When not specified, the default is the document root: <c>/</c></remarks>
  5049. </member>
  5050. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.NamespaceDefinitions">
  5051. <summary>
  5052. A collection of prefix=namespace definitions used to query the XML documents
  5053. </summary>
  5054. <example>
  5055. Defining multiple namespaces:
  5056. <code>
  5057. <![CDATA[
  5058. <XmlMassUpdate ContentFile="web.config"
  5059. SubstitutionsRoot="/configuration/substitutions"
  5060. NamespaceDefinitions = "soap=http://www.w3.org/2001/12/soap-envelope;x=http://www.w3.org/1999/XSL/Transform">
  5061. />]]>
  5062. </code>
  5063. </example>
  5064. </member>
  5065. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.ContentPathUsedByTask">
  5066. <summary>
  5067. The full path of the file containing content updated by the task
  5068. </summary>
  5069. </member>
  5070. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.SubstitutionsPathUsedByTask">
  5071. <summary>
  5072. The full path of the file containing substitutions used by the task
  5073. </summary>
  5074. </member>
  5075. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.MergedPathUsedByTask">
  5076. <summary>
  5077. The full path of the file containing the results of the task
  5078. </summary>
  5079. </member>
  5080. <member name="P:MSBuild.Community.Tasks.Xml.XmlMassUpdate.UpdateControlNamespace">
  5081. <summary>
  5082. The namespace used for XmlMassUpdate pre-defined attributes
  5083. </summary>
  5084. <remarks>Evaluates to: <c>urn:msbuildcommunitytasks-xmlmassupdate</c>
  5085. <para>Attributes decorated with this namespace are used to control how a substitutions element
  5086. or attribute is handled during the update. For example, the key attribute is used to identify the
  5087. attribute on an element that uniquely identifies the element in a set.</para></remarks>
  5088. </member>
  5089. <member name="T:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap">
  5090. <summary>
  5091. Sets an application mapping for a filename extension on an existing web directory.
  5092. </summary>
  5093. <example>Map the .axd extension to the lastest version of ASP.NET:
  5094. <code><![CDATA[
  5095. <WebDirectoryScriptMap VirtualDirectoryName="MyWeb" Extension=".axd" MapToAspNet="True" VerifyFileExists="False" />
  5096. ]]></code>
  5097. </example>
  5098. <example>Map GET requests to the .rss extension to a specific executable:
  5099. <code><![CDATA[
  5100. <WebDirectoryScriptMap VirtualDirectoryName="MyWeb" Extension=".rss" Verbs="GET" ExecutablePath="$(WINDIR)\Microsoft.Net\Framework\1.0.3705\aspnet_isapi.dll" />
  5101. ]]></code>
  5102. </example>
  5103. </member>
  5104. <member name="T:MSBuild.Community.Tasks.IIS.WebBase">
  5105. <summary>
  5106. Base task for any IIS-related task.
  5107. </summary>
  5108. <remarks>Stores the base logic for gathering the IIS version and server and port checking. This
  5109. base task also stores common properties for other related tasks.</remarks>
  5110. </member>
  5111. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.mIISVersion">
  5112. <summary>
  5113. IIS version.
  5114. </summary>
  5115. </member>
  5116. <member name="M:MSBuild.Community.Tasks.IIS.WebBase.GetIISVersion">
  5117. <summary>
  5118. Gets the IIS version.
  5119. </summary>
  5120. <returns>The <see cref="T:MSBuild.Community.Tasks.IIS.WebBase.IISVersion"/> for IIS.</returns>
  5121. <exclude/>
  5122. </member>
  5123. <member name="M:MSBuild.Community.Tasks.IIS.WebBase.GetRemoteOSVersion">
  5124. <summary>
  5125. Gets the remote machine OS version.
  5126. </summary>
  5127. <returns>Returns a <see cref="T:System.Version"/> of the operating system.</returns>
  5128. <exclude/>
  5129. </member>
  5130. <member name="M:MSBuild.Community.Tasks.IIS.WebBase.VerifyIISRoot">
  5131. <summary>
  5132. Verifies that the IIS root exists based on the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.ServerName"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.ServerPort"/>.
  5133. </summary>
  5134. <exclude/>
  5135. </member>
  5136. <member name="M:MSBuild.Community.Tasks.IIS.WebBase.VerifySiteHostHeaderExists(System.DirectoryServices.DirectoryEntry)">
  5137. <summary>
  5138. Verify that the IIS Website exists if it has been specified.
  5139. </summary>
  5140. <param name="site">DirectoryEntry that meets the IISWebServer schema</param>
  5141. <returns>True if a site is found when specified. True if no site has been specified.</returns>
  5142. </member>
  5143. <member name="M:MSBuild.Community.Tasks.IIS.WebBase.VerifyServerPortExists(System.DirectoryServices.DirectoryEntry)">
  5144. <summary>
  5145. Helper method for <see cref="M:MSBuild.Community.Tasks.IIS.WebBase.VerifyIISRoot"/> that verifies the server port exists.
  5146. </summary>
  5147. <param name="site">The site to verify the port.</param>
  5148. <returns>Boolean value indicating the status of the port check.</returns>
  5149. <exclude/>
  5150. </member>
  5151. <member name="M:MSBuild.Community.Tasks.IIS.WebBase.SetIISPrimitives(System.String)">
  5152. <summary>
  5153. Sets some of the protected properties for the Virtual Directory Creation Wizard.
  5154. </summary>
  5155. <param name="serverInstance">DirectoryEntry.Name where the Entry is an IISWebServer schema</param>
  5156. </member>
  5157. <member name="P:MSBuild.Community.Tasks.IIS.WebBase.ServerName">
  5158. <summary>
  5159. Gets or sets the name of the server. The default value is 'localhost'.
  5160. </summary>
  5161. <value>The name of the server.</value>
  5162. </member>
  5163. <member name="P:MSBuild.Community.Tasks.IIS.WebBase.HostHeaderName">
  5164. <summary>
  5165. Gets or sets host header. Used when you have more than one website in IIS that have the same port but different host headers.
  5166. </summary>
  5167. <value>The name of the host header.</value>
  5168. </member>
  5169. <member name="P:MSBuild.Community.Tasks.IIS.WebBase.ServerPort">
  5170. <summary>
  5171. Gets or sets the server port.
  5172. </summary>
  5173. <value>The server port.</value>
  5174. </member>
  5175. <member name="P:MSBuild.Community.Tasks.IIS.WebBase.IISServerPath">
  5176. <summary>
  5177. Gets or sets the IIS server path.
  5178. </summary>
  5179. <remarks>Is in the form 'IIS://localhost/W3SVC/1/Root'.</remarks>
  5180. <value>The IIS server path.</value>
  5181. </member>
  5182. <member name="P:MSBuild.Community.Tasks.IIS.WebBase.IISApplicationPath">
  5183. <summary>
  5184. Gets or sets the application path.
  5185. </summary>
  5186. <remarks>Is in the form '/LM/W3SVC/1/Root'.</remarks>
  5187. <value>The application path.</value>
  5188. </member>
  5189. <member name="P:MSBuild.Community.Tasks.IIS.WebBase.IISAppPoolPath">
  5190. <summary>
  5191. Gets or sets the IIS application pool path.
  5192. </summary>
  5193. <remarks>Is in the form 'IIS://localhost/W3SVC/AppPools'.</remarks>
  5194. <value>The IIS application pool path.</value>
  5195. </member>
  5196. <member name="P:MSBuild.Community.Tasks.IIS.WebBase.Username">
  5197. <summary>
  5198. Gets or sets the username for the account the task will run under. This property
  5199. is needed if you specified a <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.ServerName"/> for a remote machine.
  5200. </summary>
  5201. <value>The username of the account.</value>
  5202. </member>
  5203. <member name="P:MSBuild.Community.Tasks.IIS.WebBase.Password">
  5204. <summary>
  5205. Gets or sets the password for the account the task will run under. This property
  5206. is needed if you specified a <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.ServerName"/> for a remote machine.
  5207. </summary>
  5208. <value>The password of the account.</value>
  5209. </member>
  5210. <member name="T:MSBuild.Community.Tasks.IIS.WebBase.IISVersion">
  5211. <summary>
  5212. Defines the possible IIS versions supported by the task.
  5213. </summary>
  5214. </member>
  5215. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.IISVersion.Four">
  5216. <summary>
  5217. IIS version 4.x
  5218. </summary>
  5219. </member>
  5220. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.IISVersion.Five">
  5221. <summary>
  5222. IIS version 5.x
  5223. </summary>
  5224. </member>
  5225. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.IISVersion.Six">
  5226. <summary>
  5227. IIS version 6.x
  5228. </summary>
  5229. </member>
  5230. <member name="T:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolAction">
  5231. <summary>
  5232. Defines the possible application pool actions to be performed.
  5233. </summary>
  5234. </member>
  5235. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolAction.Recycle">
  5236. <summary>
  5237. Recycles an application pool.
  5238. </summary>
  5239. </member>
  5240. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolAction.Restart">
  5241. <summary>
  5242. Stops and restarts the application pool.
  5243. </summary>
  5244. </member>
  5245. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolAction.Start">
  5246. <summary>
  5247. Starts the application pool.
  5248. </summary>
  5249. </member>
  5250. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolAction.Stop">
  5251. <summary>
  5252. Stops the application pool.
  5253. </summary>
  5254. </member>
  5255. <member name="T:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolState">
  5256. <summary>
  5257. Defines the current application pool state.
  5258. </summary>
  5259. </member>
  5260. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolState.Starting">
  5261. <summary>
  5262. The application pool is starting.
  5263. </summary>
  5264. </member>
  5265. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolState.Started">
  5266. <summary>
  5267. The application pool has started.
  5268. </summary>
  5269. </member>
  5270. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolState.Stopping">
  5271. <summary>
  5272. The application pool is stopping.
  5273. </summary>
  5274. </member>
  5275. <member name="F:MSBuild.Community.Tasks.IIS.WebBase.ApplicationPoolState.Stopped">
  5276. <summary>
  5277. The application pool has stopped.
  5278. </summary>
  5279. </member>
  5280. <member name="M:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.Execute">
  5281. <summary>
  5282. When overridden in a derived class, executes the task.
  5283. </summary>
  5284. <returns>
  5285. True if the task successfully executed; otherwise, false.
  5286. </returns>
  5287. </member>
  5288. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.VirtualDirectoryName">
  5289. <summary>
  5290. Gets or sets the name of the virtual directory.
  5291. </summary>
  5292. <value>The name of the virtual directory.</value>
  5293. </member>
  5294. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.Extension">
  5295. <summary>
  5296. The filename extension that will be mapped to an executable.
  5297. </summary>
  5298. </member>
  5299. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.ExecutablePath">
  5300. <summary>
  5301. The full path to the executable used to respond to requests for a Uri ending with <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.Extension"/>
  5302. </summary>
  5303. <remarks>This property is required when <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.MapToAspNet"/> is <c>false</c> (the default).</remarks>
  5304. </member>
  5305. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.MapToAspNet">
  5306. <summary>
  5307. Indicates whether <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.Extension"/> should be mapped to the ASP.NET runtime.
  5308. </summary>
  5309. <remarks>When <c>true</c>, <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.ExecutablePath"/> is set to aspnet_isapi.dll
  5310. in the installation folder of the latest version of the .NET Framework.</remarks>
  5311. </member>
  5312. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.Verbs">
  5313. <summary>
  5314. A comma-separated list of the HTTP verbs to include in the application mapping.
  5315. </summary>
  5316. <remarks>The default behavior (when this property is empty or unspecified) is to map all verbs.
  5317. <para>A semi-colon-separated list will also be recognized, allowing you to use an MSBuild Item.</para></remarks>
  5318. </member>
  5319. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.EnableScriptEngine">
  5320. <summary>
  5321. Set to <c>true</c> when you want the application to run in a directory without Execute permissions.
  5322. </summary>
  5323. </member>
  5324. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryScriptMap.VerifyFileExists">
  5325. <summary>
  5326. Set to <c>true</c> to instruct the Web server to verify the existence of the requested script file and to ensure that the requesting user has access permission for that script file.
  5327. </summary>
  5328. </member>
  5329. <member name="T:MSBuild.Community.Tasks.IIS.WebDirectorySetting">
  5330. <summary>
  5331. Reads and modifies a web directory configuration setting.
  5332. </summary>
  5333. <example>Display the file system path of the MyWeb web directory:
  5334. <code><![CDATA[
  5335. <WebDirectorySetting VirtualDirectoryName="MyWeb" SettingName="Path">
  5336. <Output TaskParameter="SettingValue" PropertyName="LocalPath" />
  5337. </WebDirectorySetting>
  5338. <Message Text="MyWeb is located at $(LocalPath)" />
  5339. ]]></code>
  5340. </example>
  5341. <example>Set the default document for the MyWeb directory to Default.aspx:
  5342. <code><![CDATA[
  5343. <WebDirectorySetting VirtualDirectoryName="MyWeb" SettingName="DefaultDoc" SettingValue="Default.aspx" />
  5344. <WebDirectorySetting VirtualDirectoryName="MyWeb" SettingName="EnableDefaultDoc" SettingValue="True" />
  5345. ]]></code>
  5346. </example>
  5347. </member>
  5348. <member name="M:MSBuild.Community.Tasks.IIS.WebDirectorySetting.Execute">
  5349. <summary>
  5350. When overridden in a derived class, executes the task.
  5351. </summary>
  5352. <returns>
  5353. True if the task successfully executed; otherwise, false.
  5354. </returns>
  5355. </member>
  5356. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectorySetting.VirtualDirectoryName">
  5357. <summary>
  5358. Gets or sets the name of the virtual directory.
  5359. </summary>
  5360. <value>The name of the virtual directory.</value>
  5361. </member>
  5362. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectorySetting.SettingName">
  5363. <summary>
  5364. Gets or sets the configuration setting to read or modify.
  5365. </summary>
  5366. </member>
  5367. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectorySetting.SettingValue">
  5368. <summary>
  5369. Gets or sets the value of <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectorySetting.SettingName"/> on the web directory
  5370. </summary>
  5371. </member>
  5372. <member name="T:MSBuild.Community.Tasks.ILMerge">
  5373. <summary>
  5374. A wrapper for the ILMerge tool.
  5375. </summary>
  5376. <remarks>
  5377. <para>
  5378. The ILMerge tool itself must be installed separately.
  5379. It is available <a href="http://research.microsoft.com/~mbarnett/ILMerge.aspx">here</a>.
  5380. </para>
  5381. <para>
  5382. The command line options "/wildcards" and "/lib" of ILMerge are not supported,
  5383. because MSBuild is in charge of expanding wildcards for item groups.
  5384. </para>
  5385. </remarks>
  5386. <example>
  5387. This example merges two assemblies A.dll and B.dll into one:
  5388. <code><![CDATA[
  5389. <PropertyGroup>
  5390. <outputFile>$(testDir)\ilmergetest.dll</outputFile>
  5391. <keyFile>$(testDir)\keypair.snk</keyFile>
  5392. <excludeFile>$(testDir)\ExcludeTypes.txt</excludeFile>
  5393. <logFile>$(testDir)\ilmergetest.log</logFile>
  5394. </PropertyGroup>
  5395. <ItemGroup>
  5396. <inputAssemblies Include="$(testDir)\A.dll" />
  5397. <inputAssemblies Include="$(testDir)\B.dll" />
  5398. <allowDuplicates Include="ClassAB" />
  5399. </ItemGroup>
  5400. <Target Name="merge" >
  5401. <ILMerge InputAssemblies="@(inputAssemblies)"
  5402. AllowDuplicateTypes="@(allowDuplicates)"
  5403. ExcludeFile="$(excludeFile)"
  5404. OutputFile="$(outputFile)" LogFile="$(logFile)"
  5405. DebugInfo="true" XmlDocumentation="true"
  5406. KeyFile="$(keyFile)" DelaySign="true" />
  5407. </Target>]]></code>
  5408. </example>
  5409. </member>
  5410. <member name="M:MSBuild.Community.Tasks.ILMerge.#ctor">
  5411. <summary>
  5412. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.ILMerge"/> class.
  5413. </summary>
  5414. </member>
  5415. <member name="M:MSBuild.Community.Tasks.ILMerge.GenerateFullPathToTool">
  5416. <summary>
  5417. Gets the standard installation path of ILMerge.exe.
  5418. </summary>
  5419. <remarks>
  5420. If ILMerge is not installed at its standard installation path,
  5421. provide its location to <see cref="P:Microsoft.Build.Utilities.ToolTask.ToolPath"/>.
  5422. </remarks>
  5423. <returns>Returns [ProgramFiles]\Microsoft\ILMerge.exe.</returns>
  5424. </member>
  5425. <member name="M:MSBuild.Community.Tasks.ILMerge.GenerateCommandLineCommands">
  5426. <summary>
  5427. Generates a string value containing the command line arguments
  5428. to pass directly to the executable file.
  5429. </summary>
  5430. <returns>
  5431. Returns a string value containing the command line arguments
  5432. to pass directly to the executable file.
  5433. </returns>
  5434. </member>
  5435. <member name="P:MSBuild.Community.Tasks.ILMerge.AllowDuplicateTypes">
  5436. <summary>
  5437. Gets or sets the names of public types
  5438. to be renamed when they are duplicates.
  5439. </summary>
  5440. <remarks>
  5441. <para>Set to an empty item group to allow all public types to be renamed.</para>
  5442. <para>Don't provide this parameter if no duplicates of public types are allowed.</para>
  5443. <para>Corresponds to command line option "/allowDup".</para>
  5444. <para>The default value is <c>null</c>.</para>
  5445. </remarks>
  5446. </member>
  5447. <member name="P:MSBuild.Community.Tasks.ILMerge.AllowZeroPeKind">
  5448. <summary>
  5449. Gets or sets a value indicating whether to treat an assembly
  5450. with a zero PeKind flag
  5451. (this is the value of the field listed as .corflags in the Manifest)
  5452. as if it was ILonly.
  5453. </summary>
  5454. <remarks>
  5455. <para>Corresponds to command line option "/zeroPeKind".</para>
  5456. <para>The default value is <c>false</c>.</para>
  5457. </remarks>
  5458. </member>
  5459. <member name="P:MSBuild.Community.Tasks.ILMerge.AttributeFile">
  5460. <summary>
  5461. Gets or sets the attribute assembly
  5462. from whre to get all of the assembly-level attributes
  5463. such as Culture, Version, etc.
  5464. It will also be used to get the Win32 Resources from.
  5465. </summary>
  5466. <remarks>
  5467. <para>This property is mutually exclusive with <see cref="P:MSBuild.Community.Tasks.ILMerge.CopyAttributes"/>.</para>
  5468. <para>
  5469. When not specified, then the Win32 Resources from the primary assembly
  5470. are copied over into the target assembly.
  5471. </para>
  5472. <para>Corresponds to command line option "/attr".</para>
  5473. <para>The default value is <c>null</c>.</para>
  5474. </remarks>
  5475. </member>
  5476. <member name="P:MSBuild.Community.Tasks.ILMerge.Closed">
  5477. <summary>
  5478. Gets or sets a value indicating whether
  5479. to augment the list of input assemblies
  5480. to its "transitive closure".
  5481. </summary>
  5482. <remarks>
  5483. <para>
  5484. An assembly is considered part of the transitive closure if it is referenced,
  5485. either directly or indirectly,
  5486. from one of the originally specified input assemblies
  5487. and it has an external reference to one of the input assemblies,
  5488. or one of the assemblies that has such a reference.
  5489. </para>
  5490. <para>Corresponds to command line option "/closed".</para>
  5491. <para>The default value is <c>false</c>.</para>
  5492. </remarks>
  5493. </member>
  5494. <member name="P:MSBuild.Community.Tasks.ILMerge.CopyAttributes">
  5495. <summary>
  5496. Gets or sets a value indicating whether
  5497. to copy the assembly level attributes
  5498. of each input assembly over into the target assembly.
  5499. </summary>
  5500. <remarks>
  5501. <para>
  5502. Any duplicate attribute overwrites a previously copied attribute.
  5503. The input assemblies are processed in the order they are specified.
  5504. </para>
  5505. <para>This parameter is mutually exclusive with <see cref="P:MSBuild.Community.Tasks.ILMerge.AttributeFile"/>.</para>
  5506. <para>Corresponds to command line option "/copyattrs".</para>
  5507. <para>The default value is <c>false</c>.</para>
  5508. </remarks>
  5509. </member>
  5510. <member name="P:MSBuild.Community.Tasks.ILMerge.DebugInfo">
  5511. <summary>
  5512. Gets or sets a value indicating whether
  5513. to preserve any .pdb files
  5514. that are found for the input assemblies
  5515. into a .pdb file for the target assembly.
  5516. </summary>
  5517. <remarks>
  5518. <para>Corresponds to command line option "/ndebug".</para>
  5519. <para>The default value is <c>true</c>.</para>
  5520. </remarks>
  5521. </member>
  5522. <member name="P:MSBuild.Community.Tasks.ILMerge.DelaySign">
  5523. <summary>
  5524. Gets or sets a value indicating whether
  5525. the target assembly will be delay signed.
  5526. </summary>
  5527. <remarks>
  5528. <para>This property can be set only in conjunction with <see cref="P:MSBuild.Community.Tasks.ILMerge.KeyFile"/>.</para>
  5529. <para>Corresponds to command line option "/delaysign".</para>
  5530. <para>The default value is <c>false</c>.</para>
  5531. </remarks>
  5532. </member>
  5533. <member name="P:MSBuild.Community.Tasks.ILMerge.ExcludeFile">
  5534. <summary>
  5535. Gets or sets the file
  5536. that will be used to identify types
  5537. that are not to have their visibility modified.
  5538. </summary>
  5539. <remarks>
  5540. <para>
  5541. If an empty item group is provided,
  5542. then all types in any assembly other than the primary assembly are made non-public.
  5543. </para>
  5544. <para>Omit this parameter to prevent ILMerge from modifying the visibility of any types.</para>
  5545. <para>
  5546. The contents of the file should be one <see cref="T:System.Text.RegularExpressions.Regex"/> per line.
  5547. The regular expressions are matched against each type's full name,
  5548. e.g., <c>System.Collections.IList</c>.
  5549. If the match fails, it is tried again with the assembly name (surrounded by square brackets)
  5550. prepended to the type name.
  5551. Thus, the pattern <c>\[A\].*</c> excludes all types in assembly <c>A</c> from being made non-public.
  5552. The pattern <c>N.T</c> will match all types named <c>T</c> in the namespace named <c>N</c>
  5553. no matter what assembly they are defined in.
  5554. </para>
  5555. <para>Corresponds to command line option "/internalize".</para>
  5556. <para>The default value is <c>null</c>.</para>
  5557. </remarks>
  5558. </member>
  5559. <member name="P:MSBuild.Community.Tasks.ILMerge.InputAssemblies">
  5560. <summary>
  5561. Gets or sets the input assemblies to merge.
  5562. </summary>
  5563. </member>
  5564. <member name="P:MSBuild.Community.Tasks.ILMerge.Internalize">
  5565. <summary>
  5566. Gets or sets a value indicating whether whether types in assemblies other than the primary assembly have their visibility modified.
  5567. </summary>
  5568. <value><c>true</c> if internalize; otherwise, <c>false</c>.</value>
  5569. <remarks>
  5570. <para>This controls whether types in assemblies other than the primary assembly have
  5571. their visibility modified. When it is true, then all non-exempt types that are visible
  5572. outside of their assembly have their visibility modified so that they are not visible
  5573. from outside of the merged assembly. A type is exempt if its full name matches a line
  5574. from the ExcludeFile (Section 2.9) using the .NET regular expression engine.</para>
  5575. <para>Corresponds to command line option "/internalize".</para>
  5576. <para>The default value is <c>false</c>.</para>
  5577. </remarks>
  5578. </member>
  5579. <member name="P:MSBuild.Community.Tasks.ILMerge.KeyFile">
  5580. <summary>
  5581. Gets or sets the .snk file
  5582. to sign the target assembly.
  5583. </summary>
  5584. <remarks>
  5585. <para>Can be used with <see cref="P:MSBuild.Community.Tasks.ILMerge.DelaySign"/>.</para>
  5586. <para>Corresponds to command line option "/keyfile".</para>
  5587. <para>The default value is <c>null</c>.</para>
  5588. </remarks>
  5589. </member>
  5590. <member name="P:MSBuild.Community.Tasks.ILMerge.LogFile">
  5591. <summary>
  5592. Gets or sets a log file
  5593. to write log messages to.
  5594. </summary>
  5595. <remarks>
  5596. <para>
  5597. If an empty item group is provided,
  5598. then log messages are writte to <see cref="P:System.Console.Out"/>.
  5599. </para>
  5600. <para>Corresponds to command line option "/log".</para>
  5601. <para>The default value is <c>null</c>.</para>
  5602. </remarks>
  5603. </member>
  5604. <member name="P:MSBuild.Community.Tasks.ILMerge.OutputFile">
  5605. <summary>
  5606. Gets or sets the target assembly.
  5607. </summary>
  5608. <remarks>
  5609. <para>Corresponds to command line option "/out".</para>
  5610. </remarks>
  5611. </member>
  5612. <member name="P:MSBuild.Community.Tasks.ILMerge.PublicKeyTokens">
  5613. <summary>
  5614. Gets or sets a value indicating whether
  5615. external assembly references in the manifest
  5616. of the target assembly will use public keys (<c>false</c>)
  5617. or public key tokens (<c>true</c>).
  5618. </summary>
  5619. <remarks>
  5620. <para>Corresponds to command line option "/publickeytokens".</para>
  5621. <para>The default value is <c>false</c>.</para>
  5622. </remarks>
  5623. </member>
  5624. <member name="P:MSBuild.Community.Tasks.ILMerge.SearchDirectories">
  5625. <summary>
  5626. Gets or sets the directories to be used to search for input assemblies.
  5627. </summary>
  5628. <value>The search directories.</value>
  5629. </member>
  5630. <member name="P:MSBuild.Community.Tasks.ILMerge.TargetPlatformVersion">
  5631. <summary>
  5632. Gets or sets the .NET framework version for the target assembly.
  5633. </summary>
  5634. <remarks>
  5635. <para>Valid values are "v1", "v1.1", "v2".</para>
  5636. <para>Corresponds to the first part of command line option "/targetplatform".</para>
  5637. <para>The default value is <c>null</c>.</para>
  5638. </remarks>
  5639. </member>
  5640. <member name="P:MSBuild.Community.Tasks.ILMerge.TargetPlatformDirectory">
  5641. <summary>
  5642. Gets or sets the directory in which <c>mscorlib.dll</c> is to be found.
  5643. </summary>
  5644. <remarks>
  5645. <para>Can only be used in conjunction with <see cref="P:MSBuild.Community.Tasks.ILMerge.TargetPlatformVersion"/>.</para>
  5646. <para>Corresponds to the second part of command line option "/targetplatform".</para>
  5647. <para>The default value is <c>null</c>.</para>
  5648. </remarks>
  5649. </member>
  5650. <member name="P:MSBuild.Community.Tasks.ILMerge.TargetKind">
  5651. <summary>
  5652. Gets or sets the indicator
  5653. whether the target assembly is created as a library (<c>Dll</c>),
  5654. a console application (<c>Exe</c>) or as a Windows application (<c>WinExe</c>).
  5655. </summary>
  5656. <remarks>
  5657. <para>Corresponds to command line option "/target".</para>
  5658. <para>The default value is the same kind as that of the primary assembly.</para>
  5659. </remarks>
  5660. </member>
  5661. <member name="P:MSBuild.Community.Tasks.ILMerge.Version">
  5662. <summary>
  5663. Gets or sets the version number of the target assembly.
  5664. </summary>
  5665. <remarks>
  5666. <para>The parameter should look like <c>6.2.1.3</c>.</para>
  5667. <para>Corresponds to command line option "/ver".</para>
  5668. <para>The default value is null.</para>
  5669. </remarks>
  5670. </member>
  5671. <member name="P:MSBuild.Community.Tasks.ILMerge.XmlDocumentation">
  5672. <summary>
  5673. Gets or sets a value indicating whether
  5674. to merge XML documentation files
  5675. into one for the target assembly.
  5676. </summary>
  5677. <remarks>
  5678. <para>Corresponds to command line option "/xmldocs".</para>
  5679. <para>The default value is <c>false</c>.</para>
  5680. </remarks>
  5681. </member>
  5682. <member name="P:MSBuild.Community.Tasks.ILMerge.ToolName">
  5683. <summary>
  5684. Gets the name of the executable file to run.
  5685. </summary>
  5686. </member>
  5687. <member name="P:MSBuild.Community.Tasks.ILMerge.StandardOutputLoggingImportance">
  5688. <summary>
  5689. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  5690. </summary>
  5691. <value></value>
  5692. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  5693. </member>
  5694. <member name="P:MSBuild.Community.Tasks.ILMerge.StandardErrorLoggingImportance">
  5695. <summary>
  5696. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"/> with which to log errors.
  5697. </summary>
  5698. <value></value>
  5699. <returns>
  5700. The <see cref="T:Microsoft.Build.Framework.MessageImportance"/> with which to log errors.
  5701. </returns>
  5702. </member>
  5703. <member name="T:MSBuild.Community.Tasks.Install.InstallAssembly">
  5704. <summary>
  5705. Installs assemblies.
  5706. </summary>
  5707. <remarks>
  5708. Uses InstallUtil.exe to execute the
  5709. <see href="http://msdn2.microsoft.com/system.configuration.install.installer.install.aspx">Install</see>
  5710. method of
  5711. <see href="http://msdn2.microsoft.com/system.configuration.install.installer.aspx">Installer</see>
  5712. classes contained within specified assemblies.
  5713. </remarks>
  5714. <example>
  5715. Install multiple assemblies by specifying the file names:
  5716. <code>
  5717. <![CDATA[
  5718. <InstallAssembly AssemblyFiles="Engine.dll;Presenter.dll" />
  5719. ]]>
  5720. </code>
  5721. </example><example>
  5722. Install an assembly using the assembly name. Also disable the log file by setting it to a single space:
  5723. <code>
  5724. <![CDATA[
  5725. <InstallAssembly AssemblyNames="Engine,Version=1.5.0.0,Culture=neutral" LogFile=" "/>
  5726. ]]>
  5727. </code>
  5728. </example><example>
  5729. You can easily chain an install to the result of a build:
  5730. <code>
  5731. <![CDATA[
  5732. <MSBuild Projects="Project1.csproj;Project2.csproj">
  5733. <Output TaskParameter="TargetOutputs" ItemName="ProjectBinaries" />
  5734. </MSBuild>
  5735. <InstallAssembly AssemblyFiles="@(ProjectBinaries)" />
  5736. ]]>
  5737. </code>
  5738. </example>
  5739. </member>
  5740. <member name="M:MSBuild.Community.Tasks.Install.InstallAssembly.GenerateFullPathToTool">
  5741. <summary>
  5742. Returns the fully qualified path to the executable file.
  5743. </summary>
  5744. <returns>
  5745. The fully qualified path to the executable file.
  5746. </returns>
  5747. </member>
  5748. <member name="M:MSBuild.Community.Tasks.Install.InstallAssembly.GenerateCommandLineCommands">
  5749. <summary>
  5750. Returns a string value containing the command line arguments
  5751. to pass directly to the executable file.
  5752. </summary>
  5753. <returns>
  5754. A string value containing the command line arguments to pass
  5755. directly to the executable file.
  5756. </returns>
  5757. </member>
  5758. <member name="P:MSBuild.Community.Tasks.Install.InstallAssembly.AssemblyNames">
  5759. <summary>
  5760. The assemblies to process, identified by their assembly name.
  5761. </summary>
  5762. </member>
  5763. <member name="P:MSBuild.Community.Tasks.Install.InstallAssembly.AssemblyFiles">
  5764. <summary>
  5765. The assemblies to process, identified by their filename.
  5766. </summary>
  5767. </member>
  5768. <member name="P:MSBuild.Community.Tasks.Install.InstallAssembly.LogFile">
  5769. <summary>
  5770. The file to write installation progress to.
  5771. </summary>
  5772. <remarks>Set to a single space to disable logging to a file.
  5773. <para>
  5774. If not specified, the default is to log to [assemblyname].installLog
  5775. </para>
  5776. </remarks>
  5777. </member>
  5778. <member name="P:MSBuild.Community.Tasks.Install.InstallAssembly.ShowCallStack">
  5779. <summary>
  5780. If an exception occurs at any point during installation, the call
  5781. stack will be printed to the log.
  5782. </summary>
  5783. </member>
  5784. <member name="P:MSBuild.Community.Tasks.Install.InstallAssembly.IsUninstall">
  5785. <summary>
  5786. Determines whether assemblies are installed or uninstalled.
  5787. </summary>
  5788. </member>
  5789. <member name="P:MSBuild.Community.Tasks.Install.InstallAssembly.ToolName">
  5790. <summary>
  5791. Gets the name of the executable file to run.
  5792. </summary>
  5793. <value></value>
  5794. <returns>The name of the executable file to run.</returns>
  5795. </member>
  5796. <member name="T:MSBuild.Community.Tasks.Install.UninstallAssembly">
  5797. <summary>Uninstalls assemblies.</summary>
  5798. <remarks>
  5799. Uses InstallUtil.exe to execute the
  5800. <see href="http://msdn2.microsoft.com/system.configuration.install.installer.uninstall.aspx">Uninstall</see>
  5801. method of
  5802. <see href="http://msdn2.microsoft.com/system.configuration.install.installer.aspx">Installer</see>
  5803. classes contained within specified assemblies.
  5804. </remarks>
  5805. <example>Uninstall multiple assemblies by specifying the file names:
  5806. <code><![CDATA[
  5807. <UninstallAssembly AssemblyFiles="Engine.dll;Presenter.dll" />
  5808. ]]></code>
  5809. </example>
  5810. <example>Unnstall an assembly using the assembly name. Also disable the log file by setting it to a single space:
  5811. <code><![CDATA[
  5812. <UninstallAssembly AssemblyNames="Engine,Version=1.5.0.0,Culture=neutral" LogFile=" "/>
  5813. ]]></code>
  5814. </example>
  5815. </member>
  5816. <member name="P:MSBuild.Community.Tasks.Install.UninstallAssembly.IsUninstall">
  5817. <summary>
  5818. Determines whether assemblies are installed or uninstalled.
  5819. </summary>
  5820. </member>
  5821. <member name="T:MSBuild.Community.Tasks.Math.Modulo">
  5822. <summary>
  5823. Performs the modulo operation on numbers.
  5824. </summary>
  5825. <remarks>
  5826. The modulo operation finds the remainder of the division of one number by another.
  5827. <para>When the second number (modulus) is a fractional value, the result can be a fractional value.</para>
  5828. <para>
  5829. Equivalent to the % operator in C# or the Mod operator in Visual Basic.
  5830. </para>
  5831. </remarks><example>
  5832. Numbers evenly divide:
  5833. <code>
  5834. <![CDATA[
  5835. <Math.Modulo Numbers="12;4">
  5836. <Output TaskParameter="Result" PropertyName="Result" />
  5837. </Math.Modulo>
  5838. <Message Text="12 modulo 4 = $(Result)"/>
  5839. ]]>
  5840. </code>
  5841. Above example will display:
  5842. <code>12 modulo 4 = 0</code>
  5843. </example><example>
  5844. Division on the numbers produces a remainder:
  5845. <code>
  5846. <![CDATA[
  5847. <Math.Modulo Numbers="14;4">
  5848. <Output TaskParameter="Result" PropertyName="Result" />
  5849. </Math.Modulo>
  5850. <Message Text="14 modulo 4 = $(Result)"/>
  5851. ]]>
  5852. </code>
  5853. Above example will display:
  5854. <code>14 modulo 4 = 2</code>
  5855. </example><example>
  5856. Modulus is a fractional value:
  5857. <code>
  5858. <![CDATA[
  5859. <Math.Modulo Numbers="12;3.5">
  5860. <Output TaskParameter="Result" PropertyName="Result" />
  5861. </Math.Modulo>
  5862. <Message Text="12 modulo 3.5 = $(Result)"/>
  5863. ]]>
  5864. </code>
  5865. Above example will display:
  5866. <code>12 modulo 3.5 = 1.5</code>
  5867. </example>
  5868. </member>
  5869. <member name="T:MSBuild.Community.Tasks.Math.MathBase">
  5870. <summary>
  5871. Math task base class
  5872. </summary>
  5873. </member>
  5874. <member name="M:MSBuild.Community.Tasks.Math.MathBase.Execute">
  5875. <summary>
  5876. When overridden in a derived class, executes the task.
  5877. </summary>
  5878. <returns>
  5879. true if the task successfully executed; otherwise, false.
  5880. </returns>
  5881. </member>
  5882. <member name="M:MSBuild.Community.Tasks.Math.MathBase.StringArrayToDecimalArray(System.String[])">
  5883. <summary>
  5884. Strings array to decimal array.
  5885. </summary>
  5886. <param name="numbers">The numbers.</param>
  5887. <returns></returns>
  5888. </member>
  5889. <member name="P:MSBuild.Community.Tasks.Math.MathBase.Numbers">
  5890. <summary>
  5891. Gets or sets the numbers to work with.
  5892. </summary>
  5893. <value>The numbers.</value>
  5894. </member>
  5895. <member name="P:MSBuild.Community.Tasks.Math.MathBase.Result">
  5896. <summary>
  5897. Gets or sets the result.
  5898. </summary>
  5899. <value>The result.</value>
  5900. </member>
  5901. <member name="P:MSBuild.Community.Tasks.Math.MathBase.NumericFormat">
  5902. <summary>
  5903. Gets or sets the numeric format.
  5904. </summary>
  5905. <value>The numeric format.</value>
  5906. </member>
  5907. <member name="M:MSBuild.Community.Tasks.Math.Modulo.Execute">
  5908. <summary>
  5909. When overridden in a derived class, executes the task.
  5910. </summary>
  5911. <returns>
  5912. true if the task successfully executed; otherwise, false.
  5913. </returns>
  5914. </member>
  5915. <member name="T:MSBuild.Community.Tasks.Prompt">
  5916. <summary>
  5917. Displays a message on the console and waits for user input.
  5918. </summary>
  5919. <remarks>It is important to note that the message is not written to the MSBuild logger,
  5920. it is always written to the console, no matter which logger is configured.
  5921. <para>This task requires user input from the console. Do not use this task for projects
  5922. that will be executed unattended. It is recommended that you always add a Condtion so that
  5923. this task is only enabled when a custom property is set through the command line.
  5924. This will ensure that the other users do not attempt to execute the task in unattended mode.
  5925. </para></remarks>
  5926. <example>Pause the build if the interactive property is set:
  5927. <code><![CDATA[
  5928. <!-- Pause when invoked with the interactive property: msbuild myproject.proj /property:interactive=true -->
  5929. <Prompt Text="You can now attach the debugger to the msbuild.exe process..." Condition="'$(Interactive)' == 'True'" />
  5930. ]]></code>
  5931. </example>
  5932. <example>Obtain user input during the build:
  5933. (Note: in most cases, it is recommended that users instead provide custom values to your build through the /property argument of msbuild.exe)
  5934. <code><![CDATA[
  5935. <Prompt Text="Tell me your name:" Condition="'$(Interactive)' == 'True'" >
  5936. <Output TaskParameter="UserInput" PropertyName="PersonName" />
  5937. </Prompt>
  5938. <Message Text="Hello $(PersonName)" />
  5939. ]]></code>
  5940. </example>
  5941. </member>
  5942. <member name="M:MSBuild.Community.Tasks.Prompt.Execute">
  5943. <summary>
  5944. When overridden in a derived class, executes the task.
  5945. </summary>
  5946. <returns>
  5947. true if the task successfully executed; otherwise, false.
  5948. </returns>
  5949. </member>
  5950. <member name="P:MSBuild.Community.Tasks.Prompt.Text">
  5951. <summary>
  5952. The message to display in the console.
  5953. </summary>
  5954. </member>
  5955. <member name="P:MSBuild.Community.Tasks.Prompt.UserInput">
  5956. <summary>
  5957. The text entered at the console.
  5958. </summary>
  5959. </member>
  5960. <member name="T:MSBuild.Community.Tasks.RegexBase">
  5961. <summary>
  5962. Base class for Regex tasks
  5963. Handles public properties for Input, Expression, Options and Output
  5964. </summary>
  5965. </member>
  5966. <member name="P:MSBuild.Community.Tasks.RegexBase.Expression">
  5967. <summary>
  5968. Regex expression
  5969. </summary>
  5970. </member>
  5971. <member name="P:MSBuild.Community.Tasks.RegexBase.Input">
  5972. <summary>
  5973. Input, list of items to perform the regex on
  5974. </summary>
  5975. </member>
  5976. <member name="P:MSBuild.Community.Tasks.RegexBase.Options">
  5977. <summary>
  5978. Regex options as strings corresponding to the RegexOptions enum:
  5979. Compiled
  5980. CultureInvariant
  5981. ECMAScript
  5982. ExplicitCapture
  5983. IgnoreCase
  5984. IgnorePatternWhitespace
  5985. Multiline
  5986. None
  5987. RightToLeft
  5988. Singleline
  5989. </summary>
  5990. <enum cref="T:System.Text.RegularExpressions.RegexOptions"/>
  5991. </member>
  5992. <member name="P:MSBuild.Community.Tasks.RegexBase.Output">
  5993. <summary>
  5994. Results of the Regex transformation.
  5995. </summary>
  5996. </member>
  5997. <member name="P:MSBuild.Community.Tasks.RegexBase.ExpressionOptions">
  5998. <summary>
  5999. Options converted to RegexOptions enum
  6000. </summary>
  6001. </member>
  6002. <member name="T:MSBuild.Community.Tasks.RegexMatch">
  6003. <summary>
  6004. Task to filter an Input list with a Regex expression.
  6005. Output list contains items from Input list that matched given expression
  6006. </summary>
  6007. <example>Matches from TestGroup those names ending in a, b or c
  6008. <code><![CDATA[
  6009. <ItemGroup>
  6010. <TestGroup Include="foo.my.foo.foo.test.o" />
  6011. <TestGroup Include="foo.my.faa.foo.test.a" />
  6012. <TestGroup Include="foo.my.fbb.foo.test.b" />
  6013. <TestGroup Include="foo.my.fcc.foo.test.c" />
  6014. <TestGroup Include="foo.my.fdd.foo.test.d" />
  6015. <TestGroup Include="foo.my.fee.foo.test.e" />
  6016. <TestGroup Include="foo.my.fff.foo.test.f" />
  6017. </ItemGroup>
  6018. <Target Name="Test">
  6019. <!-- Outputs only items that end with a, b or c -->
  6020. <RegexMatch Input="@(TestGroup)" Expression="[a-c]$">
  6021. <Output ItemName ="MatchReturn" TaskParameter="Output" />
  6022. </RegexMatch>
  6023. <Message Text="&#xA;Output Match:&#xA;@(MatchReturn, '&#xA;')" />
  6024. </Target>
  6025. ]]></code>
  6026. </example>
  6027. </member>
  6028. <member name="M:MSBuild.Community.Tasks.RegexMatch.Execute">
  6029. <summary>
  6030. Performs the Match task
  6031. </summary>
  6032. <returns><see langword="true"/> if the task ran successfully;
  6033. otherwise <see langword="false"/>.</returns>
  6034. </member>
  6035. <member name="T:MSBuild.Community.Tasks.RegexReplace">
  6036. <summary>
  6037. Task to replace portions of strings within the Input list
  6038. Output list contains all the elements of the Input list after
  6039. performing the Regex Replace.
  6040. </summary>
  6041. <example>
  6042. 1st example replaces first occurance of "foo." with empty string
  6043. 2nd example replaces occurance of "foo." after character 6 with "oop." string
  6044. <code><![CDATA[
  6045. <ItemGroup>
  6046. <TestGroup Include="foo.my.foo.foo.test.o" />
  6047. <TestGroup Include="foo.my.faa.foo.test.a" />
  6048. <TestGroup Include="foo.my.fbb.foo.test.b" />
  6049. <TestGroup Include="foo.my.fcc.foo.test.c" />
  6050. <TestGroup Include="foo.my.fdd.foo.test.d" />
  6051. <TestGroup Include="foo.my.fee.foo.test.e" />
  6052. <TestGroup Include="foo.my.fff.foo.test.f" />
  6053. </ItemGroup>
  6054. <Target Name="Test">
  6055. <Message Text="Input:&#xA;@(TestGroup, '&#xA;')"/>
  6056. <!-- Replaces first occurance of "foo." with empty string-->
  6057. <RegexReplace Input="@(TestGroup)" Expression="foo\." Replacement="" Count="1">
  6058. <Output ItemName ="ReplaceReturn1" TaskParameter="Output" />
  6059. </RegexReplace>
  6060. <Message Text="&#xA;Output Replace 1:&#xA;@(ReplaceReturn1, '&#xA;')" />
  6061. <!-- Replaces occurance of "foo." after character 6 with "oop." string-->
  6062. <RegexReplace Input="@(TestGroup)" Expression="foo\." Replacement="oop" Startat="6">
  6063. <Output ItemName ="ReplaceReturn2" TaskParameter="Output" />
  6064. </RegexReplace>
  6065. <Message Text="&#xA;Output Replace 2:&#xA;@(ReplaceReturn2, '&#xA;')" />
  6066. </Target>
  6067. ]]></code>
  6068. </example>
  6069. </member>
  6070. <member name="M:MSBuild.Community.Tasks.RegexReplace.Execute">
  6071. <summary>
  6072. Performs the Replace task
  6073. </summary>
  6074. <returns><see langword="true"/> if the task ran successfully;
  6075. otherwise <see langword="false"/>.</returns>
  6076. </member>
  6077. <member name="P:MSBuild.Community.Tasks.RegexReplace.Replacement">
  6078. <summary>
  6079. String replacing matching expression strings in input list.
  6080. If left empty matches in the input list are removed (replaced with empty string)
  6081. </summary>
  6082. </member>
  6083. <member name="P:MSBuild.Community.Tasks.RegexReplace.Count">
  6084. <summary>
  6085. Number of matches to allow on each input item.
  6086. -1 indicates to perform matches on all matches within input item
  6087. </summary>
  6088. </member>
  6089. <member name="P:MSBuild.Community.Tasks.RegexReplace.StartAt">
  6090. <summary>
  6091. Position within the input item to start matching
  6092. </summary>
  6093. </member>
  6094. <member name="T:MSBuild.Community.Tasks.Schema.TaskListAssemblyFormatType">
  6095. <summary>
  6096. Different ways to specify the assembly in a UsingTask element.
  6097. </summary>
  6098. </member>
  6099. <member name="F:MSBuild.Community.Tasks.Schema.TaskListAssemblyFormatType.AssemblyFileName">
  6100. <summary>
  6101. Assembly file name (Default): &lt;UsingTask AssemblyFile=&quot;foo.dll&quot; /&gt;
  6102. </summary>
  6103. </member>
  6104. <member name="F:MSBuild.Community.Tasks.Schema.TaskListAssemblyFormatType.AssemblyFileFullPath">
  6105. <summary>
  6106. Assembly location: &lt;UsingTask AssemblyName=&quot;foo&quot; /&gt;
  6107. </summary>
  6108. </member>
  6109. <member name="F:MSBuild.Community.Tasks.Schema.TaskListAssemblyFormatType.AssemblyName">
  6110. <summary>
  6111. Assembly Name: &lt;UsingTask AssemblyFile=&quot;bin\debug\foo.dll&quot; /&gt;
  6112. </summary>
  6113. </member>
  6114. <member name="F:MSBuild.Community.Tasks.Schema.TaskListAssemblyFormatType.AssemblyFullName">
  6115. <summary>
  6116. Assembly fully qualified name: &lt;UsingTask AssemblyName=&quot;foo.dll,version ....&quot; /&gt;
  6117. </summary>
  6118. </member>
  6119. <member name="T:MSBuild.Community.Tasks.Schema.TaskSchema">
  6120. <summary>
  6121. A Task that generates a XSD schema of the tasks in an assembly.
  6122. </summary>
  6123. <example>
  6124. <para>Creates schema for MSBuild Community Task project</para>
  6125. <code><![CDATA[
  6126. <TaskSchema Assemblies="Build\MSBuild.Community.Tasks.dll"
  6127. OutputPath="Build"
  6128. CreateTaskList="true"
  6129. IgnoreMsBuildSchema="true"
  6130. Includes="Microsoft.Build.Commontypes.xsd"/>
  6131. ]]></code>
  6132. </example>
  6133. </member>
  6134. <member name="M:MSBuild.Community.Tasks.Schema.TaskSchema.Execute">
  6135. <summary>
  6136. When overridden in a derived class, executes the task.
  6137. </summary>
  6138. <returns>
  6139. true if the task successfully executed; otherwise, false.
  6140. </returns>
  6141. </member>
  6142. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.Assemblies">
  6143. <summary>
  6144. Gets or sets the list of <see cref="T:System.Reflection.Assembly"/> path to analyse.
  6145. </summary>
  6146. </member>
  6147. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.OutputPath">
  6148. <summary>
  6149. Gets or sets the output path for the generated files.
  6150. </summary>
  6151. </member>
  6152. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.Schemas">
  6153. <summary>
  6154. Gets the list of path to the generated XSD schema.
  6155. </summary>
  6156. </member>
  6157. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.CreateTaskList">
  6158. <summary>
  6159. Gets or sets a value indicating if the task list (using UsingTask)
  6160. has to be genereted.
  6161. </summary>
  6162. </member>
  6163. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.TaskListAssemblyFormat">
  6164. <summary>
  6165. Gets or sets a value indicating how the assembly is specified in the
  6166. UsingTask element.
  6167. </summary>
  6168. <enum cref="T:MSBuild.Community.Tasks.Schema.TaskListAssemblyFormatType"/>
  6169. </member>
  6170. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.IgnoreDocumentation">
  6171. <summary>
  6172. Gets or sets a value indicating wheter documentation should be ignored
  6173. even if available (Default is false).
  6174. </summary>
  6175. </member>
  6176. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.TaskLists">
  6177. <summary>
  6178. Gets the path to the task list if it was generated.
  6179. </summary>
  6180. </member>
  6181. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.IgnoreMsBuildSchema">
  6182. <summary>
  6183. Gets or sets a value indicating if the
  6184. MsBuild schema inclusing should be ignored
  6185. </summary>
  6186. </member>
  6187. <member name="P:MSBuild.Community.Tasks.Schema.TaskSchema.Includes">
  6188. <summary>
  6189. Gets or sets a list of included schemas
  6190. </summary>
  6191. </member>
  6192. <member name="T:MSBuild.Community.Tasks.GetSolutionProjects">
  6193. <summary>
  6194. Retrieves the list of Projects contained within a Visual Studio Solution (.sln) file
  6195. </summary>
  6196. <example>
  6197. Returns project name, GUID, and path information from test solution
  6198. <code><![CDATA[
  6199. <Target Name="Test">
  6200. <GetSolutionProjects Solution="TestSolution.sln">
  6201. <Output ItemName="ProjectFiles" TaskParameter="Output"/>
  6202. </GetSolutionProjects>
  6203. <Message Text="Project names:" />
  6204. <Message Text="%(ProjectFiles.ProjectName)" />
  6205. <Message Text="Relative project paths:" />
  6206. <Message Text="%(ProjectFiles.ProjectPath)" />
  6207. <Message Text="Project GUIDs:" />
  6208. <Message Text="%(ProjectFiles.ProjectGUID)" />
  6209. <Message Text="Full paths to project files:" />
  6210. <Message Text="%(ProjectFiles.FullPath)" />
  6211. </Target>
  6212. ]]></code>
  6213. </example>
  6214. </member>
  6215. <member name="M:MSBuild.Community.Tasks.GetSolutionProjects.Execute">
  6216. <summary>
  6217. Perform task
  6218. </summary>
  6219. <returns>true on success</returns>
  6220. </member>
  6221. <member name="P:MSBuild.Community.Tasks.GetSolutionProjects.Output">
  6222. <summary>
  6223. A list of the project files found in <see cref="P:MSBuild.Community.Tasks.GetSolutionProjects.Solution"/>
  6224. </summary>
  6225. <remarks>
  6226. The name of the project can be retrieved by reading metadata tag <c>ProjectName</c>.
  6227. <para>
  6228. The path to the project as it is is stored in the solution file retrieved by reading metadata tag <c>ProjectPath</c>.
  6229. </para>
  6230. <para>
  6231. The project's GUID can be retrieved by reading metadata tag <c>ProjectGUID</c>.
  6232. </para>
  6233. </remarks>
  6234. </member>
  6235. <member name="P:MSBuild.Community.Tasks.GetSolutionProjects.Solution">
  6236. <summary>
  6237. Name of Solution to get Projects from
  6238. </summary>
  6239. </member>
  6240. <member name="T:MSBuild.Community.Tasks.SqlServer.ExecuteDDL">
  6241. <summary>
  6242. MSBuild task to execute DDL and SQL statements.
  6243. </summary>
  6244. <remarks>Requires the the SQL Server libraries and dynamically loads the
  6245. required Microsoft.SqlServer.ConnectionInfo assembly.</remarks>
  6246. <example>
  6247. <code><![CDATA[
  6248. <PropertyGroup>
  6249. <ConnectionString>Server=localhost;Integrated Security=True</ConnectionString>
  6250. </PropertyGroup>
  6251. <Target Name="ExecuteDDL">
  6252. <ExecuteDDL ConnectionString="$(ConnectionString)" Files="SqlBatchScript.sql" ContinueOnError="false" />
  6253. </Target>
  6254. ]]></code>
  6255. </example>
  6256. </member>
  6257. <member name="M:MSBuild.Community.Tasks.SqlServer.ExecuteDDL.Execute">
  6258. <summary>
  6259. Executes the task.
  6260. </summary>
  6261. <returns>
  6262. true if the task successfully executed; otherwise, false.
  6263. </returns>
  6264. </member>
  6265. <member name="P:MSBuild.Community.Tasks.SqlServer.ExecuteDDL.ConnectionString">
  6266. <summary>
  6267. The connection string
  6268. </summary>
  6269. </member>
  6270. <member name="P:MSBuild.Community.Tasks.SqlServer.ExecuteDDL.Files">
  6271. <summary>
  6272. Gets or sets the DDL/SQL files.
  6273. </summary>
  6274. <value>The assemblies.</value>
  6275. </member>
  6276. <member name="P:MSBuild.Community.Tasks.SqlServer.ExecuteDDL.Results">
  6277. <summary>
  6278. Output the return count/values
  6279. </summary>
  6280. </member>
  6281. <member name="P:MSBuild.Community.Tasks.SqlServer.ExecuteDDL.StatementTimeout">
  6282. <summary>
  6283. Timeout to execute a DDL statement.
  6284. </summary>
  6285. <remarks>Defaults to 30 seconds. Set to 0 for an infinite timeout period.</remarks>
  6286. </member>
  6287. <member name="P:MSBuild.Community.Tasks.SqlServer.ExecuteDDL.BatchSeparator">
  6288. <summary>
  6289. Gets or sets the batch delimter string.
  6290. </summary>
  6291. <remarks>Default is "GO" for T-SQL.</remarks>
  6292. </member>
  6293. <member name="T:MSBuild.Community.Tasks.Subversion.NodeKind">
  6294. <summary>
  6295. The kind of Subversion node. The names match the text output
  6296. by "svn info".
  6297. </summary>
  6298. </member>
  6299. <member name="F:MSBuild.Community.Tasks.Subversion.NodeKind.file">
  6300. <summary>
  6301. Node is a file
  6302. </summary>
  6303. </member>
  6304. <member name="F:MSBuild.Community.Tasks.Subversion.NodeKind.dir">
  6305. <summary>
  6306. Node is a directory
  6307. </summary>
  6308. </member>
  6309. <member name="F:MSBuild.Community.Tasks.Subversion.NodeKind.unknown">
  6310. <summary>
  6311. Unknown node type
  6312. </summary>
  6313. </member>
  6314. <member name="T:MSBuild.Community.Tasks.Subversion.Schedule">
  6315. <summary>
  6316. The Subversion schedule type.
  6317. </summary>
  6318. </member>
  6319. <member name="F:MSBuild.Community.Tasks.Subversion.Schedule.normal">
  6320. <summary>
  6321. Normal schedule
  6322. </summary>
  6323. </member>
  6324. <member name="F:MSBuild.Community.Tasks.Subversion.Schedule.unknown">
  6325. <summary>
  6326. Unknown schedule.
  6327. </summary>
  6328. </member>
  6329. <member name="T:MSBuild.Community.Tasks.Subversion.SvnInfo">
  6330. <summary>
  6331. Run the "svn info" command and parse the output
  6332. </summary>
  6333. <example>
  6334. This example will determine the Subversion repository root for
  6335. a working directory and print it out.
  6336. <code><![CDATA[
  6337. <Target Name="printinfo">
  6338. <SvnInfo LocalPath="c:\code\myapp">
  6339. <Output TaskParameter="RepositoryRoot" PropertyName="root" />
  6340. </SvnInfo>
  6341. <Message Text="root: $(root)" />
  6342. </Target>
  6343. ]]></code>
  6344. </example>
  6345. <remarks>You can retrieve Subversion information for a <see cref="P:MSBuild.Community.Tasks.Subversion.SvnClient.LocalPath"/> or <see cref="P:MSBuild.Community.Tasks.Subversion.SvnClient.RepositoryPath"/>.
  6346. If you do not provide a value for <see cref="P:MSBuild.Community.Tasks.Subversion.SvnClient.LocalPath"/> or <see cref="P:MSBuild.Community.Tasks.Subversion.SvnClient.RepositoryPath"/>, the current directory is assumed.</remarks>
  6347. </member>
  6348. <member name="M:MSBuild.Community.Tasks.Subversion.SvnInfo.#ctor">
  6349. <summary>
  6350. Initializes a new instance of the <see cref="T:SvnInfo"/> class.
  6351. </summary>
  6352. </member>
  6353. <member name="M:MSBuild.Community.Tasks.Subversion.SvnInfo.ResetMemberVariables">
  6354. <summary>
  6355. Reset all instance variables to their default (unset) state.
  6356. </summary>
  6357. </member>
  6358. <member name="M:MSBuild.Community.Tasks.Subversion.SvnInfo.Execute">
  6359. <summary>
  6360. Execute the task.
  6361. </summary>
  6362. <returns>true if execution is successful, false if not.</returns>
  6363. </member>
  6364. <member name="P:MSBuild.Community.Tasks.Subversion.SvnInfo.RepositoryRoot">
  6365. <summary>
  6366. Return the repository root or null if not set by Subversion.
  6367. </summary>
  6368. </member>
  6369. <member name="P:MSBuild.Community.Tasks.Subversion.SvnInfo.RepositoryUuid">
  6370. <summary>
  6371. Return the repository UUID value from Subversion.
  6372. </summary>
  6373. </member>
  6374. <member name="P:MSBuild.Community.Tasks.Subversion.SvnInfo.NodeKind">
  6375. <summary>
  6376. The Subversion node kind.
  6377. </summary>
  6378. <enum cref="T:MSBuild.Community.Tasks.Subversion.NodeKind"/>
  6379. </member>
  6380. <member name="P:MSBuild.Community.Tasks.Subversion.SvnInfo.LastChangedAuthor">
  6381. <summary>
  6382. The author who last changed this node.
  6383. </summary>
  6384. </member>
  6385. <member name="P:MSBuild.Community.Tasks.Subversion.SvnInfo.LastChangedRevision">
  6386. <summary>
  6387. The last changed revision number.
  6388. </summary>
  6389. </member>
  6390. <member name="P:MSBuild.Community.Tasks.Subversion.SvnInfo.LastChangedDate">
  6391. <summary>
  6392. The date this node was last changed.
  6393. </summary>
  6394. </member>
  6395. <member name="P:MSBuild.Community.Tasks.Subversion.SvnInfo.Schedule">
  6396. <summary>
  6397. The Subversion schedule type.
  6398. </summary>
  6399. <enum cref="T:MSBuild.Community.Tasks.Subversion.Schedule"/>
  6400. </member>
  6401. <member name="T:MSBuild.Community.Tasks.TemplateFile">
  6402. <summary>
  6403. MSBuild task that replaces tokens in a template file and writes out a new file.
  6404. </summary>
  6405. <example>
  6406. <code><![CDATA[
  6407. <ItemGroup>
  6408. <Tokens Include="Name">
  6409. <ReplacementValue>MSBuild Community Tasks</ReplacementValue>
  6410. </Tokens>
  6411. </ItemGroup>
  6412. <TemplateFile TemplateFile="ATemplateFile.template" OutputFile="ReplacedFile.txt" Tokens="@(Tokens)" />
  6413. ]]></code>
  6414. </example>
  6415. <remarks>Tokens in the template file are formatted using ${var} syntax and names are not
  6416. case-sensitive, so ${Token} and ${TOKEN} are equivalent.</remarks>
  6417. </member>
  6418. <member name="F:MSBuild.Community.Tasks.TemplateFile.MetadataValueTag">
  6419. <summary>
  6420. Meta data tag used for token replacement
  6421. </summary>
  6422. </member>
  6423. <member name="M:MSBuild.Community.Tasks.TemplateFile.#ctor">
  6424. <summary>
  6425. Default constructor. Creates a new TemplateFile task.
  6426. </summary>
  6427. </member>
  6428. <member name="M:MSBuild.Community.Tasks.TemplateFile.Execute">
  6429. <summary>
  6430. Executes the task.
  6431. </summary>
  6432. <returns>Success or failure of the task.</returns>
  6433. </member>
  6434. <member name="P:MSBuild.Community.Tasks.TemplateFile.OutputFile">
  6435. <summary>
  6436. The token replaced template file.
  6437. </summary>
  6438. </member>
  6439. <member name="P:MSBuild.Community.Tasks.TemplateFile.OutputFilename">
  6440. <summary>
  6441. The full path to the output file name. If no filename is specified (the default) the
  6442. output file will be the Template filename with a .out extension.
  6443. </summary>
  6444. </member>
  6445. <member name="P:MSBuild.Community.Tasks.TemplateFile.Template">
  6446. <summary>
  6447. The template file used. Tokens with values of ${Name} are replaced by name.
  6448. </summary>
  6449. </member>
  6450. <member name="P:MSBuild.Community.Tasks.TemplateFile.Tokens">
  6451. <summary>
  6452. List of tokens to replace in the template. Token name is taken from the TaskItem.ItemSpec and the
  6453. replacement value comes from the ReplacementValue metadata of the item.
  6454. </summary>
  6455. </member>
  6456. <member name="T:MSBuild.Community.Tasks.Time">
  6457. <summary>
  6458. Gets the current date and time.
  6459. </summary>
  6460. <remarks>
  6461. See
  6462. <a href="ms-help://MS.VSCC.v80/MS.MSDN.v80/MS.NETDEVFX.v20.en/cpref8/html/T_System_Globalization_DateTimeFormatInfo.htm">
  6463. DateTimeFormatInfo</a>
  6464. for the syntax of the format string.
  6465. </remarks>
  6466. <example>Using the Time task to get the Month, Day,
  6467. Year, Hour, Minute, and Second:
  6468. <code><![CDATA[
  6469. <Time>
  6470. <Output TaskParameter="Month" PropertyName="Month" />
  6471. <Output TaskParameter="Day" PropertyName="Day" />
  6472. <Output TaskParameter="Year" PropertyName="Year" />
  6473. <Output TaskParameter="Hour" PropertyName="Hour" />
  6474. <Output TaskParameter="Minute" PropertyName="Minute" />
  6475. <Output TaskParameter="Second" PropertyName="Second" />
  6476. </Time>
  6477. <Message Text="Current Date and Time: $(Month)/$(Day)/$(Year) $(Hour):$(Minute):$(Second)" />]]></code>
  6478. Set property "BuildDate" to the current date and time:
  6479. <code><![CDATA[
  6480. <Time Format="yyyyMMddHHmmss">
  6481. <Output TaskParameter="FormattedTime" PropertyName="buildDate" />
  6482. </Time>]]></code>
  6483. </example>
  6484. </member>
  6485. <member name="M:MSBuild.Community.Tasks.Time.Execute">
  6486. <summary>
  6487. When overridden in a derived class, executes the task.
  6488. </summary>
  6489. <returns>
  6490. True if the task successfully executed; otherwise, false.
  6491. </returns>
  6492. </member>
  6493. <member name="P:MSBuild.Community.Tasks.Time.Format">
  6494. <summary>
  6495. Gets or sets the format string
  6496. for output parameter <see cref="P:MSBuild.Community.Tasks.Time.FormattedTime"/>.
  6497. </summary>
  6498. <remarks>
  6499. See
  6500. <a href="ms-help://MS.VSCC.v80/MS.MSDN.v80/MS.NETDEVFX.v20.en/cpref8/html/T_System_Globalization_DateTimeFormatInfo.htm">
  6501. DateTimeFormatInfo</a>
  6502. for the syntax of the format string.
  6503. </remarks>
  6504. </member>
  6505. <member name="P:MSBuild.Community.Tasks.Time.Month">
  6506. <summary>
  6507. Gets the month component of the date represented by this instance.
  6508. </summary>
  6509. </member>
  6510. <member name="P:MSBuild.Community.Tasks.Time.Day">
  6511. <summary>
  6512. Gets the day of the month represented by this instance.
  6513. </summary>
  6514. </member>
  6515. <member name="P:MSBuild.Community.Tasks.Time.Year">
  6516. <summary>
  6517. Gets the year component of the date represented by this instance.
  6518. </summary>
  6519. </member>
  6520. <member name="P:MSBuild.Community.Tasks.Time.Hour">
  6521. <summary>
  6522. Gets the hour component of the date represented by this instance.
  6523. </summary>
  6524. </member>
  6525. <member name="P:MSBuild.Community.Tasks.Time.Minute">
  6526. <summary>
  6527. Gets the minute component of the date represented by this instance.
  6528. </summary>
  6529. </member>
  6530. <member name="P:MSBuild.Community.Tasks.Time.Second">
  6531. <summary>
  6532. Gets the seconds component of the date represented by this instance.
  6533. </summary>
  6534. </member>
  6535. <member name="P:MSBuild.Community.Tasks.Time.Millisecond">
  6536. <summary>
  6537. Gets the milliseconds component of the date represented by this instance.
  6538. </summary>
  6539. </member>
  6540. <member name="P:MSBuild.Community.Tasks.Time.Ticks">
  6541. <summary>
  6542. Gets the number of ticks that represent the date and time of this instance.
  6543. </summary>
  6544. </member>
  6545. <member name="P:MSBuild.Community.Tasks.Time.Kind">
  6546. <summary>
  6547. Gets or sets a value that indicates whether the time represented by this instance is based
  6548. on local time, Coordinated Universal Time (UTC), or neither.
  6549. </summary>
  6550. <remarks>
  6551. Possible values are:
  6552. <list type="ul">
  6553. <item>Local (default)</item>,
  6554. <item>Utc</item>,
  6555. <item>Unspecified</item>
  6556. </list>
  6557. </remarks>
  6558. <enum cref="T:System.DateTimeKind"/>
  6559. </member>
  6560. <member name="P:MSBuild.Community.Tasks.Time.TimeOfDay">
  6561. <summary>
  6562. Gets the time of day for this instance.
  6563. </summary>
  6564. </member>
  6565. <member name="P:MSBuild.Community.Tasks.Time.DayOfYear">
  6566. <summary>
  6567. Gets the day of the year represented by this instance.
  6568. </summary>
  6569. </member>
  6570. <member name="P:MSBuild.Community.Tasks.Time.DayOfWeek">
  6571. <summary>
  6572. Gets the day of the week represented by this instance.
  6573. </summary>
  6574. </member>
  6575. <member name="P:MSBuild.Community.Tasks.Time.FormattedTime">
  6576. <summary>
  6577. Gets the value of this instance to its equivalent string representation.
  6578. If input parameter <see cref="P:MSBuild.Community.Tasks.Time.Format"/> is provided,
  6579. the value is formatted according to it.
  6580. </summary>
  6581. </member>
  6582. <member name="P:MSBuild.Community.Tasks.Time.ShortDate">
  6583. <summary>
  6584. Gets the value of this instance to its equivalent short date string representation.
  6585. </summary>
  6586. </member>
  6587. <member name="P:MSBuild.Community.Tasks.Time.LongDate">
  6588. <summary>
  6589. Gets the value of this instance to its equivalent long date string representation.
  6590. </summary>
  6591. </member>
  6592. <member name="P:MSBuild.Community.Tasks.Time.ShortTime">
  6593. <summary>
  6594. Gets the value of this instance to its equivalent short time string representation.
  6595. </summary>
  6596. </member>
  6597. <member name="P:MSBuild.Community.Tasks.Time.LongTime">
  6598. <summary>
  6599. Gets the value of this instance to its equivalent long time string representation.
  6600. </summary>
  6601. </member>
  6602. <member name="P:MSBuild.Community.Tasks.Time.DateTimeValue">
  6603. <summary>
  6604. Gets the internal time value.
  6605. </summary>
  6606. </member>
  6607. <member name="T:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem">
  6608. <summary>
  6609. Represents a single XmlNode selected using an XML task.
  6610. </summary>
  6611. <exclude />
  6612. </member>
  6613. <member name="M:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.#ctor(System.Xml.XPath.XPathNavigator,System.String)">
  6614. <summary>
  6615. Initializes a new instance of an XmlNodeTaskItem
  6616. </summary>
  6617. <param name="xpathNavigator">The selected XmlNode</param>
  6618. <param name="reservedMetaDataPrefix">The prefix to attach to the reserved metadata properties.</param>
  6619. </member>
  6620. <member name="M:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.ToString">
  6621. <summary>
  6622. Returns a string representation of the XmlNodeTaskItem.
  6623. </summary>
  6624. <returns></returns>
  6625. </member>
  6626. <member name="M:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.op_Explicit(MSBuild.Community.Tasks.Xml.XmlNodeTaskItem)~System.String">
  6627. <summary>
  6628. Returns the ItemSpec when the XmlNodeTaskItem is explicitly cast as a <see cref="T:System.String"/>
  6629. </summary>
  6630. <param name="taskItemToCast">The XmlNodeTaskItem</param>
  6631. <returns></returns>
  6632. </member>
  6633. <member name="M:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.CloneCustomMetadata">
  6634. <summary>
  6635. </summary>
  6636. <returns></returns>
  6637. </member>
  6638. <member name="M:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.CopyMetadataTo(Microsoft.Build.Framework.ITaskItem)">
  6639. <summary>
  6640. </summary>
  6641. <param name="destinationItem"></param>
  6642. </member>
  6643. <member name="M:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.GetMetadata(System.String)">
  6644. <summary>
  6645. </summary>
  6646. <param name="metadataName"></param>
  6647. <returns></returns>
  6648. </member>
  6649. <member name="M:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.RemoveMetadata(System.String)">
  6650. <summary>
  6651. </summary>
  6652. <param name="metadataName"></param>
  6653. </member>
  6654. <member name="M:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.SetMetadata(System.String,System.String)">
  6655. <summary>
  6656. </summary>
  6657. <param name="metadataName"></param>
  6658. <param name="metadataValue"></param>
  6659. </member>
  6660. <member name="P:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.ItemSpec">
  6661. <summary>
  6662. </summary>
  6663. </member>
  6664. <member name="P:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.MetadataCount">
  6665. <summary>
  6666. </summary>
  6667. </member>
  6668. <member name="P:MSBuild.Community.Tasks.Xml.XmlNodeTaskItem.MetadataNames">
  6669. <summary>
  6670. </summary>
  6671. </member>
  6672. <member name="T:MSBuild.Community.Tasks.Xml.XmlQuery">
  6673. <summary>
  6674. Reads a value or values from lines of XML
  6675. </summary>
  6676. <remarks>
  6677. Use the Lines property (possibly populated from the the ReadLinesFromFile task) if you want to perform multiple
  6678. queries against some XML in memory. Use the XmlFileName property to query a large XML file.
  6679. <para>
  6680. An XPath expression can return multiple nodes in the <see cref="P:MSBuild.Community.Tasks.Xml.XmlQuery.Values"/> collection.
  6681. The number of nodes returned is availabe in the <see cref="P:MSBuild.Community.Tasks.Xml.XmlQuery.ValuesCount"/> output TaskParameter.
  6682. </para>
  6683. <para>
  6684. When the XPath expression resolves to an element node, all of the
  6685. attributes of the element are added as metadata to the returned <see cref="T:Microsoft.Build.Framework.ITaskItem"/>.
  6686. In addition, some reserved metadata properties are available on all element nodes.
  6687. They are all prefixed with the <see cref="P:MSBuild.Community.Tasks.Xml.XmlQuery.ReservedMetaDataPrefix"/>,
  6688. which is a single underscore (_) by default.
  6689. <list type="table">
  6690. <listheader>
  6691. <term>Reserved Property</term>
  6692. </listheader>
  6693. <item>
  6694. <term>_value</term>
  6695. <description>The value of the node (non-xml text between the opening and closing tags).</description>
  6696. </item>
  6697. <item>
  6698. <term>_innerXml</term>
  6699. <description>The markup representing the children of this node.</description>
  6700. </item>
  6701. <item>
  6702. <term>_outerXml</term>
  6703. <description>The markup representing this node and all its child nodes.</description>
  6704. </item>
  6705. </list>
  6706. </para>
  6707. </remarks><example>
  6708. Read an attribute value by selecting it with an XPath expression:
  6709. <code>
  6710. <![CDATA[
  6711. <ReadLinesFromFile File="web.config">
  6712. <Output TaskParameter="Lines" ItemName="FileContents" />
  6713. </ReadLinesFromFile>
  6714. <XmlQuery Lines="@(FileContents)"
  6715. XPath = "/configuration/system.web/compilation/@defaultLanguage">
  6716. <Output TaskParameter="Values" PropertyName="CompilationLanguage" />
  6717. </XmlQuery>
  6718. <Message Text="The default language is $(CompilationLanguage)." />
  6719. ]]>
  6720. </code>
  6721. </example><example>
  6722. Read attribute values (from an XML file) using item metadata on a selected element node:
  6723. <code>
  6724. <![CDATA[
  6725. <XmlQuery XmlFileName="$(MSBuildProjectDirectory)\web.config"
  6726. XPath = "/configuration/system.web/compilation">
  6727. <Output TaskParameter="Values" ItemName="CompilationElement" />
  6728. </XmlQuery>
  6729. <Message Text="The default language is: $(CompilationElement.defaultLanguage)." />
  6730. <Message Text="Debug is enabled: $(CompilationElement.debug)." />
  6731. ]]>
  6732. </code>
  6733. </example><example>
  6734. Read an element value (requires use of the reserved metadata property "_value"):
  6735. <code>
  6736. <![CDATA[
  6737. <ReadLinesFromFile File="web.config">
  6738. <Output TaskParameter="Lines" ItemName="FileContents" />
  6739. </ReadLinesFromFile>
  6740. <XmlQuery Lines="@(FileContents)"
  6741. XPath = "/configuration/singleValue/LastName">
  6742. <Output TaskParameter="Values" PropertyName="LastNameElement" />
  6743. </XmlQuery>
  6744. <Message Text="The last name is %(LastNameElement._value)" />
  6745. ]]>
  6746. </code>
  6747. </example>
  6748. </member>
  6749. <member name="M:MSBuild.Community.Tasks.Xml.XmlQuery.Execute">
  6750. <summary>
  6751. When overridden in a derived class, executes the task.
  6752. </summary>
  6753. <returns>
  6754. True if the task successfully executed; otherwise, false.
  6755. </returns>
  6756. </member>
  6757. <member name="P:MSBuild.Community.Tasks.Xml.XmlQuery.Lines">
  6758. <summary>
  6759. The lines of a valid XML document
  6760. </summary>
  6761. </member>
  6762. <member name="P:MSBuild.Community.Tasks.Xml.XmlQuery.XmlFileName">
  6763. <summary>
  6764. Gets or sets the name of an XML file to query
  6765. </summary>
  6766. <value>The full path of the XML file.</value>
  6767. </member>
  6768. <member name="P:MSBuild.Community.Tasks.Xml.XmlQuery.NamespaceDefinitions">
  6769. <summary>
  6770. A collection of prefix=namespace definitions used to query the XML document
  6771. </summary>
  6772. <example>
  6773. Defining multiple namespaces:
  6774. <code>
  6775. <![CDATA[
  6776. <XmlMassUpdate ContentFile="web.config"
  6777. SubstitutionsRoot="/configuration/substitutions"
  6778. NamespaceDefinitions = "soap=http://www.w3.org/2001/12/soap-envelope;x=http://www.w3.org/1999/XSL/Transform">
  6779. />]]>
  6780. </code>
  6781. </example>
  6782. </member>
  6783. <member name="P:MSBuild.Community.Tasks.Xml.XmlQuery.XPath">
  6784. <summary>
  6785. The query used to identify the values in the XML document
  6786. </summary>
  6787. </member>
  6788. <member name="P:MSBuild.Community.Tasks.Xml.XmlQuery.Values">
  6789. <summary>
  6790. The values selected by <see cref="P:MSBuild.Community.Tasks.Xml.XmlQuery.XPath"/>
  6791. </summary>
  6792. </member>
  6793. <member name="P:MSBuild.Community.Tasks.Xml.XmlQuery.ValuesCount">
  6794. <summary>
  6795. The number of values returned in <see cref="P:MSBuild.Community.Tasks.Xml.XmlQuery.Values"/>
  6796. </summary>
  6797. </member>
  6798. <member name="P:MSBuild.Community.Tasks.Xml.XmlQuery.ReservedMetaDataPrefix">
  6799. <summary>
  6800. The string that is prepended to all reserved metadata properties.
  6801. </summary>
  6802. <remarks>The default value is a single underscore: '_'
  6803. <para>All attributes of an element node are added as metadata to the returned ITaskItem,
  6804. so this property can be used to avoid clashes with the reserved properties.
  6805. For example, if you selected the following node:
  6806. <code><![CDATA[ <SomeNode _name="x" _value="y" /> ]]></code>
  6807. the <c>_value</c> attribute would clash with the <c>value</c> reserved property, when using
  6808. the default prefix. If you set the ReservedMetaDataPrefix to another value (two underscores '__')
  6809. there would be no clash. You would be able to select the attribute using <c>%(item._value)</c>
  6810. and the value of the node using <c>%(item.__value)</c>.</para></remarks>
  6811. </member>
  6812. <member name="T:MSBuild.Community.Tasks.Xml.XmlTaskHelper">
  6813. <summary>
  6814. Provides methods used by all of the XML tasks
  6815. </summary>
  6816. <exclude />
  6817. </member>
  6818. <member name="M:MSBuild.Community.Tasks.Xml.XmlTaskHelper.JoinItems(Microsoft.Build.Framework.ITaskItem[])">
  6819. <summary>
  6820. Concatenates the string value of a list of ITaskItems into a single string
  6821. </summary>
  6822. <param name="items">The items to concatenate</param>
  6823. <returns>A single string containing the values from all of the items</returns>
  6824. </member>
  6825. <member name="M:MSBuild.Community.Tasks.Xml.XmlTaskHelper.LoadNamespaceDefinitionItems(System.Xml.XmlNamespaceManager,Microsoft.Build.Framework.ITaskItem[])">
  6826. <summary>
  6827. Uses the prefix=namespace definitions in <paramref name="definitions"/> to populate <paramref name="namespaceManager"/>
  6828. </summary>
  6829. <param name="namespaceManager">The <see cref="T:System.Xml.XmlNamespaceManager"/> to populate.</param>
  6830. <param name="definitions">The prefix=namespace definitions.</param>
  6831. </member>
  6832. <member name="T:MSBuild.Community.Tasks.Xslt">
  6833. <summary>
  6834. A task to merge and transform a set of xml files.
  6835. </summary>
  6836. <remarks>
  6837. <p>
  6838. The xml files of parameter <see cref="P:MSBuild.Community.Tasks.Xslt.Inputs"/>
  6839. are merged into one xml document,
  6840. wrapped with a root tag <see cref="P:MSBuild.Community.Tasks.Xslt.RootTag"/>
  6841. </p>
  6842. <p>
  6843. If only one input file is provided,
  6844. merging and wrapping can be omitted
  6845. by setting <see cref="P:MSBuild.Community.Tasks.Xslt.RootTag"/> to an empty string.
  6846. </p>
  6847. <p>
  6848. The root tag can be given any number of attributes
  6849. by providing a list of semicolon-delimited name/value pairs
  6850. to parameter <see cref="P:MSBuild.Community.Tasks.Xslt.RootAttributes"/>.
  6851. For example: <code>RootAttributes="foo=bar;date=$(buildDate)"</code>
  6852. </p>
  6853. <p>
  6854. Parameter <see cref="P:MSBuild.Community.Tasks.Xslt.RootAttributes"/> defaults to
  6855. one attribute with a name specified by <see cref="F:MSBuild.Community.Tasks.Xslt.CreatedAttributeName"/>,
  6856. and a local time stamp as value.
  6857. To suppress the default value, an empty parameter
  6858. <code>RootAttributes=""</code>
  6859. must be specified explicitely.
  6860. </p>
  6861. <p>
  6862. The xsl transformation file
  6863. specified by parameter <see cref="P:MSBuild.Community.Tasks.Xslt.Xsl"/>
  6864. is applied on the input.
  6865. </p>
  6866. <p>
  6867. The <see cref="T:Microsoft.Build.Framework.ITaskItem"/> <see cref="P:MSBuild.Community.Tasks.Xslt.Xsl"/>
  6868. can be given any number of metadata,
  6869. which will be handed to the xsl transformation
  6870. as parameters.
  6871. </p>
  6872. <p>
  6873. If only one input file is given with <see cref="T:Microsoft.Build.Framework.ITaskItem"/> <see cref="P:MSBuild.Community.Tasks.Xslt.Inputs"/>,
  6874. metadata will also be handed to the xsl transformation.
  6875. However, the <see cref="P:MSBuild.Community.Tasks.Xslt.Xsl"/> metadata is preferred in case of equal names.
  6876. To overcome this limitation, for each input item metadatum, an additional parameter
  6877. prefixed with <see cref="F:MSBuild.Community.Tasks.Xslt.InputMetadataArgumentPrefix"/> is created.
  6878. </p>
  6879. <p>
  6880. The output is written to the file
  6881. specified by parameter <see cref="P:MSBuild.Community.Tasks.Xslt.Output"/>.
  6882. </p>
  6883. </remarks><example>
  6884. This example for generating a report
  6885. from a set of NUnit xml results:
  6886. <code>
  6887. <![CDATA[
  6888. <ItemGroup>
  6889. <nunitReportXslFile Include="$(MSBuildCommunityTasksPath)\$(nunitReportXsl)">
  6890. <project>$(project)</project>
  6891. <configuration>$(configuration)</configuration>
  6892. <msbuildFilename>$(MSBuildProjectFullPath)</msbuildFilename>
  6893. <msbuildBinpath>$(MSBuildBinPath)</msbuildBinpath>
  6894. <xslFile>$(MSBuildCommunityTasksPath)\$(nunitReportXsl)</xslFile>
  6895. </nunitReportXslFile>
  6896. </ItemGroup>
  6897. <Target Name="test-report" >
  6898. <Xslt Inputs="@(nunitFiles)"
  6899. RootTag="mergedroot"
  6900. Xsl="@(nunitReportXslFile)"
  6901. Output="$(testDir)\TestReport.html" />
  6902. </Target>]]>
  6903. </code>
  6904. This examples shows all available task attributes:
  6905. <code>
  6906. <![CDATA[
  6907. <Time Format="yyyyMMddHHmmss">
  6908. <Output TaskParameter="LocalTimestamp" PropertyName="buildDate" />
  6909. </Time>
  6910. <Xslt
  6911. Inputs="@(xmlfiles)"
  6912. RootTag="mergedroot"
  6913. RootAttributes="foo=bar;date=$(buildDate)"
  6914. Xsl="transformation.xsl"
  6915. Output="report.html"
  6916. />]]>
  6917. </code>
  6918. </example>
  6919. </member>
  6920. <member name="F:MSBuild.Community.Tasks.Xslt.CreatedAttributeName">
  6921. <summary>
  6922. The name of the default attribute
  6923. of the <see cref="P:MSBuild.Community.Tasks.Xslt.RootTag"/>.
  6924. The value is <c>"created"</c>,
  6925. and the attribute will contain a local time stamp.
  6926. </summary>
  6927. </member>
  6928. <member name="F:MSBuild.Community.Tasks.Xslt.InputMetadataArgumentPrefix">
  6929. <summary>
  6930. The prefix of XSLT parameters created from single XML input metadata.
  6931. <para>The value is <c>"input_"</c>.</para>
  6932. </summary>
  6933. </member>
  6934. <member name="M:MSBuild.Community.Tasks.Xslt.Execute">
  6935. <summary>
  6936. When overridden in a derived class, executes the task.
  6937. </summary>
  6938. <returns>
  6939. Returns <c>true</c> if the task successfully executed; otherwise, <c>false</c>.
  6940. </returns>
  6941. </member>
  6942. <member name="M:MSBuild.Community.Tasks.Xslt.AddParameter(System.String,System.String,System.Xml.Xsl.XsltArgumentList)">
  6943. <summary>
  6944. Adds a new xsl parameter with to the specified argument list.
  6945. </summary>
  6946. <param name="name">The name of the parameter.</param>
  6947. <param name="value">The value of the parameter.</param>
  6948. <param name="parameters">The parameter list.</param>
  6949. <returns>Whether the parameter was added.</returns>
  6950. <remarks>Does not add the parameter
  6951. when a parameter with the same name is already part of the <paramref name="parameters"/>.</remarks>
  6952. </member>
  6953. <member name="P:MSBuild.Community.Tasks.Xslt.Inputs">
  6954. <summary>
  6955. Gets or sets the xml input files.
  6956. </summary>
  6957. </member>
  6958. <member name="P:MSBuild.Community.Tasks.Xslt.RootTag">
  6959. <summary>
  6960. Gets or sets the xml tag name
  6961. of the root tag wrapped
  6962. around the merged xml input files.
  6963. </summary>
  6964. </member>
  6965. <member name="P:MSBuild.Community.Tasks.Xslt.RootAttributes">
  6966. <summary>
  6967. Gets or sets the list of
  6968. semicolon-delimited name/value pairs
  6969. of the <see cref="P:MSBuild.Community.Tasks.Xslt.RootTag"/>.
  6970. For example: <code>RootAttributes="foo=bar;date=$(buildDate)"</code>
  6971. </summary>
  6972. </member>
  6973. <member name="P:MSBuild.Community.Tasks.Xslt.Xsl">
  6974. <summary>
  6975. Gets or sets the path of the
  6976. xsl transformation file to apply.
  6977. </summary>
  6978. <remarks>
  6979. The property can be given any number of metadata,
  6980. which will be handed to the xsl transformation
  6981. as parameters.
  6982. </remarks>
  6983. </member>
  6984. <member name="P:MSBuild.Community.Tasks.Xslt.Output">
  6985. <summary>
  6986. Gets or sets the path of the output file.
  6987. </summary>
  6988. </member>
  6989. <member name="T:MSBuild.Community.Tasks.FileUpdate">
  6990. <summary>
  6991. Replace text in file(s) using a Regular Expression.
  6992. </summary>
  6993. <example>Search for a version number and update the revision.
  6994. <code><![CDATA[
  6995. <FileUpdate Files="version.txt"
  6996. Regex="(\d+)\.(\d+)\.(\d+)\.(\d+)"
  6997. ReplacementText="$1.$2.$3.123" />
  6998. ]]></code>
  6999. </example>
  7000. </member>
  7001. <member name="M:MSBuild.Community.Tasks.FileUpdate.#ctor">
  7002. <summary>
  7003. Initializes a new instance of the <see cref="T:FileUpdate"/> class.
  7004. </summary>
  7005. </member>
  7006. <member name="F:MSBuild.Community.Tasks.FileUpdate._useDefaultEncoding">
  7007. Maintain the behaviour of the original implementation for compatibility
  7008. (i.e. initialize _useDefaultEncoding with false) and use utf-8-without-bom,
  7009. which is Microsoft's default encoding, only when Encoding property is set
  7010. to "utf-8-without-bom".
  7011. </member>
  7012. <member name="M:MSBuild.Community.Tasks.FileUpdate.Execute">
  7013. <summary>
  7014. When overridden in a derived class, executes the task.
  7015. </summary>
  7016. <returns>
  7017. true if the task successfully executed; otherwise, false.
  7018. </returns>
  7019. </member>
  7020. <member name="P:MSBuild.Community.Tasks.FileUpdate.Files">
  7021. <summary>
  7022. Gets or sets the files to update.
  7023. </summary>
  7024. <value>The files.</value>
  7025. </member>
  7026. <member name="P:MSBuild.Community.Tasks.FileUpdate.Regex">
  7027. <summary>
  7028. Gets or sets the regex.
  7029. </summary>
  7030. <value>The regex.</value>
  7031. </member>
  7032. <member name="P:MSBuild.Community.Tasks.FileUpdate.IgnoreCase">
  7033. <summary>
  7034. Gets or sets a value specifies case-insensitive matching. .
  7035. </summary>
  7036. <value><c>true</c> if [ignore case]; otherwise, <c>false</c>.</value>
  7037. </member>
  7038. <member name="P:MSBuild.Community.Tasks.FileUpdate.Multiline">
  7039. <summary>
  7040. Gets or sets a value changing the meaning of ^ and $ so they match at the beginning and end,
  7041. respectively, of any line, and not just the beginning and end of the entire string.
  7042. </summary>
  7043. <value><c>true</c> if multiline; otherwise, <c>false</c>.</value>
  7044. </member>
  7045. <member name="P:MSBuild.Community.Tasks.FileUpdate.Singleline">
  7046. <summary>
  7047. Gets or sets a value changing the meaning of the dot (.) so it matches
  7048. every character (instead of every character except \n).
  7049. </summary>
  7050. <value><c>true</c> if singleline; otherwise, <c>false</c>.</value>
  7051. </member>
  7052. <member name="P:MSBuild.Community.Tasks.FileUpdate.ReplacementCount">
  7053. <summary>
  7054. Gets or sets the maximum number of times the replacement can occur.
  7055. </summary>
  7056. <value>The replacement count.</value>
  7057. </member>
  7058. <member name="P:MSBuild.Community.Tasks.FileUpdate.ReplacementText">
  7059. <summary>
  7060. Gets or sets the replacement text.
  7061. </summary>
  7062. <value>The replacement text.</value>
  7063. </member>
  7064. <member name="P:MSBuild.Community.Tasks.FileUpdate.Encoding">
  7065. <summary>
  7066. The character encoding used to read and write the file.
  7067. </summary>
  7068. <remarks>Any value returned by <see cref="P:System.Text.Encoding.WebName"/> is valid input.
  7069. <para>The default is <c>utf-8</c></para>
  7070. <para>Additionally, <c>utf-8-without-bom</c>can be used.</para></remarks>
  7071. </member>
  7072. <member name="P:MSBuild.Community.Tasks.FileUpdate.WarnOnNoUpdate">
  7073. <summary>
  7074. When TRUE, a warning will be generated to show which file was not updated.
  7075. </summary>
  7076. <remarks>N/A</remarks>
  7077. </member>
  7078. <member name="T:MSBuild.Community.Tasks.FxCop">
  7079. <summary>
  7080. Uses FxCop to analyse managed code assemblies and reports on
  7081. their design best-practice compliance.
  7082. </summary>
  7083. <example>
  7084. <para>Shows how to analyse an assembly and use an XSLT stylesheet
  7085. to present the report as an HTML file. If the static anlysis fails,
  7086. the build does not stop - this is controlled with the <c>FailOnError</c>
  7087. parameter.</para>
  7088. <code><![CDATA[
  7089. <FxCop
  7090. TargetAssemblies="$(MSBuildCommunityTasksPath)\MSBuild.Community.Tasks.dll"
  7091. RuleLibraries="@(FxCopRuleAssemblies)"
  7092. Rules="Microsoft.Design#CA1012;-Microsoft.Performance#CA1805"
  7093. AnalysisReportFileName="Test.html"
  7094. DependencyDirectories="$(MSBuildCommunityTasksPath)"
  7095. FailOnError="False"
  7096. ApplyOutXsl="True"
  7097. OutputXslFileName="C:\Program Files\Microsoft FxCop 1.32\Xml\FxCopReport.xsl"
  7098. />
  7099. ]]></code>
  7100. </example>
  7101. <remarks>If you include the <c>MSBuild.Community.Tasks.Targets</c> file
  7102. in you build project, the ItemGroup <c>@(FxCopRuleAssemblies)</c> is defined
  7103. with the standard FxCop Rules Assemblies.</remarks>
  7104. </member>
  7105. <member name="M:MSBuild.Community.Tasks.FxCop.Execute">
  7106. <summary>
  7107. Executes the task.
  7108. </summary>
  7109. <returns><see langword="true"/> if the task ran successfully;
  7110. otherwise <see langword="false"/>.</returns>
  7111. </member>
  7112. <member name="M:MSBuild.Community.Tasks.FxCop.GenerateFullPathToTool">
  7113. <summary>
  7114. Returns the fully qualified path to the executable file.
  7115. </summary>
  7116. <returns>
  7117. The fully qualified path to the executable file.
  7118. </returns>
  7119. </member>
  7120. <member name="M:MSBuild.Community.Tasks.FxCop.GenerateCommandLineCommands">
  7121. <summary>
  7122. Returns a string value containing the command line arguments
  7123. to pass directly to the executable file.
  7124. </summary>
  7125. <returns>
  7126. A string value containing the command line arguments to pass
  7127. directly to the executable file.
  7128. </returns>
  7129. </member>
  7130. <member name="M:MSBuild.Community.Tasks.FxCop.ValidateParameters">
  7131. <summary>
  7132. Indicates whether all task paratmeters are valid.
  7133. </summary>
  7134. <returns>true if all task parameters are valid; otherwise, false</returns>
  7135. </member>
  7136. <member name="M:MSBuild.Community.Tasks.FxCop.GetWorkingDirectory">
  7137. <summary>
  7138. Returns the directory in which to run the executable file.
  7139. </summary>
  7140. <returns>
  7141. The directory in which to run the executable file,
  7142. or a null reference (Nothing in Visual Basic) if the executable file
  7143. should be run in the current directory.
  7144. </returns>
  7145. </member>
  7146. <member name="P:MSBuild.Community.Tasks.FxCop.SearchGac">
  7147. <summary>
  7148. Tells FxCop to search the GAC for assembly references. This parameter was added in FxCop 1.35
  7149. </summary>
  7150. </member>
  7151. <member name="P:MSBuild.Community.Tasks.FxCop.ApplyOutXsl">
  7152. <summary>
  7153. Applies the XSL transformation specified in /outXsl to the
  7154. analysis report before saving the file.
  7155. </summary>
  7156. </member>
  7157. <member name="P:MSBuild.Community.Tasks.FxCop.DirectOutputToConsole">
  7158. <summary>
  7159. Directs analysis output to the console or to the
  7160. Output window in Visual Studio .NET. By default,
  7161. the XSL file FxCopConsoleOutput.xsl is applied to the
  7162. output before it is displayed.
  7163. </summary>
  7164. </member>
  7165. <member name="P:MSBuild.Community.Tasks.FxCop.DependencyDirectories">
  7166. <summary>
  7167. Specifies additional directories to search for assembly dependencies.
  7168. FxCopCmd always searches the target assembly directory and the current
  7169. working directory.
  7170. </summary>
  7171. </member>
  7172. <member name="P:MSBuild.Community.Tasks.FxCop.TargetAssemblies">
  7173. <summary>
  7174. Specifies the target assembly to analyze.
  7175. </summary>
  7176. </member>
  7177. <member name="P:MSBuild.Community.Tasks.FxCop.ConsoleXslFileName">
  7178. <summary>
  7179. Specifies the XSL or XSLT file that contains a transformation to
  7180. be applied to the analysis output before it is displayed in the console.
  7181. </summary>
  7182. </member>
  7183. <member name="P:MSBuild.Community.Tasks.FxCop.ImportFiles">
  7184. <summary>
  7185. Specifies the name of an analysis report or project file to import.
  7186. Any messages in the imported file that are marked as excluded are not
  7187. included in the analysis results.
  7188. </summary>
  7189. </member>
  7190. <member name="P:MSBuild.Community.Tasks.FxCop.CustomDictionary">
  7191. <summary>
  7192. Specifies the custom dictionary.
  7193. </summary>
  7194. </member>
  7195. <member name="P:MSBuild.Community.Tasks.FxCop.RuleLibraries">
  7196. <summary>
  7197. Specifies the filename(s) of FxCop rule assemblies
  7198. </summary>
  7199. </member>
  7200. <member name="P:MSBuild.Community.Tasks.FxCop.Rules">
  7201. <summary>
  7202. The list of rules to run
  7203. </summary>
  7204. <remarks>Rule names should be provided using the format Library#RuleNumber. For example <c>Microsoft.Design#CA1012</c>
  7205. <para>Place a single hyphen (-) in front of the rule name to exclude it. For example <c>-Microsoft.Performance#CA1805</c></para>
  7206. </remarks>
  7207. </member>
  7208. <member name="P:MSBuild.Community.Tasks.FxCop.AnalysisReportFileName">
  7209. <summary>
  7210. Specifies the file name for the analysis report.
  7211. </summary>
  7212. </member>
  7213. <member name="P:MSBuild.Community.Tasks.FxCop.OutputXslFileName">
  7214. <summary>
  7215. Specifies the XSL or XSLT file that is referenced by the
  7216. xml-stylesheet processing instruction in the analysis report.
  7217. </summary>
  7218. </member>
  7219. <member name="P:MSBuild.Community.Tasks.FxCop.PlatformDirectory">
  7220. <summary>
  7221. Specifies the location of the version of Mscorlib.dll
  7222. that was used when building the target assemblies if this
  7223. version is not installed on the computer running FxCopCmd.
  7224. </summary>
  7225. </member>
  7226. <member name="P:MSBuild.Community.Tasks.FxCop.ProjectFile">
  7227. <summary>
  7228. Specifies the filename of FxCop project file.
  7229. </summary>
  7230. </member>
  7231. <member name="P:MSBuild.Community.Tasks.FxCop.IncludeSummaryReport">
  7232. <summary>
  7233. Includes a summary report with the informational
  7234. messages returned by FxCopCmd.
  7235. </summary>
  7236. </member>
  7237. <member name="P:MSBuild.Community.Tasks.FxCop.TypeList">
  7238. <summary>
  7239. Comma-separated list of type names to analyze. This option disables
  7240. analysis of assemblies, namespaces, and resources; only the specified
  7241. types and their members are included in the analysis.
  7242. Use the wildcard character '*' at the end of the name to select multiple types.
  7243. </summary>
  7244. </member>
  7245. <member name="P:MSBuild.Community.Tasks.FxCop.SaveResults">
  7246. <summary>
  7247. Saves the results of the analysis in the project file.
  7248. </summary>
  7249. </member>
  7250. <member name="P:MSBuild.Community.Tasks.FxCop.WorkingDirectory">
  7251. <summary>
  7252. Gets or sets the working directory.
  7253. </summary>
  7254. <value>The working directory.</value>
  7255. <returns>
  7256. The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
  7257. </returns>
  7258. </member>
  7259. <member name="P:MSBuild.Community.Tasks.FxCop.Verbose">
  7260. <summary>
  7261. Gets or sets a value indicating whether the output is verbose.
  7262. </summary>
  7263. <value><c>true</c> if verbose; otherwise, <c>false</c>.</value>
  7264. </member>
  7265. <member name="P:MSBuild.Community.Tasks.FxCop.FailOnError">
  7266. <summary>
  7267. Gets or sets a value indicating whether the build should
  7268. fail if static code analysis reports errors. Defaults to
  7269. <c>true</c>.
  7270. </summary>
  7271. <value><c>true</c> if verbose; otherwise, <c>false</c>.</value>
  7272. </member>
  7273. <member name="P:MSBuild.Community.Tasks.FxCop.ToolName">
  7274. <summary>
  7275. Gets the name of the executable file to run.
  7276. </summary>
  7277. <value></value>
  7278. <returns>The name of the executable file to run.</returns>
  7279. </member>
  7280. <member name="T:MSBuild.Community.Tasks.ServiceActions">
  7281. <summary>
  7282. Defines the actions that can be performed on a service.
  7283. </summary>
  7284. </member>
  7285. <member name="F:MSBuild.Community.Tasks.ServiceActions.Start">
  7286. <summary>
  7287. Starts a service.
  7288. </summary>
  7289. </member>
  7290. <member name="F:MSBuild.Community.Tasks.ServiceActions.Stop">
  7291. <summary>
  7292. Stops a service.
  7293. </summary>
  7294. </member>
  7295. <member name="F:MSBuild.Community.Tasks.ServiceActions.Restart">
  7296. <summary>
  7297. Restarts a service.
  7298. </summary>
  7299. </member>
  7300. <member name="F:MSBuild.Community.Tasks.ServiceActions.Pause">
  7301. <summary>
  7302. Pauses a running service.
  7303. </summary>
  7304. </member>
  7305. <member name="F:MSBuild.Community.Tasks.ServiceActions.Continue">
  7306. <summary>
  7307. Continues a paused service.
  7308. </summary>
  7309. </member>
  7310. <member name="T:MSBuild.Community.Tasks.ServiceController">
  7311. <summary>
  7312. Task that can control a Windows service.
  7313. </summary>
  7314. <example>
  7315. <para>Restart Web Server</para>
  7316. <code><![CDATA[
  7317. <ServiceController ServiceName="w3svc" Action="Restart" />
  7318. ]]></code>
  7319. </example>
  7320. </member>
  7321. <member name="T:MSBuild.Community.Tasks.ServiceQuery">
  7322. <summary>
  7323. Task that can determine the status of a specified service
  7324. on a target server.
  7325. </summary>
  7326. <example>
  7327. <para>Check status of SQL Server</para>
  7328. <code><![CDATA[
  7329. <ServiceQuery ServiceName="MSSQLServer">
  7330. <Output TaskParameter="Status" PropertyName="ResultStatus" />
  7331. </ServiceQuery>
  7332. <Message Text="MSSQLServer Service Status: $(ResultStatus)"/>
  7333. ]]></code>
  7334. </example>
  7335. </member>
  7336. <member name="F:MSBuild.Community.Tasks.ServiceQuery.UNKNOWN_STATUS">
  7337. <summary>
  7338. The unknown <see cref="P:MSBuild.Community.Tasks.ServiceQuery.Status"/>
  7339. returned when the service does not exist.
  7340. The value is "Unknown".
  7341. </summary>
  7342. </member>
  7343. <member name="M:MSBuild.Community.Tasks.ServiceQuery.#ctor">
  7344. <summary>
  7345. Initializes a new instance of the <see cref="T:ServiceQuery"/> class.
  7346. </summary>
  7347. </member>
  7348. <member name="M:MSBuild.Community.Tasks.ServiceQuery.Execute">
  7349. <summary>
  7350. Executes the task.
  7351. </summary>
  7352. <returns><see langword="true"/> if the task ran successfully;
  7353. otherwise <see langword="false"/>.</returns>
  7354. </member>
  7355. <member name="M:MSBuild.Community.Tasks.ServiceQuery.GetServiceController">
  7356. <summary>
  7357. Gets the service controller.
  7358. </summary>
  7359. <returns></returns>
  7360. </member>
  7361. <member name="P:MSBuild.Community.Tasks.ServiceQuery.ServiceName">
  7362. <summary>
  7363. Gets or sets the name of the service.
  7364. </summary>
  7365. <value>The name of the service.</value>
  7366. </member>
  7367. <member name="P:MSBuild.Community.Tasks.ServiceQuery.MachineName">
  7368. <summary>
  7369. Gets or sets the name of the machine.
  7370. </summary>
  7371. <value>The name of the machine.</value>
  7372. </member>
  7373. <member name="P:MSBuild.Community.Tasks.ServiceQuery.Status">
  7374. <summary>
  7375. Gets or sets the status.
  7376. </summary>
  7377. <value>The status of the service.</value>
  7378. </member>
  7379. <member name="P:MSBuild.Community.Tasks.ServiceQuery.CanPauseAndContinue">
  7380. <summary>
  7381. Gets a value indicating whether the service can be paused and resumed.
  7382. </summary>
  7383. <value>
  7384. <c>true</c> if this instance can pause and continue; otherwise, <c>false</c>.
  7385. </value>
  7386. </member>
  7387. <member name="P:MSBuild.Community.Tasks.ServiceQuery.CanShutdown">
  7388. <summary>
  7389. Gets a value indicating whether the service should be notified when the system is shutting down.
  7390. </summary>
  7391. <value>
  7392. <c>true</c> if this instance can shutdown; otherwise, <c>false</c>.
  7393. </value>
  7394. </member>
  7395. <member name="P:MSBuild.Community.Tasks.ServiceQuery.CanStop">
  7396. <summary>
  7397. Gets a value indicating whether the service can be stopped after it has started.
  7398. </summary>
  7399. <value><c>true</c> if this instance can stop; otherwise, <c>false</c>.</value>
  7400. </member>
  7401. <member name="P:MSBuild.Community.Tasks.ServiceQuery.DisplayName">
  7402. <summary>
  7403. Gets a friendly name for the service.
  7404. </summary>
  7405. <value>The name of the display.</value>
  7406. </member>
  7407. <member name="P:MSBuild.Community.Tasks.ServiceQuery.Exists">
  7408. <summary>
  7409. Gets a value indicating whether the service exists.
  7410. </summary>
  7411. <value><c>true</c> if the service exists; otherwise, <c>false</c>.</value>
  7412. </member>
  7413. <member name="M:MSBuild.Community.Tasks.ServiceController.#ctor">
  7414. <summary>
  7415. Initializes a new instance of the <see cref="T:ServiceController"/> class.
  7416. </summary>
  7417. </member>
  7418. <member name="M:MSBuild.Community.Tasks.ServiceController.Execute">
  7419. <summary>
  7420. Executes the task.
  7421. </summary>
  7422. <returns><see langword="true"/> if the task ran successfully;
  7423. otherwise <see langword="false"/>.</returns>
  7424. </member>
  7425. <member name="P:MSBuild.Community.Tasks.ServiceController.Action">
  7426. <summary>
  7427. Gets or sets the <see cref="T:ServiceActions"/> to perform on the service.
  7428. </summary>
  7429. <value>The action to perform on the service.</value>
  7430. <enum cref="T:MSBuild.Community.Tasks.ServiceActions"/>
  7431. </member>
  7432. <member name="P:MSBuild.Community.Tasks.ServiceController.Timeout">
  7433. <summary>
  7434. Gets or sets the timeout for the command. The default is
  7435. one minute.
  7436. </summary>
  7437. <value>The timeout for the command.</value>
  7438. </member>
  7439. <member name="T:MSBuild.Community.Tasks.IIS.AppPoolCreate">
  7440. <summary>
  7441. Creates a new application pool on a local or remote machine with IIS installed. The default is
  7442. to create the new application pool on the local machine. If connecting to a remote machine, you can
  7443. specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the task
  7444. to run under.
  7445. </summary>
  7446. <example>Create a new application pool on the local machine.
  7447. <code><![CDATA[
  7448. <AppPoolCreate AppPoolName="MyAppPool" />
  7449. ]]></code>
  7450. </example>
  7451. </member>
  7452. <member name="M:MSBuild.Community.Tasks.IIS.AppPoolCreate.Execute">
  7453. <summary>
  7454. When overridden in a derived class, executes the task.
  7455. </summary>
  7456. <returns>
  7457. True if the task successfully executed; otherwise, false.
  7458. </returns>
  7459. </member>
  7460. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.ApplicationPoolName">
  7461. <summary>
  7462. Gets or sets the name of the application pool.
  7463. </summary>
  7464. <value>The name of the application pool.</value>
  7465. </member>
  7466. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.AppPoolAutoStart">
  7467. <summary>
  7468. The AppPoolAutoStart property indicates to the World Wide Web Publishing Service (WWW service)
  7469. to automatically start an application pool when the application pool is created or when IIS
  7470. is started, if the value of this property is set to true.
  7471. </summary>
  7472. <value>Value indicating if AppPoolAutoStart is enabled or disabled.</value>
  7473. </member>
  7474. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.AppPoolIdentityType">
  7475. <summary>
  7476. The AppPoolIdentityType property allows application pools to run as a specific user account:
  7477. 0 - The application pool runs as NT AUTHORITY\SYSTEM.
  7478. 1 - The application pool runs as NT AUTHORITY\LOCAL SERVICE.
  7479. 2 - The application pool runs as NT AUTHORITY\NETWORK SERVICE.
  7480. 3 - The application pool runs as a specific user account, defined by the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.WAMUserName"/> property.
  7481. </summary>
  7482. <value>Value indicating the application pool identity type.</value>
  7483. </member>
  7484. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.AppPoolQueueLength">
  7485. <summary>
  7486. The AppPoolQueueLength property indicates to the Universal Listener how many requests
  7487. to queue up for an application pool before rejecting future requests. When the limit
  7488. for this property is exceeded, IIS rejects the additional requests with a 503 error.
  7489. </summary>
  7490. <value>Value indicating the application pool queue length.</value>
  7491. </member>
  7492. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.AutoShutdownAppPoolExe">
  7493. <summary>
  7494. The AutoShutdownAppPoolExe property specifies an executable to run when the World Wide Web
  7495. Publishing Service (WWW service) shuts down an application pool for rapid fail protection. You
  7496. can use the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.AutoShutdownAppPoolParams"/> property to send parameters to the executable.
  7497. </summary>
  7498. <value>Value indicating the application pool auto shutdown executable.</value>
  7499. </member>
  7500. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.AutoShutdownAppPoolParams">
  7501. <summary>
  7502. The AutoShutdownAppPoolParams property specifies any command-line parameters for the executable that
  7503. is specified in the AutoShutdownAppPoolExe property. You can use these two properties in the following
  7504. way to send e-mail, for example, when the World Wide Web Publishing Service (WWW service) shuts down
  7505. an application pool for rapid fail protection:
  7506. AutoShutdownAppPoolExe = "C:\LogAndSendMail.bat"
  7507. AutoShutdownAppPoolParams = "-AppPoolName %1%"
  7508. where %1% represents the application pool name.
  7509. </summary>
  7510. <value>Value indicating the parameters for the application pool auto shutdown executable.</value>
  7511. </member>
  7512. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.CPUAction">
  7513. <summary>
  7514. The CPUAction property configures the action(s) that IIS takes when Microsoft Windows NT ® job objects
  7515. run. Only one Windows NT job object exists per application pool, therefore the CPUAction property
  7516. is configured on a per application pool basis.
  7517. Possible values:
  7518. 0 - No action is taken except that a warning is written to the event log when the CPU limit is exceeded.
  7519. 1 - Application pool worker processes that exceed their CPU limit will be forced to shut down.
  7520. </summary>
  7521. <value>Value indicating the CPU action.</value>
  7522. </member>
  7523. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.CPULimit">
  7524. <summary>
  7525. The CPULimit property configures the maximum percentage of CPU resources that worker processes
  7526. in an application pool are allowed to consume over a period of time, as indicated by the
  7527. <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.CPUResetInterval"/> property. Set this property by specifying a percentage of CPU
  7528. usage, multiplied by 1000. For example, if you want the CPU usage limit to be 50%, set CPULimit to 50,000.
  7529. </summary>
  7530. <value>Value indicating the CPU limit.</value>
  7531. </member>
  7532. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.CPUResetInterval">
  7533. <summary>
  7534. The CPUResetInterval property specifies the reset period (in minutes) for CPU monitoring and
  7535. throttling limits on the application pool. When the number of minutes elapsed since the last
  7536. process accounting reset equals the number specified by this property, IIS will reset the CPU
  7537. timers for both the logging and limit intervals. Setting the value of this property to 0
  7538. disables CPU monitoring.
  7539. </summary>
  7540. <value>Value indicating the CPU reset interval.</value>
  7541. </member>
  7542. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.DisallowOverlappingRotation">
  7543. <summary>
  7544. The DisallowOverlappingRotation property specifies whether or not the World Wide Web Publishing
  7545. Service (WWW Service) should start up another worker process to replace the existing worker
  7546. process while it is shutting down.
  7547. </summary>
  7548. <value>Value indicating the DisallowOverlappingRotation.</value>
  7549. </member>
  7550. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.DisallowRotationOnConfigChange">
  7551. <summary>
  7552. The DisallowRotationOnConfigChange property specifies whether or not the World Wide Web Publishing
  7553. Service (WWW Service) should rotate worker processes in an application pool when the configuration
  7554. has changed. This means that the worker processes will not pick up application pool changes to
  7555. values passed to the worker process, such as <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.IdleTimeout"/> and <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PeriodicRestartRequests"/>.
  7556. </summary>
  7557. <value>Value indicating the DisallowRotationOnConfigChange.</value>
  7558. </member>
  7559. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.IdleTimeout">
  7560. <summary>
  7561. The IdleTimeout property specifies how long (in minutes) a worker process should run idle if no new
  7562. requests are received and the worker process is not processing requests. After the allotted time
  7563. passes, the worker process should request to be shut down by the World Wide Web Publishing Service (WWW Service).
  7564. </summary>
  7565. <value>Value indicating the idle timeout.</value>
  7566. </member>
  7567. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.LoadBalancerCapabilities">
  7568. <summary>
  7569. The LoadBalancerCapabilities property specifies behavior when a service is unavailable. A setting of 1
  7570. terminates the connection. A setting of 2 sends error code 503.
  7571. </summary>
  7572. <value>Value indicating the load balancer capabilities.</value>
  7573. </member>
  7574. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.LogEventOnRecycle">
  7575. <summary>
  7576. The LogEventOnRecycle property specifies that IIS should log an event when an application pool is
  7577. recycled. Application pools recycle for a variety of reasons. In order for IIS to log the event, the
  7578. LogEventOnRecycle property must have a bit set corresponding to the reason for the recycle.
  7579. </summary>
  7580. <value>Value indicating which recycle events to log.</value>
  7581. </member>
  7582. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.LogonMethod">
  7583. <summary>
  7584. The LogonMethod property contains an integer that specifies the logon method for cleartext
  7585. logons. Valid settings are:
  7586. 0 for interactive logon.
  7587. 1 for batch logon.
  7588. 2 for network logon.
  7589. 3 for cleartext logon.
  7590. </summary>
  7591. <value>Value indicating the logon method.</value>
  7592. </member>
  7593. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.MaxProcesses">
  7594. <summary>
  7595. The MaxProcesses property determines the maximum number of worker processes an application pool
  7596. allows to service requests for an application pool. This property cannot be set to 0 because there
  7597. are no unmanaged pools.
  7598. </summary>
  7599. <value>Value indicating the maximum number of worker processes allowed by the application pool.</value>
  7600. </member>
  7601. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.OrphanActionExe">
  7602. <summary>
  7603. The OrphanActionExe property specifies an executable to run when the World Wide Web Publishing
  7604. Service (WWW service) orphans a worker process. You can use the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.OrphanActionParams"/> property
  7605. to send parameters to the executable.
  7606. </summary>
  7607. <value>The value for the orphan action executable.</value>
  7608. </member>
  7609. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.OrphanActionParams">
  7610. <summary>
  7611. The OrphanActionParams property specifies command-line parameters for the executable
  7612. specified by the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.OrphanActionExe"/> property.
  7613. </summary>
  7614. <value>Value indicating the orphan action parameters.</value>
  7615. </member>
  7616. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.OrphanWorkerProcess">
  7617. <summary>
  7618. The OrphanWorkerProcess property, when set to true, notifies the World Wide Web Publishing
  7619. Service (WWW Service) not to terminate a worker process that fails to respond to pings, but
  7620. to instead orphan the worker process in the application pool if the worker process suffers
  7621. fatal errors.
  7622. </summary>
  7623. <value>Value indicating the orphan worker process.</value>
  7624. </member>
  7625. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PeriodicRestartMemory">
  7626. <summary>
  7627. The PeriodicRestartMemory property specifies the amount of virtual memory (in KB) that a
  7628. worker process can use before the worker process recycles. The maximum value supported
  7629. for this property is 4,294,967 KB.
  7630. </summary>
  7631. <value>Value indicating the amount of memory.</value>
  7632. </member>
  7633. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PeriodicRestartPrivateMemory">
  7634. <summary>
  7635. The PeriodicRestartPrivateMemory property specifies the amount of private memory (in KB) that a
  7636. worker process can use before the worker process recycles. The maximum value supported
  7637. for this property is 4,294,967 KB.
  7638. </summary>
  7639. <value>Value indicating the amount of memory.</value>
  7640. </member>
  7641. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PeriodicRestartRequests">
  7642. <summary>
  7643. The PeriodicRestartRequests property indicates the number of requests the OOP application
  7644. should process, after which it is recycled.
  7645. </summary>
  7646. <value>Value indicating the number of requests.</value>
  7647. </member>
  7648. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PeriodicRestartSchedule">
  7649. <summary>
  7650. The PeriodicRestartSchedule property specifies the time (in 24 hour format) that the application
  7651. will be rotated. Each time is in local time and is specified in the following format:
  7652. PeriodicRestartSchedule="hh:mm,hh:mm,hh:mm"
  7653. </summary>
  7654. <value>Value indicating the restart schedule.</value>
  7655. </member>
  7656. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PeriodicRestartTime">
  7657. <summary>
  7658. The PeriodicRestartTime property specifies the period of time, in minutes, after which IIS
  7659. rotates an isolated OOP application. Setting the value of this property to 0 disables the
  7660. property. The maximum supported value for this property is 71,582.
  7661. </summary>
  7662. <value>Value indicating the restart time period.</value>
  7663. </member>
  7664. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PingingEnabled">
  7665. <summary>
  7666. The PingingEnabled property specifies whether the World Wide Web Publishing Service
  7667. (WWW Service) should periodically monitor the health of a worker process. Setting the
  7668. value of this property to true indicates to the WWW service to monitor the worker
  7669. processes to ensure that the they are running and healthy.
  7670. </summary>
  7671. <value>Value indicating if pinging is enabled or disabled.</value>
  7672. </member>
  7673. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PingInterval">
  7674. <summary>
  7675. The PingInterval property specifies the period of time (in seconds) between health-monitoring
  7676. pings that the World Wide Web Publishing Service (WWW Service) sends to a worker process.
  7677. </summary>
  7678. <value>Value indicating the ping interval.</value>
  7679. </member>
  7680. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.PingResponseTime">
  7681. <summary>
  7682. The PingResponseTime property specifies the amount of time (in seconds) that a worker process
  7683. is given to respond to a health monitoring ping. After the time limit is exceeded, the World
  7684. Wide Web Publishing Service (WWW Service) terminates the worker process.
  7685. </summary>
  7686. <value>Value indicating the ping response time.</value>
  7687. </member>
  7688. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtection">
  7689. <summary>
  7690. Setting the RapidFailProtection property to true instructs the World Wide Web Publishing
  7691. Service (WWW service) to put all applications in an application pool out of service if the
  7692. number of worker process crashes has reached the maximum specified by the
  7693. <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtectionMaxCrashes"/> property, within the number of minutes specified
  7694. by the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtectionInterval"/> property.
  7695. </summary>
  7696. <value>Value indicating if rapid fail protection is enabled or disabled.</value>
  7697. </member>
  7698. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtectionInterval">
  7699. <summary>
  7700. The RapidFailProtectionInterval property specifies the number of minutes before the failure
  7701. count for a process is reset. See <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtection"/>.
  7702. </summary>
  7703. <value>Value indicating the rapid fail protection interval.</value>
  7704. </member>
  7705. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtectionMaxCrashes">
  7706. <summary>
  7707. The RapidFailProtectionMaxCrashes property specifies the maximum number of failures
  7708. allowed within the number of minutes specified by the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtectionInterval"/>
  7709. property. See <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.RapidFailProtection"/>.
  7710. </summary>
  7711. <value>Value indicating the maximum number of crashes.</value>
  7712. </member>
  7713. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.ShutdownTimeLimit">
  7714. <summary>
  7715. The ShutdownTimeLimit property specifies the amount of time (in seconds) after a recycle
  7716. threshold has been reached that IIS waits for all old requests to finish running in a worker
  7717. process before terminating the worker process.
  7718. </summary>
  7719. <value>Value indicating the shutdown time limit.</value>
  7720. </member>
  7721. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.SMPAffinitized">
  7722. <summary>
  7723. Setting the SMPAffinitized property to true indicates that a particular worker process
  7724. assigned to an application pool should be assigned to a given CPU. This property is used
  7725. in conjunction with the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.SMPProcessorAffinityMask"/> property to configure a
  7726. particular processor a worker process will be assigned to.
  7727. </summary>
  7728. <value>Value indicating if SMPAffinitized is enabled or disabled.</value>
  7729. </member>
  7730. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.SMPProcessorAffinityMask">
  7731. <summary>
  7732. The SMPProcessorAffinityMask property configures the hexadecimal processor mask. The hexadecimal
  7733. processor mask indicates to which CPU the worker processes in an application pool should be
  7734. bound. Before this property takes affect, the <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.SMPAffinitized"/> property must be set
  7735. to true for the application pool. These properties cannot be set through IIS Manager.
  7736. Do not set this property to zero. Doing so causes no SMP affinity to be configured, creating an
  7737. error condition. The default DWORD value is 4294967295 (or -1), which is represented in hexadecimal
  7738. as 0xFFFFFFFF. A value of 0xFFFFFFFF in SMPProcessorAffinityMask indicates that all processors are enabled.
  7739. </summary>
  7740. <value>Value indicating the SMP processor affinity bit mask.</value>
  7741. </member>
  7742. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.StartupTimeLimit">
  7743. <summary>
  7744. The value of the StartupTimeLimit property specifies the amount of time (in seconds) that the World Wide
  7745. Web Publishing Service (WWW Service) should wait for a worker process to finish starting up and
  7746. reporting to the WWW Service.
  7747. </summary>
  7748. <value>Value indicating the startup time limit.</value>
  7749. </member>
  7750. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.WAMUserName">
  7751. <summary>
  7752. The WAMUserName property specifies the account user name that IIS uses by default as the COM+
  7753. application identity for newly created IIS out-of-process applications. The values of this
  7754. property and its companion property, <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.WAMUserPass"/>, are set when IIS is installed, and
  7755. match the user name and password values in the Microsoft Windows user account, which is established
  7756. at the same time. Changing the value of this property is not recommended. If you do, change
  7757. it to a valid Windows user account, and change WAMUserPass to the corresponding password
  7758. for the new account.
  7759. Important:
  7760. Changes to WAMUserName and WAMUserPass may disrupt the operation of existing IIS out-of-process
  7761. applications. You can synchronize application identities using Component Services to edit the
  7762. user name and password values, found on the Identity tab of the property sheet for each package.
  7763. In-process applications are not affected by these property values.
  7764. </summary>
  7765. <value>Value indicating the username.</value>
  7766. </member>
  7767. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.WAMUserPass">
  7768. <summary>
  7769. The WAMUserPass property specifies the password for the account that IIS uses by default as the COM+
  7770. application identity for newly created IIS out-of-process applications. The values of this property
  7771. and its companion property, <see cref="P:MSBuild.Community.Tasks.IIS.AppPoolCreate.WAMUserName"/>, are set when IIS is installed, and match the
  7772. password and user name values in the Microsoft Windows user account (IWAM_ MachineName, where MachineName
  7773. is the name of the machine on which IIS is installed) established at the same time.
  7774. Important:
  7775. Changing the value of this property is not recommended. If you do, you must change the Windows account
  7776. password to the identical value. You must also synchronize existing IIS out-of-process application
  7777. identities, using Component Services to edit the user name and password values, which are found on the
  7778. Identity tab of the property sheet for each package.
  7779. In-process applications are not affected by these property values.
  7780. </summary>
  7781. <value>Value indicating the password.</value>
  7782. </member>
  7783. <member name="T:MSBuild.Community.Tasks.IIS.WebDirectoryCreate">
  7784. <summary>
  7785. Creates a new web directory on a local or remote machine with IIS installed. The default is
  7786. to create the new web directory on the local machine. The physical path is required to already exist
  7787. on the target machine. If connecting to a remote machine, you can specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/>
  7788. and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the task to run under.
  7789. </summary>
  7790. <example>Create a new web directory on the local machine.
  7791. <code><![CDATA[
  7792. <WebDirectoryCreate VirtualDirectoryName="MyVirDir"
  7793. VirtualDirectoryPhysicalPath="C:\Inetpub\MyWebDir" />
  7794. ]]></code>
  7795. </example>
  7796. </member>
  7797. <member name="M:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.Execute">
  7798. <summary>
  7799. When overridden in a derived class, executes the task.
  7800. </summary>
  7801. <returns>
  7802. True if the task successfully executed; otherwise, false.
  7803. </returns>
  7804. </member>
  7805. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.VirtualDirectoryName">
  7806. <summary>
  7807. Gets or sets the name of the virtual directory.
  7808. </summary>
  7809. <value>The name of the virtual directory.</value>
  7810. </member>
  7811. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.VirtualDirectoryPhysicalPath">
  7812. <summary>
  7813. Gets or sets the virtual directory physical path. The physical directory must
  7814. exist before this task executes.
  7815. </summary>
  7816. <value>The virtual directory physical path.</value>
  7817. </member>
  7818. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessExecute">
  7819. <summary>
  7820. Gets or sets a value that indicates if the file
  7821. or the contents of the folder may be executed, regardless of file type.
  7822. </summary>
  7823. <value>A value indicating if AccessExecute is enabled or disabled.</value>
  7824. </member>
  7825. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessNoRemoteExecute">
  7826. <summary>
  7827. A value of true indicates that remote requests to execute applications
  7828. are denied; only requests from the same computer as the IIS server succeed
  7829. if the AccessExecute property is set to true. You cannot set
  7830. AccessNoRemoteExecute to false to enable remote requests, and set
  7831. <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessExecute"/> to false to disable local requests.
  7832. </summary>
  7833. <value>Value indicating if AccessNoRemoteExecute is enabled or disabled.</value>
  7834. </member>
  7835. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessNoRemoteRead">
  7836. <summary>
  7837. A value of true indicates that remote requests to view files are denied; only
  7838. requests from the same computer as the IIS server succeed if the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessRead"/>
  7839. property is set to true. You cannot set <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessNoRemoteRead"/> to false to enable
  7840. remote requests, and set <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessRead"/> to false to disable local requests.
  7841. </summary>
  7842. <value>Value indicating if AccessNoRemoteRead is enabled or disabled.</value>
  7843. </member>
  7844. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessNoRemoteScript">
  7845. <summary>
  7846. A value of true indicates that remote requests to view dynamic content are denied; only
  7847. requests from the same computer as the IIS server succeed if the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessScript"/> property
  7848. is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests,
  7849. and set <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessScript"/> to false to disable local requests.
  7850. </summary>
  7851. <value>Value indicating if AccessNoRemoteScript is enabled or disabled.</value>
  7852. </member>
  7853. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessNoRemoteWrite">
  7854. <summary>
  7855. A value of true indicates that remote requests to create or change files are denied; only
  7856. requests from the same computer as the IIS server succeed if the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessWrite"/> property
  7857. is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests,
  7858. and set <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessWrite"/> to false to disable local requests.
  7859. </summary>
  7860. <value>Value indicating if AccessNoRemoteWrite is enabled or disabled.</value>
  7861. </member>
  7862. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessRead">
  7863. <summary>
  7864. A value of true indicates that the file or the contents of the folder may be read
  7865. through Microsoft Internet Explorer.
  7866. </summary>
  7867. <value>Value indicating if AccessRead is enabled or disabled.</value>
  7868. </member>
  7869. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSource">
  7870. <summary>
  7871. A value of true indicates that users are allowed to access source code if either
  7872. Read or Write permissions are set. Source code includes scripts in Microsoft ® Active
  7873. Server Pages (ASP) applications.
  7874. </summary>
  7875. <value>Value indicating if AccessSource is enabled or disabled.</value>
  7876. </member>
  7877. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessScript">
  7878. <summary>
  7879. A value of true indicates that the file or the contents of the folder may be executed
  7880. if they are script files or static content. A value of false only allows static files,
  7881. such as HTML files, to be served.
  7882. </summary>
  7883. <value>Value indicating if AccessScript is enabled or disabled.</value>
  7884. </member>
  7885. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSsl">
  7886. <summary>
  7887. A value of true indicates that file access requires SSL file permission processing, with
  7888. or without a client certificate.
  7889. </summary>
  7890. <value>Value indicating if AccessSsl is enabled or disabled.</value>
  7891. </member>
  7892. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSsl128">
  7893. <summary>
  7894. A value of true indicates that file access requires SSL file permission processing
  7895. with a minimum key size of 128 bits, with or without a client certificate.
  7896. </summary>
  7897. <value>Value indicating if AccessSsl128 is enabled or disabled.</value>
  7898. </member>
  7899. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslMapCert">
  7900. <summary>
  7901. A value of true indicates that SSL file permission processing maps a client certificate
  7902. to a Microsoft Windows ® operating system user-account. The <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslNegotiateCert"/> property
  7903. must also be set to true for the mapping to occur.
  7904. </summary>
  7905. <value>Value indicating if AccessSslMapCert is enabled or disabled.</value>
  7906. </member>
  7907. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslNegotiateCert">
  7908. <summary>
  7909. A value of true indicates that SSL file access processing requests a certificate from
  7910. the client. A value of false indicates that access continues if the client does not have
  7911. a certificate. Some versions of Internet Explorer will close the connection if the server
  7912. requests a certificate and a certificate is not available (even if <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslRequireCert"/>
  7913. is also set to true).
  7914. </summary>
  7915. <value>Value indicating if AccessSslNegotiateCert is enabled or disabled.</value>
  7916. </member>
  7917. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslRequireCert">
  7918. <summary>
  7919. A value of true indicates that SSL file access processing requests a certificate from the
  7920. client. If the client provides no certificate, the connection is closed. <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessSslNegotiateCert"/>
  7921. must also be set to true when using AccessSSLRequireCert.
  7922. </summary>
  7923. <value>Value indicating if AccessSslRequireCert is enabled or disabled.</value>
  7924. </member>
  7925. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AccessWrite">
  7926. <summary>
  7927. A value of true indicates that users are allowed to upload files and their associated
  7928. properties to the enabled directory on your server or to change content in a Write-enabled
  7929. file. Write can be implemented only with a browser that supports the PUT feature of
  7930. the HTTP 1.1 protocol standard.
  7931. </summary>
  7932. <value>Value indicating if AccessWrite is enabled or disabled.</value>
  7933. </member>
  7934. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AnonymousPasswordSync">
  7935. <summary>
  7936. The AnonymousPasswordSync property indicates whether IIS should handle the user password
  7937. for anonymous users attempting to access resources.
  7938. </summary>
  7939. <value>Value indicating if AnonymousPasswordSync is enabled or disabled.</value>
  7940. </member>
  7941. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AppAllowClientDebug">
  7942. <summary>
  7943. The AppAllowClientDebug property specifies whether ASP client-side debugging
  7944. is enabled. This property is independent of <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AppAllowDebugging"/>, which
  7945. applies to server-side debugging.
  7946. </summary>
  7947. <value>Value indicating if AppAllowClientDebug is enabled or disabled.</value>
  7948. </member>
  7949. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AppAllowDebugging">
  7950. <summary>
  7951. The AppAllowDebugging property specifies whether ASP debugging is enabled on
  7952. the server. This property is independent of the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AppAllowClientDebug"/> property,
  7953. which applies to client-side debugging.
  7954. </summary>
  7955. <value>Value indicating if AppAllowDebugging is enabled or disabled.</value>
  7956. </member>
  7957. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspAllowSessionState">
  7958. <summary>
  7959. The AspAllowSessionState property enables session state persistence for the ASP application.
  7960. </summary>
  7961. <value>Value indicating if the AspAllowSessionState is enabled or disabled.</value>
  7962. </member>
  7963. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspBufferingOn">
  7964. <summary>
  7965. The AspBufferingOn property specifies whether output from an ASP application will be buffered.
  7966. </summary>
  7967. <value>Value indicating if the AspBufferingOn is enabled or disabled.</value>
  7968. </member>
  7969. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspEnableApplicationRestart">
  7970. <summary>
  7971. The AspEnableApplicationRestart determines whether an ASP application can be
  7972. automatically restarted. When changes are made to Global.asa or metabase properties
  7973. that affect an application, the application will not restart unless the
  7974. AspEnableApplicationRestart property is set to true.
  7975. </summary>
  7976. <value>Value indicating if AspEnableApplicationRestart is enabled or disabled.</value>
  7977. </member>
  7978. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspEnableAspHtmlFallback">
  7979. <summary>
  7980. The AspEnableAspHtmlFallback property controls the behavior of ASP when a
  7981. new request is to be rejected due to a full request queue.
  7982. </summary>
  7983. <value>Value indicating if AspEnableAspHtmlFallback is enabled or disabled.</value>
  7984. </member>
  7985. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspEnableChunkedEncoding">
  7986. <summary>
  7987. The AspEnableChunkedEncoding property specifies whether HTTP 1.1 chunked
  7988. transfer encoding is enabled for the World Wide Web Publishing Service (WWW service).
  7989. </summary>
  7990. <value>Value indicating if AspEnableChunkedEncoding is enabled or disabled.</value>
  7991. </member>
  7992. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspErrorsToNTLog">
  7993. <summary>
  7994. The AspErrorsToNTLog property specifies which ASP errors are written to the
  7995. Windows event log. ASP errors are written to the client browser and to the IIS
  7996. log files by default.
  7997. </summary>
  7998. <value>Value indicating if AspErrorsToNTLog is enabled or disabled.</value>
  7999. </member>
  8000. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspEnableParentPaths">
  8001. <summary>
  8002. The AspEnableParentPaths property specifies whether an ASP page allows paths
  8003. relative to the current directory (using the ..\ notation) or above the current directory.
  8004. </summary>
  8005. <value>Value indicating if AspEnableParentPaths is enabled or disabled.</value>
  8006. </member>
  8007. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspEnableTypelibCache">
  8008. <summary>
  8009. The AspEnableTypelibCache property specifies whether type libraries are cached
  8010. on the server. The World Wide Web Publishing Service (WWW service) setting for
  8011. this property is applicable to all in-process and pooled out-of-process application
  8012. nodes, at all levels. Metabase settings at the Web server level or lower are ignored
  8013. for in-process and pooled out-of-process applications. However, settings at the Web
  8014. server level or lower are used if that node is an isolated out-of-process application.
  8015. </summary>
  8016. <value>Value indicating if AspEnableTypelibCache is enabled or disabled.</value>
  8017. </member>
  8018. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspExceptionCatchEnable">
  8019. <summary>
  8020. The AspExceptionCatchEnable property specifies whether ASP pages trap exceptions
  8021. thrown by components.
  8022. </summary>
  8023. <value>Value indicating if AspExceptionCatchEnable is enabled or disabled.</value>
  8024. </member>
  8025. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspLogErrorRequests">
  8026. <summary>
  8027. The AspLogErrorRequests property controls whether the Web server writes ASP errors
  8028. to the application section of the Windows event log. ASP errors are written to the
  8029. client browser and to the IIS log files by default.
  8030. </summary>
  8031. <value>Value indicating if AspLogErrorRequests is enabled or disabled.</value>
  8032. </member>
  8033. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspScriptErrorSentToBrowser">
  8034. <summary>
  8035. The AspScriptErrorSentToBrowser property specifies whether the Web server writes
  8036. debugging specifics (file name, error, line number, description) to the client
  8037. browser, in addition to logging them to the Windows Event Log. The <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspScriptErrorMessage"/>
  8038. property provides the error message to be sent if this property is set to false.
  8039. </summary>
  8040. <value>Value indicating if AspScriptErrorSentToBrowser is enabled or disabled.</value>
  8041. </member>
  8042. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspTrackThreadingModel">
  8043. <summary>
  8044. The AspTrackThreadingModel property specifies whether IIS checks the threading model
  8045. of any components (COM objects) that your application creates. The preferred setting
  8046. of this metabase property is false.
  8047. </summary>
  8048. <value>Value indicating if AspTrackThreadingModel is enabled or disabled.</value>
  8049. </member>
  8050. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AuthAnonymous">
  8051. <summary>
  8052. Specifies Anonymous authentication as one of the possible Windows authentication
  8053. schemes returned to clients as being available.
  8054. </summary>
  8055. <value>Value indicating if AuthAnonymous is enabled or disabled.</value>
  8056. </member>
  8057. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AuthBasic">
  8058. <summary>
  8059. Specifies Basic authentication as one of the possible Windows authentication
  8060. schemes returned to clients as being available.
  8061. </summary>
  8062. <value>Value indicating if AuthBasic is enabled or disabled.</value>
  8063. </member>
  8064. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AuthNtlm">
  8065. <summary>
  8066. Specifies Integrated Windows authentication (also known as Challenge/Response or
  8067. NTLM authentication) as one of the possible Windows authentication schemes
  8068. returned to clients as being available.
  8069. </summary>
  8070. <value>Value indicating if AuthNtlm is enabled or disabled.</value>
  8071. </member>
  8072. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AuthPersistSingleRequest">
  8073. <summary>
  8074. Setting this flag to true specifies that authentication persists only for a single
  8075. request on a connection. IIS resets the authentication at the end of each request, and
  8076. forces re-authentication on the next request of the session.
  8077. </summary>
  8078. <value>Value indicating if AuthPersistSingleRequest is enabled or disabled.</value>
  8079. </member>
  8080. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AuthPersistSingleRequestIfProxy">
  8081. <summary>
  8082. Setting this flag to true specifies authentication will persist only across single
  8083. requests on a connection if the connection is by proxy. IIS will reset the authentication
  8084. at the end of the request if the current authenticated request is by proxy and it is
  8085. not the special case where IIS is running MSPROXY.
  8086. </summary>
  8087. <value>Value indicating if AuthPersistSingleRequestIfProxy is enabled or disabled.</value>
  8088. </member>
  8089. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AuthPersistSingleRequestAlwaysIfProxy">
  8090. <summary>
  8091. Setting this flag to true specifies that authentication is valid for a single request if
  8092. by proxy. IIS will reset the authentication at the end of the request and force
  8093. re-authentication on the next request if the current authenticated request is by
  8094. proxy of any type.
  8095. </summary>
  8096. <value>Value indicating if AuthPersistSingleRequestAlwaysIfProxy is enabled or disabled.</value>
  8097. </member>
  8098. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CacheControlNoCache">
  8099. <summary>
  8100. The CacheControlNoCache property specifies the HTTP 1.1 directive to prevent caching of content.
  8101. </summary>
  8102. <value>Value indicating if CacheControlNoCache is enabled or disabled.</value>
  8103. </member>
  8104. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CacheIsapi">
  8105. <summary>
  8106. The CacheISAPI property indicates whether ISAPI extensions are cached in memory after first use.
  8107. </summary>
  8108. <value>Value indicating if CacheIsapi is enabled or disabled.</value>
  8109. </member>
  8110. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.ContentIndexed">
  8111. <summary>
  8112. The ContentIndexed property specifies whether the installed content indexer should
  8113. index content under this directory tree.
  8114. </summary>
  8115. <value>Value indicating if ContentIndexed is enabled or disabled.</value>
  8116. </member>
  8117. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CpuAppEnabled">
  8118. <summary>
  8119. This property specifies whether process accounting and throttling should be performed
  8120. for ISAPI extensions and ASP applications. To perform process accounting on CGI
  8121. applications, use the property <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CpuCgiEnabled"/>.
  8122. </summary>
  8123. <value>Value indicating if CpuAppEnabled is enabled or disabled.</value>
  8124. </member>
  8125. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CpuCgiEnabled">
  8126. <summary>
  8127. This property indicates whether IIS should perform process accounting for CGI
  8128. applications. To effectively throttle CGI applications, use the CgiTimeout
  8129. property. To use process accounting for ISAPI and ASP applications, use <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CpuAppEnabled"/>.
  8130. </summary>
  8131. <value>Value indicating if CpuCgiEnabled is enabled or disabled.</value>
  8132. </member>
  8133. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CreateCgiWithNewConsole">
  8134. <summary>
  8135. The CreateCGIWithNewConsole property indicates whether a CGI application runs in its own console.
  8136. </summary>
  8137. <value>Value indicating if CreateCgiWithNewConsole is enabled or disabled.</value>
  8138. </member>
  8139. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.CreateProcessAsUser">
  8140. <summary>
  8141. The CreateProcessAsUser property specifies whether a CGI process is created in the system context or in the context of the requesting user.
  8142. </summary>
  8143. <value>Value indicating if CreateProcessAsUser is enabled or disabled.</value>
  8144. </member>
  8145. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DirBrowseShowDate">
  8146. <summary>
  8147. When set to true, date information is displayed when browsing directories.
  8148. </summary>
  8149. <value>Value indicating if DirBrowseShowDate is enabled or disabled.</value>
  8150. </member>
  8151. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DirBrowseShowExtension">
  8152. <summary>
  8153. When set to true, file name extensions are displayed when browsing directories.
  8154. </summary>
  8155. <value>Value indicating if DirBrowseShowExtension is enabled or disabled.</value>
  8156. </member>
  8157. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DirBrowseShowLongDate">
  8158. <summary>
  8159. When set to true, date information is displayed in extended format when displaying directories.
  8160. </summary>
  8161. <value>Value indicating if DirBrowseShowLongDate is enabled or disabled.</value>
  8162. </member>
  8163. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DirBrowseShowSize">
  8164. <summary>
  8165. When set to true, file size information is displayed when browsing directories.
  8166. </summary>
  8167. <value>Value indicating if DirBrowseShowSize is enabled or disabled.</value>
  8168. </member>
  8169. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DirBrowseShowTime">
  8170. <summary>
  8171. When set to true, file time information is displayed when displaying directories.
  8172. </summary>
  8173. <value>Value indicating if DirBrowseShowTime is enabled or disabled.</value>
  8174. </member>
  8175. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DontLog">
  8176. <summary>
  8177. The DontLog property specifies whether client requests are written to the IIS log files.
  8178. </summary>
  8179. <value>Value indicating if DontLog is enabled or disabled.</value>
  8180. </member>
  8181. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.EnableDefaultDoc">
  8182. <summary>
  8183. When set to true, the default document (specified by the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DefaultDoc"/> property) for
  8184. a directory is loaded when the directory is browsed.
  8185. </summary>
  8186. <value>Value indicating if EnableDefaultDoc is enabled or disabled.</value>
  8187. </member>
  8188. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.EnableDirBrowsing">
  8189. <summary>
  8190. When set to true, directory browsing is enabled.
  8191. </summary>
  8192. <value>Value indicating if EnableDirBrowsing is enabled or disabled.</value>
  8193. </member>
  8194. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.EnableDocFooter">
  8195. <summary>
  8196. The EnableDocFooter property enables or disables custom footers specified by
  8197. the DefaultDocFooter property.
  8198. </summary>
  8199. <value>Value indicating if EnableDocFooter is enabled or disabled.</value>
  8200. </member>
  8201. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.EnableReverseDns">
  8202. <summary>
  8203. The EnableReverseDns property enables or disables reverse Domain Name Server (DNS) lookups
  8204. for the World Wide Web Publishing Service (WWW service). Reverse lookups involve looking
  8205. up the domain name when the IP address is known. Reverse DNS lookups can use significant
  8206. resources and time.
  8207. </summary>
  8208. <value>Value indicating if EnableReverseDns is enabled or disabled.</value>
  8209. </member>
  8210. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.SsiExecDisable">
  8211. <summary>
  8212. The SSIExecDisable property specifies whether server-side include (SSI) #exec directives
  8213. are disabled under this path.
  8214. </summary>
  8215. <value>Value indicating if SsiExecDisable is enabled or disabled.</value>
  8216. </member>
  8217. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.UncAuthenticationPassthrough">
  8218. <summary>
  8219. The UNCAuthenticationPassthrough property enables user authentication passthrough
  8220. for Universal Naming Convention (UNC) virtual root access (for authentication schemes
  8221. that support delegation).
  8222. </summary>
  8223. <value>Value indicating if UncAuthenticationPassthrough is enabled or disabled.</value>
  8224. </member>
  8225. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspScriptErrorMessage">
  8226. <summary>
  8227. The AspScriptErrorMessage property specifies the error message to send to the browser
  8228. if specific debugging errors are not sent to the client (if <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.AspScriptErrorSentToBrowser"/>
  8229. is set to false).
  8230. </summary>
  8231. <value>Value indicating if AspScriptErrorMessage is enabled or disabled.</value>
  8232. </member>
  8233. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.DefaultDoc">
  8234. <summary>
  8235. The DefaultDoc contains one or more file names of default documents that will be returned
  8236. to the client if no file name is included in the client's request. The default document
  8237. will be returned if the <see cref="P:MSBuild.Community.Tasks.IIS.WebDirectoryCreate.EnableDefaultDoc"/> flag of the DirBrowseFlags property
  8238. is set to true for the directory. This property can contain a list of default document
  8239. file names separated by a comma and a space, for example Default.htm, Default.asp.
  8240. </summary>
  8241. <value>Listing of the default documents for the web application.</value>
  8242. </member>
  8243. <member name="T:MSBuild.Community.Tasks.IIS.AppPoolDelete">
  8244. <summary>
  8245. Deletes an existing application pool on a local or remote machine with IIS installed. The default is
  8246. to delete an existing application pool on the local machine. If connecting to a remote machine, you can
  8247. specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the task
  8248. to run under.
  8249. </summary>
  8250. <example>Delete an existing application pool on the local machine.
  8251. <code><![CDATA[
  8252. <AppPoolDelete AppPoolName="MyAppPool" />
  8253. ]]></code>
  8254. </example>
  8255. </member>
  8256. <member name="M:MSBuild.Community.Tasks.IIS.AppPoolDelete.Execute">
  8257. <summary>
  8258. When overridden in a derived class, executes the task.
  8259. </summary>
  8260. <returns>
  8261. True if the task successfully executed; otherwise, false.
  8262. </returns>
  8263. </member>
  8264. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolDelete.ApplicationPoolName">
  8265. <summary>
  8266. Gets or sets the name of the application pool.
  8267. </summary>
  8268. <value>The name of the application pool.</value>
  8269. </member>
  8270. <member name="T:MSBuild.Community.Tasks.IIS.WebDirectoryDelete">
  8271. <summary>
  8272. Deletes a web directory on a local or remote machine with IIS installed. The default is
  8273. to delete the web directory on the local machine. If connecting to a remote machine, you
  8274. can specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the
  8275. task to run under.
  8276. </summary>
  8277. <example>Deletes a web directory on the local machine.
  8278. <code><![CDATA[
  8279. <WebDirectoryDelete VirtualDirectoryName="MyVirDir" />
  8280. ]]></code>
  8281. </example>
  8282. </member>
  8283. <member name="M:MSBuild.Community.Tasks.IIS.WebDirectoryDelete.Execute">
  8284. <summary>
  8285. When overridden in a derived class, executes the task.
  8286. </summary>
  8287. <returns>
  8288. True if the task successfully executed; otherwise, false.
  8289. </returns>
  8290. </member>
  8291. <member name="P:MSBuild.Community.Tasks.IIS.WebDirectoryDelete.VirtualDirectoryName">
  8292. <summary>
  8293. Gets or sets the name of the virtual directory.
  8294. </summary>
  8295. <value>The name of the virtual directory.</value>
  8296. </member>
  8297. <member name="T:MSBuild.Community.Tasks.IIS.AppPoolControllerActions">
  8298. <summary>
  8299. Actions the <see cref="T:MSBuild.Community.Tasks.IIS.AppPoolController"/> can do.
  8300. </summary>
  8301. </member>
  8302. <member name="F:MSBuild.Community.Tasks.IIS.AppPoolControllerActions.Start">
  8303. <summary>Start the applicaiton pool</summary>
  8304. </member>
  8305. <member name="F:MSBuild.Community.Tasks.IIS.AppPoolControllerActions.Stop">
  8306. <summary>Stop the applicaiton pool</summary>
  8307. </member>
  8308. <member name="F:MSBuild.Community.Tasks.IIS.AppPoolControllerActions.Restart">
  8309. <summary>Restart the applicaiton pool</summary>
  8310. </member>
  8311. <member name="F:MSBuild.Community.Tasks.IIS.AppPoolControllerActions.Recycle">
  8312. <summary>Recycle the applicaiton pool</summary>
  8313. </member>
  8314. <member name="T:MSBuild.Community.Tasks.IIS.AppPoolController">
  8315. <summary>
  8316. Allows control for an application pool on a local or remote machine with IIS installed. The default is
  8317. to control the application pool on the local machine. If connecting to a remote machine, you can
  8318. specify the <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Username"/> and <see cref="P:MSBuild.Community.Tasks.IIS.WebBase.Password"/> for the task
  8319. to run under.
  8320. </summary>
  8321. <example>Restart an application pool on the local machine.
  8322. <code><![CDATA[
  8323. <AppPoolController AppPoolName="MyAppPool" Action="Restart" />
  8324. ]]></code>
  8325. </example>
  8326. </member>
  8327. <member name="M:MSBuild.Community.Tasks.IIS.AppPoolController.Execute">
  8328. <summary>
  8329. When overridden in a derived class, executes the task.
  8330. </summary>
  8331. <returns>
  8332. True if the task successfully executed; otherwise, false.
  8333. </returns>
  8334. </member>
  8335. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolController.ApplicationPoolName">
  8336. <summary>
  8337. Gets or sets the name of the app pool.
  8338. </summary>
  8339. <value>The name of the app pool.</value>
  8340. </member>
  8341. <member name="P:MSBuild.Community.Tasks.IIS.AppPoolController.Action">
  8342. <summary>
  8343. Gets or sets the application pool action.
  8344. </summary>
  8345. <value>The application pool action.</value>
  8346. <enum cref="T:MSBuild.Community.Tasks.IIS.AppPoolControllerActions"/>
  8347. </member>
  8348. <member name="T:MSBuild.Community.Tasks.Mail">
  8349. <summary>
  8350. Sends an email message
  8351. </summary>
  8352. <example>Example of sending an email.
  8353. <code><![CDATA[
  8354. <Target Name="Mail">
  8355. <Mail SmtpServer="localhost"
  8356. To="user@email.com"
  8357. From="from@email.com"
  8358. Subject="Test Mail Task"
  8359. Body="This is a test of the mail task." />
  8360. </Target>
  8361. ]]></code>
  8362. </example>
  8363. </member>
  8364. <member name="M:MSBuild.Community.Tasks.Mail.#ctor">
  8365. <summary>
  8366. Initializes a new instance of the <see cref="T:Mail"/> class.
  8367. </summary>
  8368. </member>
  8369. <member name="M:MSBuild.Community.Tasks.Mail.Execute">
  8370. <summary>Sends an email message</summary>
  8371. <returns>Returns true if successful</returns>
  8372. </member>
  8373. <member name="P:MSBuild.Community.Tasks.Mail.Attachments">
  8374. <summary>
  8375. List of files to attach to message
  8376. </summary>
  8377. </member>
  8378. <member name="P:MSBuild.Community.Tasks.Mail.Bcc">
  8379. <summary>
  8380. List of addresss that contains the blind carbon copy (BCC) recipients for this e-mail message
  8381. </summary>
  8382. </member>
  8383. <member name="P:MSBuild.Community.Tasks.Mail.CC">
  8384. <summary>
  8385. List of addresss that contains the carbon copy (CC) recipients for this e-mail message
  8386. </summary>
  8387. </member>
  8388. <member name="P:MSBuild.Community.Tasks.Mail.Body">
  8389. <summary>
  8390. The email message body
  8391. </summary>
  8392. </member>
  8393. <member name="P:MSBuild.Community.Tasks.Mail.From">
  8394. <summary>
  8395. The from address for this e-mail message
  8396. </summary>
  8397. <remarks>
  8398. This property is required.
  8399. </remarks>
  8400. </member>
  8401. <member name="P:MSBuild.Community.Tasks.Mail.IsBodyHtml">
  8402. <summary>
  8403. A value indicating whether the mail message body is in Html
  8404. </summary>
  8405. </member>
  8406. <member name="P:MSBuild.Community.Tasks.Mail.Priority">
  8407. <summary>
  8408. The priority of this e-mail message
  8409. </summary>
  8410. <remarks>
  8411. Possible values are High, Normal, and Low
  8412. </remarks>
  8413. </member>
  8414. <member name="P:MSBuild.Community.Tasks.Mail.Subject">
  8415. <summary>
  8416. The subject line for this e-mail message
  8417. </summary>
  8418. <remarks>
  8419. This property is required.
  8420. </remarks>
  8421. </member>
  8422. <member name="P:MSBuild.Community.Tasks.Mail.SmtpServer">
  8423. <summary>
  8424. The name or IP address of the host used for SMTP transactions
  8425. </summary>
  8426. <remarks>
  8427. This property is required.
  8428. </remarks>
  8429. </member>
  8430. <member name="P:MSBuild.Community.Tasks.Mail.To">
  8431. <summary>
  8432. List of addresss that contains the recipients of this e-mail message
  8433. </summary>
  8434. <remarks>
  8435. This property is required.
  8436. </remarks>
  8437. </member>
  8438. <member name="P:MSBuild.Community.Tasks.Mail.Username">
  8439. <summary>
  8440. Gets or sets the username.
  8441. </summary>
  8442. <value>The username.</value>
  8443. </member>
  8444. <member name="P:MSBuild.Community.Tasks.Mail.Password">
  8445. <summary>
  8446. Gets or sets the password.
  8447. </summary>
  8448. <value>The password.</value>
  8449. </member>
  8450. <member name="P:MSBuild.Community.Tasks.Mail.EnableSsl">
  8451. <summary>
  8452. Specify whether the Mail task uses SSL to encrypt the connection.
  8453. </summary>
  8454. <value><c>true</c> if the Mail task uses SSL; otherwise <c>false</c>. The default value is <c>false</c>.</value>
  8455. </member>
  8456. <member name="T:MSBuild.Community.Tasks.Math.Add">
  8457. <summary>
  8458. Add numbers
  8459. </summary>
  8460. <example>Adding numbers:
  8461. <code><![CDATA[
  8462. <Math.Add Numbers="4;3">
  8463. <Output TaskParameter="Result" PropertyName="Result" />
  8464. </Math.Add>
  8465. <Message Text="Add 4+3= $(Result)"/>
  8466. ]]></code>
  8467. </example>
  8468. </member>
  8469. <member name="M:MSBuild.Community.Tasks.Math.Add.Execute">
  8470. <summary>
  8471. When overridden in a derived class, executes the task.
  8472. </summary>
  8473. <returns>
  8474. true if the task successfully executed; otherwise, false.
  8475. </returns>
  8476. </member>
  8477. <member name="T:MSBuild.Community.Tasks.Math.Divide">
  8478. <summary>
  8479. Divide numbers
  8480. </summary>
  8481. <example>
  8482. <code>
  8483. <![CDATA[
  8484. <Math.Divide Numbers="1;2">
  8485. <Output TaskParameter="Result" PropertyName="Result" />
  8486. </Math.Divide>
  8487. <Message Text="Divide 1/2= $(Result)"/>
  8488. ]]>
  8489. </code>
  8490. Above example will display:
  8491. <code>Divide 1/2= 0.5</code>
  8492. </example><example>
  8493. Truncate the result to always return an integer:
  8494. <code>
  8495. <![CDATA[
  8496. <Math.Divide Numbers="7;3" TruncateResult="true">
  8497. <Output TaskParameter="Result" PropertyName="Result" />
  8498. </Math.Divide>
  8499. <Message Text="Divide 7/3= $(Result)"/>
  8500. ]]>
  8501. </code>
  8502. Above example will display:
  8503. <code>Divide 7/3= 2</code>
  8504. </example>
  8505. </member>
  8506. <member name="M:MSBuild.Community.Tasks.Math.Divide.Execute">
  8507. <summary>
  8508. When overridden in a derived class, executes the task.
  8509. </summary>
  8510. <returns>
  8511. true if the task successfully executed; otherwise, false.
  8512. </returns>
  8513. </member>
  8514. <member name="P:MSBuild.Community.Tasks.Math.Divide.TruncateResult">
  8515. <summary>
  8516. When <see langword="true"/>, uses integer division to truncate the result. Default is <see langword="false" />
  8517. </summary>
  8518. <remarks>
  8519. Any remainder in the result is dropped, and the closest integer to zero is returned.
  8520. <para>
  8521. Refer to the documentation for the <see href="http://msdn2.microsoft.com/library/0e16fywh.aspx">\ Operator</see>
  8522. for more information about integer division.
  8523. </para>
  8524. </remarks>
  8525. </member>
  8526. <member name="T:MSBuild.Community.Tasks.Math.Multiple">
  8527. <summary>
  8528. Multiple numbers
  8529. </summary>
  8530. <example>
  8531. <code><![CDATA[
  8532. <Math.Multiple Numbers="10;3">
  8533. <Output TaskParameter="Result" PropertyName="Result" />
  8534. </Math.Multiple>
  8535. <Message Text="Multiple 10*3= $(Result)"/>
  8536. ]]></code>
  8537. </example>
  8538. </member>
  8539. <member name="M:MSBuild.Community.Tasks.Math.Multiple.Execute">
  8540. <summary>
  8541. When overridden in a derived class, executes the task.
  8542. </summary>
  8543. <returns>
  8544. true if the task successfully executed; otherwise, false.
  8545. </returns>
  8546. </member>
  8547. <member name="T:MSBuild.Community.Tasks.Math.Subtract">
  8548. <summary>
  8549. Subtract numbers
  8550. </summary>
  8551. <example>
  8552. <code><![CDATA[
  8553. <Math.Subtract Numbers="10;3">
  8554. <Output TaskParameter="Result" PropertyName="Result" />
  8555. </Math.Subtract>
  8556. <Message Text="Subtract 10-3= $(Result)"/>
  8557. ]]></code>
  8558. </example>
  8559. </member>
  8560. <member name="M:MSBuild.Community.Tasks.Math.Subtract.Execute">
  8561. <summary>
  8562. When overridden in a derived class, executes the task.
  8563. </summary>
  8564. <returns>
  8565. true if the task successfully executed; otherwise, false.
  8566. </returns>
  8567. </member>
  8568. <member name="T:MSBuild.Community.Tasks.Move">
  8569. <summary>
  8570. Moves files on the filesystem to a new location.
  8571. </summary>
  8572. <example>
  8573. <para>Move a file to another folder</para>
  8574. <code><![CDATA[
  8575. <Move SourceFiles="Test\MoveMe.txt"
  8576. DestinationFolder="Test\Move" />
  8577. ]]></code>
  8578. <para>Rename a file</para>
  8579. <code><![CDATA[
  8580. <Move SourceFiles="Test\Move\MoveMe.txt"
  8581. DestinationFiles="Test\Move\Renamed.txt" />
  8582. ]]></code>
  8583. </example>
  8584. </member>
  8585. <member name="M:MSBuild.Community.Tasks.Move.Execute">
  8586. <summary>
  8587. When overridden in a derived class, executes the task.
  8588. </summary>
  8589. <returns>
  8590. true if the task successfully executed; otherwise, false.
  8591. </returns>
  8592. </member>
  8593. <member name="P:MSBuild.Community.Tasks.Move.MovedFiles">
  8594. <summary>
  8595. Gets the items that were successfully moved.
  8596. </summary>
  8597. <value>The moved files.</value>
  8598. </member>
  8599. <member name="P:MSBuild.Community.Tasks.Move.DestinationFiles">
  8600. <summary>
  8601. Gets or sets the list of files to moved the source files to.
  8602. </summary>
  8603. <remarks>
  8604. This list is expected to be a one-to-one mapping with the
  8605. list specified in the SourceFiles parameter. That is, the
  8606. first file specified in SourceFiles will be moved to the
  8607. first location specified in DestinationFiles, and so forth.
  8608. </remarks>
  8609. <value>The destination files.</value>
  8610. </member>
  8611. <member name="P:MSBuild.Community.Tasks.Move.DestinationFolder">
  8612. <summary>
  8613. Gets or sets the directory to which you want to move the files.
  8614. </summary>
  8615. <value>The destination folder.</value>
  8616. </member>
  8617. <member name="P:MSBuild.Community.Tasks.Move.SourceFiles">
  8618. <summary>
  8619. Gets or sets the source files to move.
  8620. </summary>
  8621. <value>The source files to move.</value>
  8622. </member>
  8623. <member name="T:MSBuild.Community.Tasks.NDoc">
  8624. <summary>
  8625. Runs the NDoc application.
  8626. </summary>
  8627. <example>Generated html help file.
  8628. <code><![CDATA[
  8629. <NDoc Documenter="MSDN"
  8630. ProjectFilePath="MSBuild.Community.Tasks.ndoc" />
  8631. ]]></code>
  8632. </example>
  8633. </member>
  8634. <member name="M:MSBuild.Community.Tasks.NDoc.#ctor">
  8635. <summary>
  8636. Initializes a new instance of the <see cref="T:NDoc"/> class.
  8637. </summary>
  8638. </member>
  8639. <member name="M:MSBuild.Community.Tasks.NDoc.GenerateCommandLineCommands">
  8640. <summary>
  8641. Returns a string value containing the command line arguments to pass directly to the executable file.
  8642. </summary>
  8643. <returns>
  8644. A string value containing the command line arguments to pass directly to the executable file.
  8645. </returns>
  8646. </member>
  8647. <member name="M:MSBuild.Community.Tasks.NDoc.GenerateFullPathToTool">
  8648. <summary>
  8649. Returns the fully qualified path to the executable file.
  8650. </summary>
  8651. <returns>
  8652. The fully qualified path to the executable file.
  8653. </returns>
  8654. </member>
  8655. <member name="M:MSBuild.Community.Tasks.NDoc.LogToolCommand(System.String)">
  8656. <summary>
  8657. Logs the starting point of the run to all registered loggers.
  8658. </summary>
  8659. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  8660. </member>
  8661. <member name="M:MSBuild.Community.Tasks.NDoc.GetWorkingDirectory">
  8662. <summary>
  8663. Returns the directory in which to run the executable file.
  8664. </summary>
  8665. <returns>
  8666. The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
  8667. </returns>
  8668. </member>
  8669. <member name="P:MSBuild.Community.Tasks.NDoc.Documenter">
  8670. <summary>
  8671. Gets or sets the documenter.
  8672. </summary>
  8673. <value>The documenter.</value>
  8674. <remarks>Available documenters are VS.NET_2003, JavaDoc, LaTeX, LinearHtml, MSDN, XML.</remarks>
  8675. </member>
  8676. <member name="P:MSBuild.Community.Tasks.NDoc.ProjectFilePath">
  8677. <summary>
  8678. Gets or sets the project file path.
  8679. </summary>
  8680. <value>The project file path.</value>
  8681. </member>
  8682. <member name="P:MSBuild.Community.Tasks.NDoc.Verbose">
  8683. <summary>
  8684. Gets or sets a value indicating whether the output is verbose.
  8685. </summary>
  8686. <value><c>true</c> if verbose; otherwise, <c>false</c>.</value>
  8687. </member>
  8688. <member name="P:MSBuild.Community.Tasks.NDoc.WorkingDirectory">
  8689. <summary>
  8690. Gets or sets the working directory.
  8691. </summary>
  8692. <value>The working directory.</value>
  8693. <returns>
  8694. The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
  8695. </returns>
  8696. </member>
  8697. <member name="P:MSBuild.Community.Tasks.NDoc.ToolName">
  8698. <summary>
  8699. Gets the name of the executable file to run.
  8700. </summary>
  8701. <value></value>
  8702. <returns>The name of the executable file to run.</returns>
  8703. </member>
  8704. <member name="P:MSBuild.Community.Tasks.NDoc.StandardOutputLoggingImportance">
  8705. <summary>
  8706. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  8707. </summary>
  8708. <value></value>
  8709. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  8710. </member>
  8711. <member name="T:MSBuild.Community.Tasks.NUnit">
  8712. <summary>
  8713. Run NUnit 2.4 on a group of assemblies.
  8714. </summary>
  8715. <example>Run NUnit tests.
  8716. <code><![CDATA[
  8717. <ItemGroup>
  8718. <TestAssembly Include="C:\Program Files\NUnit 2.4\bin\*.tests.dll" />
  8719. </ItemGroup>
  8720. <Target Name="NUnit">
  8721. <NUnit Assemblies="@(TestAssembly)" />
  8722. </Target>
  8723. ]]></code>
  8724. </example>
  8725. </member>
  8726. <member name="F:MSBuild.Community.Tasks.NUnit.DEFAULT_NUNIT_DIRECTORY">
  8727. <summary>
  8728. The default relative path of the NUnit installation.
  8729. The value is <c>@"NUnit 2.4\bin"</c>.
  8730. </summary>
  8731. </member>
  8732. <member name="M:MSBuild.Community.Tasks.NUnit.#ctor">
  8733. <summary>
  8734. Initializes a new instance of the <see cref="T:NUnit"/> class.
  8735. </summary>
  8736. </member>
  8737. <member name="M:MSBuild.Community.Tasks.NUnit.GenerateCommandLineCommands">
  8738. <summary>
  8739. Returns a string value containing the command line arguments to pass directly to the executable file.
  8740. </summary>
  8741. <returns>
  8742. A string value containing the command line arguments to pass directly to the executable file.
  8743. </returns>
  8744. </member>
  8745. <member name="M:MSBuild.Community.Tasks.NUnit.GenerateFullPathToTool">
  8746. <summary>
  8747. Returns the fully qualified path to the executable file.
  8748. </summary>
  8749. <returns>
  8750. The fully qualified path to the executable file.
  8751. </returns>
  8752. </member>
  8753. <member name="M:MSBuild.Community.Tasks.NUnit.LogToolCommand(System.String)">
  8754. <summary>
  8755. Logs the starting point of the run to all registered loggers.
  8756. </summary>
  8757. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  8758. </member>
  8759. <member name="M:MSBuild.Community.Tasks.NUnit.GetWorkingDirectory">
  8760. <summary>
  8761. Returns the directory in which to run the executable file.
  8762. </summary>
  8763. <returns>
  8764. The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
  8765. </returns>
  8766. </member>
  8767. <member name="P:MSBuild.Community.Tasks.NUnit.Assemblies">
  8768. <summary>
  8769. Gets or sets the assemblies.
  8770. </summary>
  8771. <value>The assemblies.</value>
  8772. </member>
  8773. <member name="P:MSBuild.Community.Tasks.NUnit.IncludeCategory">
  8774. <summary>
  8775. Gets or sets the categories to include.
  8776. </summary>
  8777. <remarks>Multiple values must be separated by a comma ","</remarks>
  8778. </member>
  8779. <member name="P:MSBuild.Community.Tasks.NUnit.ExcludeCategory">
  8780. <summary>
  8781. Gets or sets the categories to exclude.
  8782. </summary>
  8783. <remarks>Multiple values must be separated by a comma ","</remarks>
  8784. </member>
  8785. <member name="P:MSBuild.Community.Tasks.NUnit.Fixture">
  8786. <summary>
  8787. Gets or sets the fixture.
  8788. </summary>
  8789. <value>The fixture.</value>
  8790. </member>
  8791. <member name="P:MSBuild.Community.Tasks.NUnit.XsltTransformFile">
  8792. <summary>
  8793. Gets or sets the XSLT transform file.
  8794. </summary>
  8795. <value>The XSLT transform file.</value>
  8796. </member>
  8797. <member name="P:MSBuild.Community.Tasks.NUnit.OutputXmlFile">
  8798. <summary>
  8799. Gets or sets the output XML file.
  8800. </summary>
  8801. <value>The output XML file.</value>
  8802. </member>
  8803. <member name="P:MSBuild.Community.Tasks.NUnit.ErrorOutputFile">
  8804. <summary>
  8805. The file to receive test error details.
  8806. </summary>
  8807. </member>
  8808. <member name="P:MSBuild.Community.Tasks.NUnit.WorkingDirectory">
  8809. <summary>
  8810. Gets or sets the working directory.
  8811. </summary>
  8812. <value>The working directory.</value>
  8813. <returns>
  8814. The directory in which to run the executable file, or a null reference (Nothing in Visual Basic) if the executable file should be run in the current directory.
  8815. </returns>
  8816. </member>
  8817. <member name="P:MSBuild.Community.Tasks.NUnit.DisableShadowCopy">
  8818. <summary>
  8819. Determines whether assemblies are copied to a shadow folder during testing.
  8820. </summary>
  8821. <remarks>Shadow copying is enabled by default. If you want to test the assemblies "in place",
  8822. you must set this property to <c>True</c>.</remarks>
  8823. </member>
  8824. <member name="P:MSBuild.Community.Tasks.NUnit.ProjectConfiguration">
  8825. <summary>
  8826. The project configuration to run.
  8827. </summary>
  8828. <remarks>Only applies when a project file is used. The default is the first configuration, usually Debug.</remarks>
  8829. </member>
  8830. <member name="P:MSBuild.Community.Tasks.NUnit.TestInNewThread">
  8831. <summary>
  8832. Allows tests to be run in a new thread, allowing you to take advantage of ApartmentState and ThreadPriority settings in the config file.
  8833. </summary>
  8834. </member>
  8835. <member name="P:MSBuild.Community.Tasks.NUnit.Force32Bit">
  8836. <summary>
  8837. Determines whether the tests are run in a 32bit process on a 64bit OS.
  8838. </summary>
  8839. </member>
  8840. <member name="P:MSBuild.Community.Tasks.NUnit.Framework">
  8841. <summary>
  8842. Determines the framework to run aganist.
  8843. </summary>
  8844. </member>
  8845. <member name="P:MSBuild.Community.Tasks.NUnit.ToolName">
  8846. <summary>
  8847. Gets the name of the executable file to run.
  8848. </summary>
  8849. <value></value>
  8850. <returns>The name of the executable file to run.</returns>
  8851. </member>
  8852. <member name="P:MSBuild.Community.Tasks.NUnit.StandardOutputLoggingImportance">
  8853. <summary>
  8854. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  8855. </summary>
  8856. <value></value>
  8857. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  8858. </member>
  8859. <member name="T:MSBuild.Community.Tasks.Properties.Resources">
  8860. <summary>
  8861. A strongly-typed resource class, for looking up localized strings, etc.
  8862. </summary>
  8863. </member>
  8864. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ResourceManager">
  8865. <summary>
  8866. Returns the cached ResourceManager instance used by this class.
  8867. </summary>
  8868. </member>
  8869. <member name="P:MSBuild.Community.Tasks.Properties.Resources.Culture">
  8870. <summary>
  8871. Overrides the current thread's CurrentUICulture property for all
  8872. resource lookups using this strongly typed resource class.
  8873. </summary>
  8874. </member>
  8875. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ActiveDirectoryLookupException">
  8876. <summary>
  8877. Looks up a localized string similar to Failed to lookup information for {0} in Active Directory..
  8878. </summary>
  8879. </member>
  8880. <member name="P:MSBuild.Community.Tasks.Properties.Resources.AttribDirectory">
  8881. <summary>
  8882. Looks up a localized string similar to Attrib directory &apos;{0}&apos;. {1}.
  8883. </summary>
  8884. </member>
  8885. <member name="P:MSBuild.Community.Tasks.Properties.Resources.AttribFile">
  8886. <summary>
  8887. Looks up a localized string similar to Attrib file &apos;{0}&apos;. {1}.
  8888. </summary>
  8889. </member>
  8890. <member name="P:MSBuild.Community.Tasks.Properties.Resources.CouldNotConnectToRemoteServer">
  8891. <summary>
  8892. Looks up a localized string similar to Couldn&apos;t connect to remove server..
  8893. </summary>
  8894. </member>
  8895. <member name="P:MSBuild.Community.Tasks.Properties.Resources.CouldNotResolveServerHostName">
  8896. <summary>
  8897. Looks up a localized string similar to Couldn&apos;t resolve server host name {0}..
  8898. </summary>
  8899. </member>
  8900. <member name="P:MSBuild.Community.Tasks.Properties.Resources.CreatingDirectory">
  8901. <summary>
  8902. Looks up a localized string similar to Creating directory &quot;{0}&quot;..
  8903. </summary>
  8904. </member>
  8905. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ExactlyOneTypeOfDestination">
  8906. <summary>
  8907. Looks up a localized string similar to Both &quot;{0}&quot; and &quot;{1}&quot; were specified as input parameters in the project file. Please choose one or the other..
  8908. </summary>
  8909. </member>
  8910. <member name="P:MSBuild.Community.Tasks.Properties.Resources.FileNotFound">
  8911. <summary>
  8912. Looks up a localized string similar to File Not Found: {0}.
  8913. </summary>
  8914. </member>
  8915. <member name="P:MSBuild.Community.Tasks.Properties.Resources.FtpLocalNotFound">
  8916. <summary>
  8917. Looks up a localized string similar to Local File Not Found: {0}.
  8918. </summary>
  8919. </member>
  8920. <member name="P:MSBuild.Community.Tasks.Properties.Resources.FtpPercentComplete">
  8921. <summary>
  8922. Looks up a localized string similar to {0}% Complete ({1}).
  8923. </summary>
  8924. </member>
  8925. <member name="P:MSBuild.Community.Tasks.Properties.Resources.FtpTransfered">
  8926. <summary>
  8927. Looks up a localized string similar to Transfered {0} ({1}) in {2}.
  8928. </summary>
  8929. </member>
  8930. <member name="P:MSBuild.Community.Tasks.Properties.Resources.FtpUploadComplete">
  8931. <summary>
  8932. Looks up a localized string similar to Upload File Complete, {0}.
  8933. </summary>
  8934. </member>
  8935. <member name="P:MSBuild.Community.Tasks.Properties.Resources.FtpUploading">
  8936. <summary>
  8937. Looks up a localized string similar to Uploading &quot;{0}&quot;
  8938. to &quot;{1}&quot;
  8939. .
  8940. </summary>
  8941. </member>
  8942. <member name="P:MSBuild.Community.Tasks.Properties.Resources.FtpUriInvalid">
  8943. <summary>
  8944. Looks up a localized string similar to The URI &quot;{0}&quot; scheme is not valid..
  8945. </summary>
  8946. </member>
  8947. <member name="P:MSBuild.Community.Tasks.Properties.Resources.JSCompressCompressed">
  8948. <summary>
  8949. Looks up a localized string similar to Compressed by {0}, from {1} to {2} byte(s).
  8950. </summary>
  8951. </member>
  8952. <member name="P:MSBuild.Community.Tasks.Properties.Resources.JSCompressCompressing">
  8953. <summary>
  8954. Looks up a localized string similar to Compressing JavaScript in &quot;{0}&quot;..
  8955. </summary>
  8956. </member>
  8957. <member name="P:MSBuild.Community.Tasks.Properties.Resources.JSCompressWriting">
  8958. <summary>
  8959. Looks up a localized string similar to Writing compressed JavaScript back to &quot;{0}&quot; using {1}..
  8960. </summary>
  8961. </member>
  8962. <member name="P:MSBuild.Community.Tasks.Properties.Resources.MailEmailing">
  8963. <summary>
  8964. Looks up a localized string similar to Emailing &quot;{0}&quot;..
  8965. </summary>
  8966. </member>
  8967. <member name="P:MSBuild.Community.Tasks.Properties.Resources.MathNotNumber">
  8968. <summary>
  8969. Looks up a localized string similar to &quot;{0}&quot; is not a number..
  8970. </summary>
  8971. </member>
  8972. <member name="P:MSBuild.Community.Tasks.Properties.Resources.MergeComplete">
  8973. <summary>
  8974. Looks up a localized string similar to Merge Complete: {0} files merged into &apos;{1}&apos;..
  8975. </summary>
  8976. </member>
  8977. <member name="P:MSBuild.Community.Tasks.Properties.Resources.MergeCompleteNoSourceFiles">
  8978. <summary>
  8979. Looks up a localized string similar to Merge Complete: No source files to merge..
  8980. </summary>
  8981. </member>
  8982. <member name="P:MSBuild.Community.Tasks.Properties.Resources.MergingFile">
  8983. <summary>
  8984. Looks up a localized string similar to Merging file &apos;{0}&apos; into &apos;{1}&apos;.
  8985. </summary>
  8986. </member>
  8987. <member name="P:MSBuild.Community.Tasks.Properties.Resources.MoveError">
  8988. <summary>
  8989. Looks up a localized string similar to Unable to move file &quot;{0}&quot; to &quot;{1}&quot;. {2}.
  8990. </summary>
  8991. </member>
  8992. <member name="P:MSBuild.Community.Tasks.Properties.Resources.MoveFileComment">
  8993. <summary>
  8994. Looks up a localized string similar to Moving file from &quot;{0}&quot; to &quot;{1}&quot;..
  8995. </summary>
  8996. </member>
  8997. <member name="P:MSBuild.Community.Tasks.Properties.Resources.NUnitNotFound">
  8998. <summary>
  8999. Looks up a localized string similar to Could not find the NUnit Project File open command. Please make sure NUnit is installed..
  9000. </summary>
  9001. </member>
  9002. <member name="P:MSBuild.Community.Tasks.Properties.Resources.OracleHomeCheck">
  9003. <summary>
  9004. Looks up a localized string similar to Checking Oracle Home: {0}.
  9005. </summary>
  9006. </member>
  9007. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ParameterNotUsed">
  9008. <summary>
  9009. Looks up a localized string similar to The parameter &quot;{1}&quot; does not apply to the current use of task &quot;{0}&quot;..
  9010. </summary>
  9011. </member>
  9012. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ParameterRequired">
  9013. <summary>
  9014. Looks up a localized string similar to The &quot;{0}&quot; task was not given a value for the required parameter &quot;{1}&quot;..
  9015. </summary>
  9016. </member>
  9017. <member name="P:MSBuild.Community.Tasks.Properties.Resources.RegistryRead">
  9018. <summary>
  9019. Looks up a localized string similar to Read Windows Registry.
  9020. </summary>
  9021. </member>
  9022. <member name="P:MSBuild.Community.Tasks.Properties.Resources.RegistryWrite">
  9023. <summary>
  9024. Looks up a localized string similar to Write Windows Registry.
  9025. </summary>
  9026. </member>
  9027. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceCannotContinue">
  9028. <summary>
  9029. Looks up a localized string similar to Cannot continue service {0} on computer &apos;{1}&apos; as it does not support the pause and continue..
  9030. </summary>
  9031. </member>
  9032. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceCannotPause">
  9033. <summary>
  9034. Looks up a localized string similar to Cannot pause service {0} on computer &apos;{1}&apos; as it does not support the pause and continue..
  9035. </summary>
  9036. </member>
  9037. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceCannotStop">
  9038. <summary>
  9039. Looks up a localized string similar to Cannot stop service {0} on computer &apos;{1}&apos;..
  9040. </summary>
  9041. </member>
  9042. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceContinued">
  9043. <summary>
  9044. Looks up a localized string similar to {0} service was continued successfully..
  9045. </summary>
  9046. </member>
  9047. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceContinuing">
  9048. <summary>
  9049. Looks up a localized string similar to {0} service is continuing ....
  9050. </summary>
  9051. </member>
  9052. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceNotFound">
  9053. <summary>
  9054. Looks up a localized string similar to Couldn&apos;t find the &apos;{0}&apos; service on &apos;{1}&apos;.
  9055. </summary>
  9056. </member>
  9057. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceNotPaused">
  9058. <summary>
  9059. Looks up a localized string similar to Cannot continue service {0} on computer &apos;{1}&apos; as its not currently paused..
  9060. </summary>
  9061. </member>
  9062. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceNotStarted">
  9063. <summary>
  9064. Looks up a localized string similar to Cannot pause service {0} on computer &apos;{1}&apos; as its not currently started..
  9065. </summary>
  9066. </member>
  9067. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServicePaused">
  9068. <summary>
  9069. Looks up a localized string similar to {0} service was paused successfully..
  9070. </summary>
  9071. </member>
  9072. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServicePausing">
  9073. <summary>
  9074. Looks up a localized string similar to {0} service is pausing ....
  9075. </summary>
  9076. </member>
  9077. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceStarted">
  9078. <summary>
  9079. Looks up a localized string similar to {0} service was started successfully..
  9080. </summary>
  9081. </member>
  9082. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceStarting">
  9083. <summary>
  9084. Looks up a localized string similar to {0} service is starting ....
  9085. </summary>
  9086. </member>
  9087. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceStatus">
  9088. <summary>
  9089. Looks up a localized string similar to The &apos;{0}&apos; service on &apos;{1}&apos; is &apos;{2}&apos;..
  9090. </summary>
  9091. </member>
  9092. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceStopped">
  9093. <summary>
  9094. Looks up a localized string similar to {0} service was stopped successfully..
  9095. </summary>
  9096. </member>
  9097. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ServiceStopping">
  9098. <summary>
  9099. Looks up a localized string similar to {0} service is stopping ....
  9100. </summary>
  9101. </member>
  9102. <member name="P:MSBuild.Community.Tasks.Properties.Resources.SolutionNotFound">
  9103. <summary>
  9104. Looks up a localized string similar to Solution file &quot;{0}&quot; not found..
  9105. </summary>
  9106. </member>
  9107. <member name="P:MSBuild.Community.Tasks.Properties.Resources.SvnLocalPathNotWorkCopy">
  9108. <summary>
  9109. Looks up a localized string similar to LocalPath is not a working subversion copy..
  9110. </summary>
  9111. </member>
  9112. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TaskDestinationIsDirectory">
  9113. <summary>
  9114. Looks up a localized string similar to Could not {0} the file &quot;{1}&quot; to the destination file &quot;{2}&quot;, because the destination is a folder instead of a file. To {0} the source file into a folder, consider using the DestinationFolder parameter instead of DestinationFiles..
  9115. </summary>
  9116. </member>
  9117. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TaskNeedsDestination">
  9118. <summary>
  9119. Looks up a localized string similar to No destination specified for {0}. Please supply either &quot;{1}&quot; or &quot;{2}&quot;..
  9120. </summary>
  9121. </member>
  9122. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TaskSourceIsDirectory">
  9123. <summary>
  9124. Looks up a localized string similar to The source file &quot;{0}&quot; is actually a directory. The &quot;{1}&quot; task does not support moving directories..
  9125. </summary>
  9126. </member>
  9127. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TimeFormatException">
  9128. <summary>
  9129. Looks up a localized string similar to Failed to get current date!.
  9130. </summary>
  9131. </member>
  9132. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TimeGettingCurrentDate">
  9133. <summary>
  9134. Looks up a localized string similar to Getting current date..
  9135. </summary>
  9136. </member>
  9137. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TnsnameAdded">
  9138. <summary>
  9139. Looks up a localized string similar to Adding TNSNAMES entry &quot;{0}&quot; to &quot;{1}&quot;.
  9140. </summary>
  9141. </member>
  9142. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TnsNamesFileCheck">
  9143. <summary>
  9144. Looks up a localized string similar to Looking for {0}.
  9145. </summary>
  9146. </member>
  9147. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TnsNamesFileNotFound">
  9148. <summary>
  9149. Looks up a localized string similar to Unable to locate a TNSNAMES.ORA file. Please specify a value for TnsNamesFile..
  9150. </summary>
  9151. </member>
  9152. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TnsnameUpdateAborted">
  9153. <summary>
  9154. Looks up a localized string similar to TNSNAME entry &quot;{0}&quot; already exists in &quot;{1}&quot; and AllowUpdates=false..
  9155. </summary>
  9156. </member>
  9157. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TnsnameUpdated">
  9158. <summary>
  9159. Looks up a localized string similar to Updating TNSNAMES entry &quot;{0}&quot; in &quot;{1}&quot;.
  9160. </summary>
  9161. </member>
  9162. <member name="P:MSBuild.Community.Tasks.Properties.Resources.TwoVectorsMustHaveSameLength">
  9163. <summary>
  9164. Looks up a localized string similar to &quot;{2}&quot; refers to {0} item(s), and &quot;{3}&quot; refers to {1} item(s). They must have the same number of items..
  9165. </summary>
  9166. </member>
  9167. <member name="P:MSBuild.Community.Tasks.Properties.Resources.UnzipExtracted">
  9168. <summary>
  9169. Looks up a localized string similar to extracted &quot;{0}&quot;.
  9170. </summary>
  9171. </member>
  9172. <member name="P:MSBuild.Community.Tasks.Properties.Resources.UnzipFileToDirectory">
  9173. <summary>
  9174. Looks up a localized string similar to Unzip File &quot;{0}&quot;
  9175. to Directory &quot;{1}&quot;
  9176. .
  9177. </summary>
  9178. </member>
  9179. <member name="P:MSBuild.Community.Tasks.Properties.Resources.UnzipSuccessfully">
  9180. <summary>
  9181. Looks up a localized string similar to Unzipped file &quot;{0}&quot; successfully..
  9182. </summary>
  9183. </member>
  9184. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultAddFileCommitFailed">
  9185. <summary>
  9186. Looks up a localized string similar to Commitment of change set failed!.
  9187. </summary>
  9188. </member>
  9189. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultAddFileCommitSucceeded">
  9190. <summary>
  9191. Looks up a localized string similar to Files added to Vault repository successfully..
  9192. </summary>
  9193. </member>
  9194. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultAddFilesException">
  9195. <summary>
  9196. Looks up a localized string similar to Files specified for addition to repository cannot be found..
  9197. </summary>
  9198. </member>
  9199. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultCheckinFileException">
  9200. <summary>
  9201. Looks up a localized string similar to The file {0} could not be checked in: {1}..
  9202. </summary>
  9203. </member>
  9204. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultCheckinFileNotFoundException">
  9205. <summary>
  9206. Looks up a localized string similar to File or folder {0} not found for checkin..
  9207. </summary>
  9208. </member>
  9209. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultCheckinFolderException">
  9210. <summary>
  9211. Looks up a localized string similar to The folder {0} could not be checked in: {1}..
  9212. </summary>
  9213. </member>
  9214. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultCheckinSuccessful">
  9215. <summary>
  9216. Looks up a localized string similar to {0} successfully checked out..
  9217. </summary>
  9218. </member>
  9219. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultCheckoutSuccessful">
  9220. <summary>
  9221. Looks up a localized string similar to {0} successfully checked out..
  9222. </summary>
  9223. </member>
  9224. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultDiskFileDoesNotExist">
  9225. <summary>
  9226. Looks up a localized string similar to Specified diskfile {0} does not exist..
  9227. </summary>
  9228. </member>
  9229. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultFileAddedToChangeSet">
  9230. <summary>
  9231. Looks up a localized string similar to File [{0}] added to change set..
  9232. </summary>
  9233. </member>
  9234. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultFolderAddedToChangeSet">
  9235. <summary>
  9236. Looks up a localized string similar to Folder [{0}] added to change set..
  9237. </summary>
  9238. </member>
  9239. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultIncorrectParameters">
  9240. <summary>
  9241. Looks up a localized string similar to Incorrect parameters passed to VaultSession..
  9242. </summary>
  9243. </member>
  9244. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultLoginFailed">
  9245. <summary>
  9246. Looks up a localized string similar to Login to Vault repository failed..
  9247. </summary>
  9248. </member>
  9249. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultPathValidationException">
  9250. <summary>
  9251. Looks up a localized string similar to Error validating path &quot;{0}&quot;..
  9252. </summary>
  9253. </member>
  9254. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultRepositorySelectionFailure">
  9255. <summary>
  9256. Looks up a localized string similar to Selection of the repository failed: {0}..
  9257. </summary>
  9258. </member>
  9259. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultResourceNotFound">
  9260. <summary>
  9261. Looks up a localized string similar to File or folder {0} not found for checkout..
  9262. </summary>
  9263. </member>
  9264. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultSetNewWorkingFolder">
  9265. <summary>
  9266. Looks up a localized string similar to Set working folder for {0} to {1} from {2}..
  9267. </summary>
  9268. </member>
  9269. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultTreeCacheFailure">
  9270. <summary>
  9271. Looks up a localized string similar to ClientInstance.TreeCache has not been initialized, Common cause is that SelectRepository has not been called sucessfully..
  9272. </summary>
  9273. </member>
  9274. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultUndoCheckoutSuccessful">
  9275. <summary>
  9276. Looks up a localized string similar to Successfully undid check out for {0}..
  9277. </summary>
  9278. </member>
  9279. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultUrlRequired">
  9280. <summary>
  9281. Looks up a localized string similar to Url specifying vault location is required..
  9282. </summary>
  9283. </member>
  9284. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultUsernameRequired">
  9285. <summary>
  9286. Looks up a localized string similar to Username must be set to access repository..
  9287. </summary>
  9288. </member>
  9289. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultWorkingFolderCleared">
  9290. <summary>
  9291. Looks up a localized string similar to Clearing working folder for {0}..
  9292. </summary>
  9293. </member>
  9294. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VaultWorkingFolderRestored">
  9295. <summary>
  9296. Looks up a localized string similar to Restoring working folder for {0} to {1}..
  9297. </summary>
  9298. </member>
  9299. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VersionFileNotFound">
  9300. <summary>
  9301. Looks up a localized string similar to Version file &quot;{0}&quot; not found - creating new file..
  9302. </summary>
  9303. </member>
  9304. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VersionModifiedValue">
  9305. <summary>
  9306. Looks up a localized string similar to Updated to version {0}.
  9307. </summary>
  9308. </member>
  9309. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VersionOriginalValue">
  9310. <summary>
  9311. Looks up a localized string similar to Initialized to version {0}.
  9312. </summary>
  9313. </member>
  9314. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VersionRead">
  9315. <summary>
  9316. Looks up a localized string similar to Reading version from file &quot;{0}&quot;..
  9317. </summary>
  9318. </member>
  9319. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VersionReadException">
  9320. <summary>
  9321. Looks up a localized string similar to Unable to read version number from &quot;{0}&quot;. {1}.
  9322. </summary>
  9323. </member>
  9324. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VersionWriteException">
  9325. <summary>
  9326. Looks up a localized string similar to Unable to write version number to &quot;{0}&quot;. {1}&quot;.
  9327. </summary>
  9328. </member>
  9329. <member name="P:MSBuild.Community.Tasks.Properties.Resources.VersionWrote">
  9330. <summary>
  9331. Looks up a localized string similar to Wrote version to file &quot;{0}&quot;..
  9332. </summary>
  9333. </member>
  9334. <member name="P:MSBuild.Community.Tasks.Properties.Resources.WebDirectoryInvalidDirectory">
  9335. <summary>
  9336. Looks up a localized string similar to Web directory {0} does not exist on {1}..
  9337. </summary>
  9338. </member>
  9339. <member name="P:MSBuild.Community.Tasks.Properties.Resources.WebDirectoryScriptMapUpdate">
  9340. <summary>
  9341. Looks up a localized string similar to Setting scriptmap for {0} on web directory {1} on {2}..
  9342. </summary>
  9343. </member>
  9344. <member name="P:MSBuild.Community.Tasks.Properties.Resources.WebDirectorySettingInvalidSetting">
  9345. <summary>
  9346. Looks up a localized string similar to Web directory {0} on {1} does not have a setting called {2}..
  9347. </summary>
  9348. </member>
  9349. <member name="P:MSBuild.Community.Tasks.Properties.Resources.WebDirectorySettingStatusRead">
  9350. <summary>
  9351. Looks up a localized string similar to Reading {0} property of web directory {1} on {2}..
  9352. </summary>
  9353. </member>
  9354. <member name="P:MSBuild.Community.Tasks.Properties.Resources.WebDirectorySettingStatusSet">
  9355. <summary>
  9356. Looks up a localized string similar to Setting {0} property of web directory {1} on {2}..
  9357. </summary>
  9358. </member>
  9359. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XmlReadDocument">
  9360. <summary>
  9361. Looks up a localized string similar to Reading Xml Document &quot;{0}&quot;..
  9362. </summary>
  9363. </member>
  9364. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XmlReadNodes">
  9365. <summary>
  9366. Looks up a localized string similar to {0} node(s) selected for read..
  9367. </summary>
  9368. </member>
  9369. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XmlReadResult">
  9370. <summary>
  9371. Looks up a localized string similar to XmlRead Result: &quot;{0}&quot;.
  9372. </summary>
  9373. </member>
  9374. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XmlUpdateDocument">
  9375. <summary>
  9376. Looks up a localized string similar to Updating Xml Document &quot;{0}&quot;..
  9377. </summary>
  9378. </member>
  9379. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XmlUpdateNodes">
  9380. <summary>
  9381. Looks up a localized string similar to {0} node(s) selected for update..
  9382. </summary>
  9383. </member>
  9384. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XmlUpdateResult">
  9385. <summary>
  9386. Looks up a localized string similar to XmlUpdate Wrote: &quot;{0}&quot;..
  9387. </summary>
  9388. </member>
  9389. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XsltAddingParameter">
  9390. <summary>
  9391. Looks up a localized string similar to Adding Parameter &quot;{0}&quot;: &quot;{1}&quot;..
  9392. </summary>
  9393. </member>
  9394. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XsltAddingRootAttribute">
  9395. <summary>
  9396. Looks up a localized string similar to Adding root attribute {0}=&quot;{1}&quot;..
  9397. </summary>
  9398. </member>
  9399. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XsltCreatingRootTag">
  9400. <summary>
  9401. Looks up a localized string similar to Creating root tag &quot;{0}&quot;..
  9402. </summary>
  9403. </member>
  9404. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XsltNoInputFiles">
  9405. <summary>
  9406. Looks up a localized string similar to No input files..
  9407. </summary>
  9408. </member>
  9409. <member name="P:MSBuild.Community.Tasks.Properties.Resources.XsltNoRootTag">
  9410. <summary>
  9411. Looks up a localized string similar to No root tag inserted..
  9412. </summary>
  9413. </member>
  9414. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ZipAdded">
  9415. <summary>
  9416. Looks up a localized string similar to added &quot;{0}&quot;..
  9417. </summary>
  9418. </member>
  9419. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ZipCreating">
  9420. <summary>
  9421. Looks up a localized string similar to Creating zip file &quot;{0}&quot;..
  9422. </summary>
  9423. </member>
  9424. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ZipFileNotFound">
  9425. <summary>
  9426. Looks up a localized string similar to Zip File Not Found: {0}..
  9427. </summary>
  9428. </member>
  9429. <member name="P:MSBuild.Community.Tasks.Properties.Resources.ZipSuccessfully">
  9430. <summary>
  9431. Looks up a localized string similar to Created zip file &quot;{0}&quot; successfully..
  9432. </summary>
  9433. </member>
  9434. <member name="T:MSBuild.Community.Tasks.RegistryRead">
  9435. <summary>
  9436. Reads a value from the Registry
  9437. </summary>
  9438. <example>Read .NET Framework install root from Registry.
  9439. <code><![CDATA[
  9440. <RegistryRead
  9441. KeyName="HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\.NETFramework"
  9442. ValueName="InstallRoot">
  9443. <Output TaskParameter="Value" PropertyName="InstallRoot" />
  9444. </RegistryRead>
  9445. <Message Text="InstallRoot: $(InstallRoot)"/>
  9446. ]]></code>
  9447. </example>
  9448. <remarks>The <see cref="P:MSBuild.Community.Tasks.RegistryRead.Value"/> parameter is set according to the following rules:
  9449. <list type="table"><item><description>If a <see cref="P:MSBuild.Community.Tasks.RegistryRead.DefaultValue"/> is provided, it will be used if the <see cref="P:MSBuild.Community.Tasks.RegistryRead.KeyName"/> or <see cref="P:MSBuild.Community.Tasks.RegistryRead.ValueName"/> does not exist.</description></item>
  9450. <item><description>If a <see cref="P:MSBuild.Community.Tasks.RegistryRead.DefaultValue"/> is not provided, the <see cref="P:MSBuild.Community.Tasks.RegistryRead.KeyName"/> exists, but the <see cref="P:MSBuild.Community.Tasks.RegistryRead.ValueName"/> does not exist, <see cref="P:MSBuild.Community.Tasks.RegistryRead.Value"/> will be set to an empty string.</description></item>
  9451. <item><description>If a <see cref="P:MSBuild.Community.Tasks.RegistryRead.DefaultValue"/> is not provided, and the <see cref="P:MSBuild.Community.Tasks.RegistryRead.KeyName"/> does not exist, the task will fail.</description></item></list></remarks>
  9452. </member>
  9453. <member name="M:MSBuild.Community.Tasks.RegistryRead.#ctor">
  9454. <summary>
  9455. Initializes a new instance of the <see cref="T:RegistryRead"/> class.
  9456. </summary>
  9457. </member>
  9458. <member name="M:MSBuild.Community.Tasks.RegistryRead.Execute">
  9459. <summary>
  9460. When overridden in a derived class, executes the task.
  9461. </summary>
  9462. <returns>
  9463. true if the task successfully executed; otherwise, false.
  9464. </returns>
  9465. </member>
  9466. <member name="P:MSBuild.Community.Tasks.RegistryRead.KeyName">
  9467. <summary>
  9468. Gets or sets the full registry path of the key, beginning with a valid registry root, such as "HKEY_CURRENT_USER".
  9469. </summary>
  9470. <value>The name of the key.</value>
  9471. </member>
  9472. <member name="P:MSBuild.Community.Tasks.RegistryRead.ValueName">
  9473. <summary>
  9474. Gets or sets the name of the name/value pair.
  9475. </summary>
  9476. <value>The name of the value.</value>
  9477. </member>
  9478. <member name="P:MSBuild.Community.Tasks.RegistryRead.DefaultValue">
  9479. <summary>
  9480. Gets or sets the default value.
  9481. </summary>
  9482. <value>The default value.</value>
  9483. </member>
  9484. <member name="P:MSBuild.Community.Tasks.RegistryRead.Value">
  9485. <summary>
  9486. Gets the stored value.
  9487. </summary>
  9488. <value>The value.</value>
  9489. </member>
  9490. <member name="T:MSBuild.Community.Tasks.RegistryWrite">
  9491. <summary>
  9492. Writes a value to the Registry
  9493. </summary>
  9494. <example>Write a value to Registry
  9495. <code><![CDATA[
  9496. <RegistryWrite
  9497. KeyName="HKEY_CURRENT_USER\SOFTWARE\MSBuildTasks"
  9498. ValueName="RegistryWrite"
  9499. Value="Test Write" />
  9500. ]]></code>
  9501. </example>
  9502. </member>
  9503. <member name="M:MSBuild.Community.Tasks.RegistryWrite.#ctor">
  9504. <summary>
  9505. Initializes a new instance of the <see cref="T:RegistryWrite"/> class.
  9506. </summary>
  9507. </member>
  9508. <member name="M:MSBuild.Community.Tasks.RegistryWrite.Execute">
  9509. <summary>
  9510. When overridden in a derived class, executes the task.
  9511. </summary>
  9512. <returns>
  9513. true if the task successfully executed; otherwise, false.
  9514. </returns>
  9515. </member>
  9516. <member name="P:MSBuild.Community.Tasks.RegistryWrite.KeyName">
  9517. <summary>
  9518. Gets or sets the full registry path of the key, beginning with a valid registry root, such as "HKEY_CURRENT_USER".
  9519. </summary>
  9520. <value>The name of the key.</value>
  9521. </member>
  9522. <member name="P:MSBuild.Community.Tasks.RegistryWrite.ValueName">
  9523. <summary>
  9524. Gets or sets the name of the name/value pair.
  9525. </summary>
  9526. <value>The name of the value.</value>
  9527. </member>
  9528. <member name="P:MSBuild.Community.Tasks.RegistryWrite.Value">
  9529. <summary>
  9530. Gets or sets the value to be stored.
  9531. </summary>
  9532. <value>The value.</value>
  9533. </member>
  9534. <member name="T:MSBuild.Community.Tasks.Script">
  9535. <summary>
  9536. Executes code contained within the task.
  9537. </summary>
  9538. <example>
  9539. <para>Simple script that writes to the console</para>
  9540. <code>
  9541. <![CDATA[
  9542. <PropertyGroup>
  9543. <HelloCode>
  9544. <![CDATA[
  9545. public static void ScriptMain() {
  9546. Console.WriteLine("Hello MSBuild Community Scripting World.");
  9547. }
  9548. ]] >
  9549. </HelloCode>
  9550. </PropertyGroup>
  9551. <Target Name="Hello">
  9552. <Script Language="C#" Code="$(HelloCode)" Imports="System" />
  9553. </Target>
  9554. ]]>
  9555. </code>
  9556. </example><example>
  9557. <para>Script that returns a value.</para>
  9558. <code>
  9559. <![CDATA[
  9560. <PropertyGroup>
  9561. <GetProgramFilesCode>
  9562. <![CDATA[
  9563. public static string ScriptMain() {
  9564. return Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
  9565. }
  9566. ]] >
  9567. </GetProgramFilesCode>
  9568. </PropertyGroup>
  9569. <Target Name="GetProgramFilesFolder">
  9570. <Script Language="C#" Code="$(GetProgramFilesCode)">
  9571. <Output TaskParameter="ReturnValue" PropertyName="ProgramFilesFolder" />
  9572. </Script>
  9573. <Message Text="Program files are in: $(ProgramFilesFolder)" />
  9574. </Target>
  9575. ]]>
  9576. </code>
  9577. </example>
  9578. </member>
  9579. <member name="M:MSBuild.Community.Tasks.Script.Execute">
  9580. <summary>
  9581. Executes the task.
  9582. </summary>
  9583. <returns><see langword="true"/> if the task ran successfully;
  9584. otherwise <see langword="false"/>.</returns>
  9585. </member>
  9586. <member name="P:MSBuild.Community.Tasks.Script.References">
  9587. <summary>
  9588. The required references
  9589. </summary>
  9590. </member>
  9591. <member name="P:MSBuild.Community.Tasks.Script.Imports">
  9592. <summary>
  9593. The namespaces to import.
  9594. </summary>
  9595. </member>
  9596. <member name="P:MSBuild.Community.Tasks.Script.Language">
  9597. <summary>
  9598. The language of the script block (defaults to C#).
  9599. </summary>
  9600. <remarks><para>The supported languages are:</para>
  9601. <list type="bullet">
  9602. <item><description>Visual Basic.NET (VB, vb, VISUALBASIC)</description></item>
  9603. <item><description>C# (C#, c#, CSHARP)</description></item>
  9604. <item><description>JavaScript (JS, js, JSCRIPT)</description></item>
  9605. <item><description>J# (VJS, vjs, JSHARP)</description></item>
  9606. </list> or, proviude the fully-qualified name for a class implementing
  9607. <see cref="T:System.CodeDom.Compiler.CodeDomProvider"/>.</remarks>
  9608. </member>
  9609. <member name="P:MSBuild.Community.Tasks.Script.MainClass">
  9610. <summary>
  9611. The name of the main class containing the static <c>ScriptMain</c>
  9612. entry point.
  9613. </summary>
  9614. </member>
  9615. <member name="P:MSBuild.Community.Tasks.Script.Code">
  9616. <summary>
  9617. The code to compile and execute
  9618. </summary>
  9619. <remarks>
  9620. The code must include a static (Shared in VB) method named ScriptMain.
  9621. It cannot accept any parameters. If you define the method return a <see cref="T:System.String"/>,
  9622. the returned value will be available in the <see cref="P:MSBuild.Community.Tasks.Script.ReturnValue"/> output property.
  9623. </remarks>
  9624. </member>
  9625. <member name="P:MSBuild.Community.Tasks.Script.ReturnValue">
  9626. <summary>
  9627. The string returned from the custom ScriptMain method.
  9628. </summary>
  9629. </member>
  9630. <member name="T:MSBuild.Community.Tasks.Sleep">
  9631. <summary>
  9632. A task for sleeping for a specified period of time.
  9633. </summary>
  9634. <example>Causes the build to sleep for 300 milliseconds.
  9635. <code><![CDATA[
  9636. <Sleep Milliseconds="300" />
  9637. ]]></code>
  9638. </example>
  9639. </member>
  9640. <member name="M:MSBuild.Community.Tasks.Sleep.Execute">
  9641. <summary>
  9642. Executes the task.
  9643. </summary>
  9644. <returns><see langword="true"/> if the task ran successfully;
  9645. otherwise <see langword="false"/>.</returns>
  9646. </member>
  9647. <member name="P:MSBuild.Community.Tasks.Sleep.Milliseconds">
  9648. <summary>
  9649. The number of milliseconds to add to the time to sleep.
  9650. </summary>
  9651. </member>
  9652. <member name="P:MSBuild.Community.Tasks.Sleep.Seconds">
  9653. <summary>
  9654. The number of seconds to add to the time to sleep.
  9655. </summary>
  9656. </member>
  9657. <member name="P:MSBuild.Community.Tasks.Sleep.Minutes">
  9658. <summary>
  9659. The number of minutes to add to the time to sleep.
  9660. </summary>
  9661. </member>
  9662. <member name="P:MSBuild.Community.Tasks.Sleep.Hours">
  9663. <summary>
  9664. The number of hours to add to the time to sleep.
  9665. </summary>
  9666. </member>
  9667. <member name="T:MSBuild.Community.Tasks.SqlExecute">
  9668. <summary>
  9669. Executes a SQL command.
  9670. </summary>
  9671. <remarks>
  9672. Execute a SQL command against a database. Target attributes to set:
  9673. ConnectionString (required), Command (required, the SQL to execute),
  9674. SelectMode (NonQuery, Scalar, or ScalarXml, default is NonQuery),
  9675. OutputFile (required when SelectMode is Scalar or ScalarXml).
  9676. Note: ScalarXml was created because of the 2033 byte limit on the sql return.
  9677. See http://aspnetresources.com/blog/executescalar_truncates_xml.aspx for details.
  9678. </remarks>
  9679. <example>
  9680. Example of returning a count of items in a table. Uses the default SelectMode of NonQuery.
  9681. <code><![CDATA[
  9682. <SqlExecute ConnectionString="server=MyServer;Database=MyDatabase;Trusted_Connection=yes;"
  9683. Command="create database MyDatabase" />
  9684. ]]></code>
  9685. Example of returning the items of a table in an xml format.
  9686. <code><![CDATA[
  9687. <SqlExecute ConnectionString="server=MyServer;Database=MyDatabase;Trusted_Connection=yes;"
  9688. Command="select * from SomeTable for xml auto"
  9689. SelectMode="ScalarXml"
  9690. OutputFile="SomeTable.xml" />
  9691. ]]></code>
  9692. </example>
  9693. </member>
  9694. <member name="M:MSBuild.Community.Tasks.SqlExecute.Execute">
  9695. <summary>
  9696. When overridden in a derived class, executes the task.
  9697. </summary>
  9698. <returns>
  9699. true if the task successfully executed; otherwise, false.
  9700. </returns>
  9701. </member>
  9702. <member name="M:MSBuild.Community.Tasks.SqlExecute.IsOutputFileSpecified(System.String)">
  9703. <summary>
  9704. Determines if an output file was specified.
  9705. </summary>
  9706. </member>
  9707. <member name="P:MSBuild.Community.Tasks.SqlExecute.ConnectionString">
  9708. <summary>
  9709. The connection string
  9710. </summary>
  9711. </member>
  9712. <member name="P:MSBuild.Community.Tasks.SqlExecute.Command">
  9713. <summary>
  9714. The command to execute
  9715. </summary>
  9716. </member>
  9717. <member name="P:MSBuild.Community.Tasks.SqlExecute.CommandTimeout">
  9718. <summary>
  9719. Command Timeout
  9720. </summary>
  9721. <remarks>Defaults to 30 seconds. Set to 0 for an infinite timeout period.</remarks>
  9722. </member>
  9723. <member name="P:MSBuild.Community.Tasks.SqlExecute.SelectMode">
  9724. <summary>
  9725. The SQL Selection Mode. Set to NonQuery, Scalar, or ScalarXml. Default is NonQuery.
  9726. </summary>
  9727. </member>
  9728. <member name="P:MSBuild.Community.Tasks.SqlExecute.OutputFile">
  9729. <summary>
  9730. The file name to write to
  9731. </summary>
  9732. </member>
  9733. <member name="P:MSBuild.Community.Tasks.SqlExecute.Result">
  9734. <summary>
  9735. Output the return count/value
  9736. </summary>
  9737. </member>
  9738. <member name="T:MSBuild.Community.Tasks.Subversion.SvnCheckout">
  9739. <summary>
  9740. Checkout a local working copy of a Subversion repository.
  9741. </summary>
  9742. <example>Checkout a working copy
  9743. <code><![CDATA[
  9744. <Target Name="Checkout">
  9745. <RemoveDir Directories="$(MSBuildProjectDirectory)\Test\Checkout" />
  9746. <SvnCheckout RepositoryPath="file:///d:/svn/repo/Test/trunk"
  9747. LocalPath="$(MSBuildProjectDirectory)\Test\Checkout">
  9748. <Output TaskParameter="Revision" PropertyName="Revision" />
  9749. </SvnCheckout>
  9750. <Message Text="Revision: $(Revision)"/>
  9751. </Target>
  9752. ]]></code>
  9753. </example>
  9754. </member>
  9755. <member name="M:MSBuild.Community.Tasks.Subversion.SvnCheckout.#ctor">
  9756. <summary>
  9757. Initializes a new instance of the <see cref="T:SvnCheckout"/> class.
  9758. </summary>
  9759. </member>
  9760. <member name="M:MSBuild.Community.Tasks.Subversion.SvnCheckout.ValidateParameters">
  9761. <summary>
  9762. Indicates whether all task paratmeters are valid.
  9763. </summary>
  9764. <returns>
  9765. true if all task parameters are valid; otherwise, false.
  9766. </returns>
  9767. </member>
  9768. <member name="T:MSBuild.Community.Tasks.Subversion.SvnCommit">
  9769. <summary>
  9770. Subversion Commit command
  9771. </summary>
  9772. </member>
  9773. <member name="M:MSBuild.Community.Tasks.Subversion.SvnCommit.#ctor">
  9774. <summary>
  9775. Initializes a new instance of the <see cref="T:SvnCommit"/> class.
  9776. </summary>
  9777. </member>
  9778. <member name="M:MSBuild.Community.Tasks.Subversion.SvnCommit.ValidateParameters">
  9779. <summary>
  9780. Indicates whether all task paratmeters are valid.
  9781. </summary>
  9782. <returns>
  9783. true if all task parameters are valid; otherwise, false.
  9784. </returns>
  9785. </member>
  9786. <member name="T:MSBuild.Community.Tasks.Subversion.SvnExport">
  9787. <summary>
  9788. Export a folder from a Subversion repository
  9789. </summary>
  9790. <example> Export from repository
  9791. <code><![CDATA[
  9792. <Target Name="Export">
  9793. <MakeDir Directories="$(MSBuildProjectDirectory)\Test" />
  9794. <RemoveDir Directories="$(MSBuildProjectDirectory)\Test\Export" />
  9795. <SvnExport RepositoryPath="file:///d:/svn/repo/Test/trunk"
  9796. LocalPath="$(MSBuildProjectDirectory)\Test\Export">
  9797. <Output TaskParameter="Revision" PropertyName="Revision" />
  9798. </SvnExport>
  9799. <Message Text="Revision: $(Revision)"/>
  9800. </Target>
  9801. ]]></code>
  9802. </example>
  9803. </member>
  9804. <member name="M:MSBuild.Community.Tasks.Subversion.SvnExport.#ctor">
  9805. <summary>
  9806. Initializes a new instance of the <see cref="T:SvnExport"/> class.
  9807. </summary>
  9808. </member>
  9809. <member name="M:MSBuild.Community.Tasks.Subversion.SvnExport.ValidateParameters">
  9810. <summary>
  9811. Indicates whether all task paratmeters are valid.
  9812. </summary>
  9813. <returns>
  9814. true if all task parameters are valid; otherwise, false.
  9815. </returns>
  9816. </member>
  9817. <member name="T:MSBuild.Community.Tasks.Subversion.SvnVersion">
  9818. <summary>
  9819. Summarize the local revision(s) of a working copy.
  9820. </summary>
  9821. <example>The following example gets the revision of the current folder.
  9822. <code><![CDATA[
  9823. <Target Name="Version">
  9824. <SvnVersion LocalPath=".">
  9825. <Output TaskParameter="Revision" PropertyName="Revision" />
  9826. </SvnVersion>
  9827. <Message Text="Revision: $(Revision)"/>
  9828. </Target>
  9829. ]]></code>
  9830. </example>
  9831. </member>
  9832. <member name="M:MSBuild.Community.Tasks.Subversion.SvnVersion.#ctor">
  9833. <summary>
  9834. Initializes a new instance of the <see cref="T:SvnVersion"/> class.
  9835. </summary>
  9836. </member>
  9837. <member name="M:MSBuild.Community.Tasks.Subversion.SvnVersion.GenerateFullPathToTool">
  9838. <summary>
  9839. Returns the fully qualified path to the executable file.
  9840. </summary>
  9841. <returns>
  9842. The fully qualified path to the executable file.
  9843. </returns>
  9844. </member>
  9845. <member name="M:MSBuild.Community.Tasks.Subversion.SvnVersion.LogToolCommand(System.String)">
  9846. <summary>
  9847. Logs the starting point of the run to all registered loggers.
  9848. </summary>
  9849. <param name="message">A descriptive message to provide loggers, usually the command line and switches.</param>
  9850. </member>
  9851. <member name="M:MSBuild.Community.Tasks.Subversion.SvnVersion.GenerateCommandLineCommands">
  9852. <summary>
  9853. Returns a string value containing the command line arguments to pass directly to the executable file.
  9854. </summary>
  9855. <returns>
  9856. A string value containing the command line arguments to pass directly to the executable file.
  9857. </returns>
  9858. </member>
  9859. <member name="M:MSBuild.Community.Tasks.Subversion.SvnVersion.Execute">
  9860. <summary>
  9861. Runs the exectuable file with the specified task parameters.
  9862. </summary>
  9863. <returns>
  9864. true if the task runs successfully; otherwise, false.
  9865. </returns>
  9866. </member>
  9867. <member name="M:MSBuild.Community.Tasks.Subversion.SvnVersion.LogEventsFromTextOutput(System.String,Microsoft.Build.Framework.MessageImportance)">
  9868. <summary>
  9869. Logs the events from text output.
  9870. </summary>
  9871. <param name="singleLine">The single line.</param>
  9872. <param name="messageImportance">The message importance.</param>
  9873. </member>
  9874. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.LocalPath">
  9875. <summary>Path to local working copy.</summary>
  9876. </member>
  9877. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.UseLastCommittedRevision">
  9878. <summary>
  9879. Specifies whether to use the last committed revision number as
  9880. opposed to the last updated revision number.
  9881. </summary>
  9882. </member>
  9883. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.Revision">
  9884. <summary>Revision number of the local working repository.</summary>
  9885. </member>
  9886. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.HighRevision">
  9887. <summary>High revision number of the local working repository revision range.</summary>
  9888. </member>
  9889. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.LowRevision">
  9890. <summary>Low revision number of the local working repository revision range.</summary>
  9891. </member>
  9892. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.Modifications">
  9893. <summary>True if working copy contains modifications.</summary>
  9894. </member>
  9895. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.Switched">
  9896. <summary>True if working copy is switched.</summary>
  9897. </member>
  9898. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.Exported">
  9899. <summary>
  9900. True if invoked on a directory that is not a working copy,
  9901. svnversion assumes it is an exported working copy and prints "exported".
  9902. </summary>
  9903. </member>
  9904. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.StandardOutputLoggingImportance">
  9905. <summary>
  9906. Gets the <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.
  9907. </summary>
  9908. <value></value>
  9909. <returns>The <see cref="T:Microsoft.Build.Framework.MessageImportance"></see> with which to log errors.</returns>
  9910. </member>
  9911. <member name="P:MSBuild.Community.Tasks.Subversion.SvnVersion.ToolName">
  9912. <summary>
  9913. Gets the name of the executable file to run.
  9914. </summary>
  9915. <value></value>
  9916. <returns>The name of the executable file to run.</returns>
  9917. </member>
  9918. <member name="T:MSBuild.Community.Tasks.Subversion.SvnUpdate">
  9919. <summary>
  9920. Subversion Update command
  9921. </summary>
  9922. </member>
  9923. <member name="M:MSBuild.Community.Tasks.Subversion.SvnUpdate.#ctor">
  9924. <summary>
  9925. Initializes a new instance of the <see cref="T:SvnUpdate"/> class.
  9926. </summary>
  9927. </member>
  9928. <member name="M:MSBuild.Community.Tasks.Subversion.SvnUpdate.ValidateParameters">
  9929. <summary>
  9930. Indicates whether all task paratmeters are valid.
  9931. </summary>
  9932. <returns>
  9933. true if all task parameters are valid; otherwise, false.
  9934. </returns>
  9935. </member>
  9936. <member name="T:MSBuild.Community.Tasks.Unzip">
  9937. <summary>
  9938. Unzip a file to a target directory.
  9939. </summary>
  9940. <example>Unzip file tasks
  9941. <code><![CDATA[
  9942. <Unzip ZipFileName="MSBuild.Community.Tasks.zip"
  9943. TargetDirectory="Backup"/>
  9944. ]]></code>
  9945. </example>
  9946. </member>
  9947. <member name="M:MSBuild.Community.Tasks.Unzip.#ctor">
  9948. <summary>
  9949. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Unzip"/> class.
  9950. </summary>
  9951. </member>
  9952. <member name="M:MSBuild.Community.Tasks.Unzip.Execute">
  9953. <summary>
  9954. When overridden in a derived class, executes the task.
  9955. </summary>
  9956. <returns>
  9957. true if the task successfully executed; otherwise, false.
  9958. </returns>
  9959. </member>
  9960. <member name="P:MSBuild.Community.Tasks.Unzip.ZipFileName">
  9961. <summary>
  9962. Gets or sets the name of the zip file.
  9963. </summary>
  9964. <value>The name of the zip file.</value>
  9965. </member>
  9966. <member name="P:MSBuild.Community.Tasks.Unzip.TargetDirectory">
  9967. <summary>
  9968. Gets or sets the target directory.
  9969. </summary>
  9970. <value>The target directory.</value>
  9971. </member>
  9972. <member name="P:MSBuild.Community.Tasks.Unzip.Overwrite">
  9973. <summary>
  9974. Gets or sets a value indicating whether to overwrite any existing files on extraction. Defaults to <c>true</c>.
  9975. </summary>
  9976. <value><c>true</c> to overwrite any existing files on extraction; otherwise, <c>false</c>.</value>
  9977. </member>
  9978. <member name="P:MSBuild.Community.Tasks.Unzip.ExtractedFiles">
  9979. <summary>
  9980. Gets the files extracted from the zip.
  9981. </summary>
  9982. <value>The files extracted from the zip.</value>
  9983. </member>
  9984. <member name="T:MSBuild.Community.Tasks.Version">
  9985. <summary>
  9986. Generates version information based on various algorithms
  9987. </summary>
  9988. <example>Get version information from file and increment revision.
  9989. <code><![CDATA[
  9990. <Version VersionFile="number.txt" BuildType="Automatic" RevisionType="Increment">
  9991. <Output TaskParameter="Major" PropertyName="Major" />
  9992. <Output TaskParameter="Minor" PropertyName="Minor" />
  9993. <Output TaskParameter="Build" PropertyName="Build" />
  9994. <Output TaskParameter="Revision" PropertyName="Revision" />
  9995. </Version>
  9996. <Message Text="Version: $(Major).$(Minor).$(Build).$(Revision)"/>
  9997. ]]></code>
  9998. </example>
  9999. <example>Specify Major and Minor version information and generate Build and Revision.
  10000. <code><![CDATA[
  10001. <Version BuildType="Automatic" RevisionType="Automatic" Major="1" Minor="3" >
  10002. <Output TaskParameter="Major" PropertyName="Major" />
  10003. <Output TaskParameter="Minor" PropertyName="Minor" />
  10004. <Output TaskParameter="Build" PropertyName="Build" />
  10005. <Output TaskParameter="Revision" PropertyName="Revision" />
  10006. </Version>
  10007. <Message Text="Version: $(Major).$(Minor).$(Build).$(Revision)"/>
  10008. ]]></code>
  10009. </example>
  10010. </member>
  10011. <member name="M:MSBuild.Community.Tasks.Version.#ctor">
  10012. <summary>
  10013. Initializes a new instance of the <see cref="T:Version"/> class.
  10014. </summary>
  10015. </member>
  10016. <member name="M:MSBuild.Community.Tasks.Version.Execute">
  10017. <summary>
  10018. When overridden in a derived class, executes the task.
  10019. </summary>
  10020. <returns>
  10021. true if the task successfully executed; otherwise, false.
  10022. </returns>
  10023. </member>
  10024. <member name="P:MSBuild.Community.Tasks.Version.Major">
  10025. <summary>
  10026. Gets or sets the major version number.
  10027. </summary>
  10028. <value>The major version number.</value>
  10029. </member>
  10030. <member name="P:MSBuild.Community.Tasks.Version.Minor">
  10031. <summary>
  10032. Gets or sets the minor version number.
  10033. </summary>
  10034. <value>The minor version number.</value>
  10035. </member>
  10036. <member name="P:MSBuild.Community.Tasks.Version.Build">
  10037. <summary>
  10038. Gets or sets the build version number.
  10039. </summary>
  10040. <seealso cref="P:MSBuild.Community.Tasks.Version.BuildType"/>
  10041. <value>The build version number.</value>
  10042. </member>
  10043. <member name="P:MSBuild.Community.Tasks.Version.Revision">
  10044. <summary>
  10045. Gets or sets the revision version number.
  10046. </summary>
  10047. <seealso cref="P:MSBuild.Community.Tasks.Version.RevisionType"/>
  10048. <value>The revision version number.</value>
  10049. </member>
  10050. <member name="P:MSBuild.Community.Tasks.Version.VersionFile">
  10051. <summary>
  10052. Gets or sets the file used to initialize and persist the version.
  10053. </summary>
  10054. <value>The version file.</value>
  10055. <remarks>
  10056. When specified, the task will attempt to load the previous version information from the file.
  10057. After updating the version, the new value will be saved to the file.
  10058. <para>
  10059. If you do not specify a value for this property, the version will be calculated
  10060. based on the values passed to the <see cref="P:MSBuild.Community.Tasks.Version.Major"/>, <see cref="P:MSBuild.Community.Tasks.Version.Minor"/>,
  10061. <see cref="P:MSBuild.Community.Tasks.Version.Build"/>, and <see cref="P:MSBuild.Community.Tasks.Version.Revision"/> properties. The new version will not be persisted.</para></remarks>
  10062. </member>
  10063. <member name="P:MSBuild.Community.Tasks.Version.MajorType">
  10064. <summary>
  10065. Gets or sets the method used to generate a <see cref="P:MSBuild.Community.Tasks.Version.Major"/> number
  10066. </summary>
  10067. <remarks>
  10068. If value is not provided, None is assumed.
  10069. The <see cref="P:MSBuild.Community.Tasks.Version.Major"/> number is set according to the following table:
  10070. <list type="table">
  10071. <listheader><term>MajorType</term><description>Description</description></listheader>
  10072. <item><term>None</term><description>The number is not modified.</description></item>
  10073. <item><term>Increment</term><description>Increases the previous <see cref="P:MSBuild.Community.Tasks.Version.Major"/> value by 1.</description></item>
  10074. </list>
  10075. </remarks>
  10076. </member>
  10077. <member name="P:MSBuild.Community.Tasks.Version.MinorType">
  10078. <summary>
  10079. Gets or sets the method used to generate a <see cref="P:MSBuild.Community.Tasks.Version.Minor"/> number
  10080. </summary>
  10081. <remarks>
  10082. If value is not provided, None is assumed.
  10083. The <see cref="P:MSBuild.Community.Tasks.Version.Minor"/> number is set according to the following table:
  10084. <list type="table">
  10085. <listheader><term>MinorType</term><description>Description</description></listheader>
  10086. <item><term>None</term><description>The number is not modified.</description></item>
  10087. <item><term>Increment</term><description>Increases the previous <see cref="P:MSBuild.Community.Tasks.Version.Minor"/> value by 1.</description></item>
  10088. <item><term>Reset</term><description>Resets the previous <see cref="P:MSBuild.Community.Tasks.Version.Minor"/> value to 0.</description></item>
  10089. </list>
  10090. </remarks>
  10091. </member>
  10092. <member name="P:MSBuild.Community.Tasks.Version.BuildType">
  10093. <summary>
  10094. Gets or sets the method used to generate a <see cref="P:MSBuild.Community.Tasks.Version.Build"/> number
  10095. </summary>
  10096. <remarks>
  10097. If value is not provided, None is assumed.
  10098. The <see cref="P:MSBuild.Community.Tasks.Version.Build"/> number is set according to the following table:
  10099. <list type="table">
  10100. <listheader><term>BuildType</term><description>Description</description></listheader>
  10101. <item><term>None</term><description>The number is not modified.</description></item>
  10102. <item><term>Automatic</term><description>The number of days since <see cref="P:MSBuild.Community.Tasks.Version.StartDate"/>.</description></item>
  10103. <item><term>Increment</term><description>Increases the previous <see cref="P:MSBuild.Community.Tasks.Version.Build"/> value by 1.</description></item>
  10104. <item><term>Reset</term><description>Resets the previous <see cref="P:MSBuild.Community.Tasks.Version.Build"/> value to 0.</description></item>
  10105. </list>
  10106. </remarks>
  10107. </member>
  10108. <member name="P:MSBuild.Community.Tasks.Version.RevisionType">
  10109. <summary>
  10110. Gets or sets the method used to generate a <see cref="P:MSBuild.Community.Tasks.Version.Revision"/> number
  10111. </summary>
  10112. <remarks>
  10113. If value is not provided, None is assumed.
  10114. The <see cref="P:MSBuild.Community.Tasks.Version.Revision"/> number is set according to the following table:
  10115. <list type="table">
  10116. <listheader><term>RevisionType</term><description>Description</description></listheader>
  10117. <item><term>None</term><description>The number is not modified.</description></item>
  10118. <item><term>Automatic</term><description>A number that starts at 0 at midnight, and constantly increases throughout the day (changing roughly every 1.3 seconds). Guaranteed to be safe for components of the AssemblyVersion attribute.</description></item>
  10119. <item><term>Increment</term><description>Increases the previous <see cref="P:MSBuild.Community.Tasks.Version.Revision"/> value by 1.</description></item>
  10120. <item><term>BuildIncrement</term><description>Increases the previous <see cref="P:MSBuild.Community.Tasks.Version.Revision"/> value by 1 when the value of <see cref="P:MSBuild.Community.Tasks.Version.Build"/> is unchanged. If the value of <see cref="P:MSBuild.Community.Tasks.Version.Build"/> has changed, <see cref="P:MSBuild.Community.Tasks.Version.Revision"/> is reset to 0.</description></item>
  10121. <item><term>Reset</term><description>Resets the previous <see cref="P:MSBuild.Community.Tasks.Version.Revision"/> value to 0.</description></item>
  10122. </list>
  10123. </remarks>
  10124. </member>
  10125. <member name="P:MSBuild.Community.Tasks.Version.StartDate">
  10126. <summary>
  10127. Gets or sets the starting date used to calculate the <see cref="P:MSBuild.Community.Tasks.Version.Build"/> number when <see cref="P:MSBuild.Community.Tasks.Version.BuildType"/> is Automatic.
  10128. </summary>
  10129. <value>The starting date for calculation of the build number.</value>
  10130. <remarks>
  10131. This value is only used when the <see cref="P:MSBuild.Community.Tasks.Version.BuildType"/> is Automatic.
  10132. <para>This default value is January 1, 2000.</para>
  10133. </remarks>
  10134. </member>
  10135. <member name="T:MSBuild.Community.Tasks.WebDownload">
  10136. <summary>
  10137. Downloads a resource with the specified URI to a local file.
  10138. </summary>
  10139. <example>Download the Microsoft.com home page.
  10140. <code><![CDATA[
  10141. <WebDownload FileUri="http://www.microsoft.com/default.aspx"
  10142. FileName="microsoft.html" />
  10143. ]]></code>
  10144. </example>
  10145. <example>Download a page from your local intranet protected by Windows Authentication
  10146. <code><![CDATA[
  10147. <WebDownload FileUri="http://intranet/default.aspx" FileName="page.html" UseDefaultCredentials="True" />
  10148. ]]></code>
  10149. </example>
  10150. <example>Download a page from a password protected website
  10151. <code><![CDATA[
  10152. <WebDownload FileUri="http://example.com/myscore.aspx" FileName="page.html" Username="joeuser" Password="password123" />
  10153. ]]></code>
  10154. </example>
  10155. </member>
  10156. <member name="M:MSBuild.Community.Tasks.WebDownload.Execute">
  10157. <summary>
  10158. When overridden in a derived class, executes the task.
  10159. </summary>
  10160. <returns>
  10161. true if the task successfully executed; otherwise, false.
  10162. </returns>
  10163. </member>
  10164. <member name="M:MSBuild.Community.Tasks.WebDownload.GetConfiguredCredentials">
  10165. <summary>
  10166. Determines which credentials to pass with the web request
  10167. </summary>
  10168. <returns></returns>
  10169. </member>
  10170. <member name="P:MSBuild.Community.Tasks.WebDownload.FileName">
  10171. <summary>
  10172. Gets or sets the name of the local file that is to receive the data.
  10173. </summary>
  10174. <value>The name of the file.</value>
  10175. </member>
  10176. <member name="P:MSBuild.Community.Tasks.WebDownload.FileUri">
  10177. <summary>
  10178. Gets or sets the URI from which to download data.
  10179. </summary>
  10180. <value>The file URI.</value>
  10181. </member>
  10182. <member name="P:MSBuild.Community.Tasks.WebDownload.UseDefaultCredentials">
  10183. <summary>
  10184. When true, the current user's credentials are used to authenticate against the remote web server
  10185. </summary>
  10186. <remarks>
  10187. This value is ignored if the <see cref="P:MSBuild.Community.Tasks.WebDownload.Username"/> property is set to a non-empty value.</remarks>
  10188. </member>
  10189. <member name="P:MSBuild.Community.Tasks.WebDownload.Username">
  10190. <summary>
  10191. The username used to authenticate against the remote web server
  10192. </summary>
  10193. </member>
  10194. <member name="P:MSBuild.Community.Tasks.WebDownload.Password">
  10195. <summary>
  10196. The password used to authenticate against the remote web server. A value for <see cref="P:MSBuild.Community.Tasks.WebDownload.Username"/> must also be provided.
  10197. </summary>
  10198. </member>
  10199. <member name="P:MSBuild.Community.Tasks.WebDownload.Domain">
  10200. <summary>
  10201. The domain of the user being used to authenticate against the remote web server. A value for <see cref="P:MSBuild.Community.Tasks.WebDownload.Username"/> must also be provided.
  10202. </summary>
  10203. </member>
  10204. <member name="T:MSBuild.Community.Tasks.XmlRead">
  10205. <summary>
  10206. Reads a value from a XML document using a XPath.
  10207. </summary>
  10208. <example>Read all targest from a build project.
  10209. <code><![CDATA[
  10210. <XmlRead Prefix="n"
  10211. Namespace="http://schemas.microsoft.com/developer/msbuild/2003"
  10212. XPath="/n:Project/n:Target/@Name"
  10213. XmlFileName="Subversion.proj">
  10214. <Output TaskParameter="Value" PropertyName="BuildTargets" />
  10215. </XmlRead>
  10216. <Message Text="Build Targets: $(BuildTargets)"/>
  10217. ]]></code>
  10218. </example>
  10219. <remarks>
  10220. If the XPath returns multiple nodes, the Value will
  10221. be a semicolon delimited list of the nodes text.
  10222. </remarks>
  10223. </member>
  10224. <member name="M:MSBuild.Community.Tasks.XmlRead.#ctor">
  10225. <summary>
  10226. Initializes a new instance of the <see cref="T:XmlRead"/> class.
  10227. </summary>
  10228. </member>
  10229. <member name="M:MSBuild.Community.Tasks.XmlRead.Execute">
  10230. <summary>
  10231. When overridden in a derived class, executes the task.
  10232. </summary>
  10233. <returns>
  10234. true if the task successfully executed; otherwise, false.
  10235. </returns>
  10236. </member>
  10237. <member name="P:MSBuild.Community.Tasks.XmlRead.XmlFileName">
  10238. <summary>
  10239. Gets or sets the name of the XML file.
  10240. </summary>
  10241. <value>The name of the XML file.</value>
  10242. </member>
  10243. <member name="P:MSBuild.Community.Tasks.XmlRead.XPath">
  10244. <summary>
  10245. Gets or sets the XPath.
  10246. </summary>
  10247. <value>The XPath.</value>
  10248. </member>
  10249. <member name="P:MSBuild.Community.Tasks.XmlRead.Value">
  10250. <summary>
  10251. Gets the value read from file.
  10252. </summary>
  10253. <value>The value.</value>
  10254. <remarks>
  10255. If the XPath returns multiple nodes, the values will be semicolon delimited.
  10256. </remarks>
  10257. </member>
  10258. <member name="P:MSBuild.Community.Tasks.XmlRead.Namespace">
  10259. <summary>
  10260. Gets or sets the default namespace.
  10261. </summary>
  10262. <value>The namespace.</value>
  10263. </member>
  10264. <member name="P:MSBuild.Community.Tasks.XmlRead.Prefix">
  10265. <summary>
  10266. Gets or sets the prefix to associate with the namespace being added.
  10267. </summary>
  10268. <value>The namespace prefix.</value>
  10269. </member>
  10270. <member name="T:MSBuild.Community.Tasks.XmlUpdate">
  10271. <summary>
  10272. Updates a XML document using a XPath.
  10273. </summary>
  10274. <example>Update a XML element.
  10275. <code><![CDATA[
  10276. <XmlUpdate Prefix="n"
  10277. Namespace="http://schemas.microsoft.com/developer/msbuild/2003"
  10278. XPath="/n:Project/n:PropertyGroup/n:TestUpdate"
  10279. XmlFileName="Subversion.proj"
  10280. Value="Test from $(MSBuildProjectFile)"/>
  10281. ]]></code>
  10282. </example>
  10283. <remarks>
  10284. The XML node being updated must exist before using the XmlUpdate task.
  10285. </remarks>
  10286. </member>
  10287. <member name="M:MSBuild.Community.Tasks.XmlUpdate.#ctor">
  10288. <summary>
  10289. Initializes a new instance of the <see cref="T:XmlUpdate"/> class.
  10290. </summary>
  10291. </member>
  10292. <member name="M:MSBuild.Community.Tasks.XmlUpdate.Execute">
  10293. <summary>
  10294. When overridden in a derived class, executes the task.
  10295. </summary>
  10296. <returns>
  10297. true if the task successfully executed; otherwise, false.
  10298. </returns>
  10299. </member>
  10300. <member name="P:MSBuild.Community.Tasks.XmlUpdate.XmlFileName">
  10301. <summary>
  10302. Gets or sets the name of the XML file.
  10303. </summary>
  10304. <value>The name of the XML file.</value>
  10305. </member>
  10306. <member name="P:MSBuild.Community.Tasks.XmlUpdate.XPath">
  10307. <summary>
  10308. Gets or sets the XPath.
  10309. </summary>
  10310. <value>The XPath.</value>
  10311. </member>
  10312. <member name="P:MSBuild.Community.Tasks.XmlUpdate.Value">
  10313. <summary>
  10314. Gets or sets the value to write.
  10315. </summary>
  10316. <value>The value.</value>
  10317. </member>
  10318. <member name="P:MSBuild.Community.Tasks.XmlUpdate.Delete">
  10319. <summary>
  10320. Gets or sets a value indicating whether the matched node is deleted.
  10321. </summary>
  10322. <value><c>true</c> to delete matched node; otherwise, <c>false</c>.</value>
  10323. </member>
  10324. <member name="P:MSBuild.Community.Tasks.XmlUpdate.Namespace">
  10325. <summary>
  10326. Gets or sets the default namespace.
  10327. </summary>
  10328. <value>The namespace.</value>
  10329. </member>
  10330. <member name="P:MSBuild.Community.Tasks.XmlUpdate.Prefix">
  10331. <summary>
  10332. Gets or sets the prefix to associate with the namespace being added.
  10333. </summary>
  10334. <value>The namespace prefix.</value>
  10335. </member>
  10336. <member name="T:MSBuild.Community.Tasks.Zip">
  10337. <summary>
  10338. Create a zip file with the files specified.
  10339. </summary>
  10340. <example>Create a zip file
  10341. <code><![CDATA[
  10342. <ItemGroup>
  10343. <ZipFiles Include="**\*.*" Exclude="*.zip" />
  10344. </ItemGroup>
  10345. <Target Name="Zip">
  10346. <Zip Files="@(ZipFiles)"
  10347. ZipFileName="MSBuild.Community.Tasks.zip" />
  10348. </Target>
  10349. ]]></code>
  10350. Create a zip file using a working directory.
  10351. <code><![CDATA[
  10352. <ItemGroup>
  10353. <RepoFiles Include="D:\svn\repo\**\*.*" />
  10354. </ItemGroup>
  10355. <Target Name="Zip">
  10356. <Zip Files="@(RepoFiles)"
  10357. WorkingDirectory="D:\svn\repo"
  10358. ZipFileName="D:\svn\repo.zip" />
  10359. </Target>
  10360. ]]></code>
  10361. </example>
  10362. </member>
  10363. <member name="M:MSBuild.Community.Tasks.Zip.#ctor">
  10364. <summary>
  10365. Initializes a new instance of the <see cref="T:MSBuild.Community.Tasks.Zip"/> class.
  10366. </summary>
  10367. </member>
  10368. <member name="M:MSBuild.Community.Tasks.Zip.Execute">
  10369. <summary>
  10370. When overridden in a derived class, executes the task.
  10371. </summary>
  10372. <returns>
  10373. true if the task successfully executed; otherwise, false.
  10374. </returns>
  10375. </member>
  10376. <member name="P:MSBuild.Community.Tasks.Zip.ZipFileName">
  10377. <summary>
  10378. Gets or sets the name of the zip file.
  10379. </summary>
  10380. <value>The name of the zip file.</value>
  10381. </member>
  10382. <member name="P:MSBuild.Community.Tasks.Zip.ZipLevel">
  10383. <summary>
  10384. Gets or sets the zip level. Default is 6.
  10385. </summary>
  10386. <value>The zip level.</value>
  10387. <remarks>0 - store only to 9 - means best compression</remarks>
  10388. </member>
  10389. <member name="P:MSBuild.Community.Tasks.Zip.Files">
  10390. <summary>
  10391. Gets or sets the files to zip.
  10392. </summary>
  10393. <value>The files to zip.</value>
  10394. </member>
  10395. <member name="P:MSBuild.Community.Tasks.Zip.Flatten">
  10396. <summary>
  10397. Gets or sets a value indicating whether this <see cref="T:MSBuild.Community.Tasks.Zip"/> is flatten.
  10398. </summary>
  10399. <value><c>true</c> if flatten; otherwise, <c>false</c>.</value>
  10400. <remarks>
  10401. Flattening the zip means that all directories will be removed
  10402. and the files will be place at the root of the zip file
  10403. </remarks>
  10404. </member>
  10405. <member name="P:MSBuild.Community.Tasks.Zip.Comment">
  10406. <summary>
  10407. Gets or sets the comment.
  10408. </summary>
  10409. <value>The comment.</value>
  10410. </member>
  10411. <member name="P:MSBuild.Community.Tasks.Zip.WorkingDirectory">
  10412. <summary>
  10413. Gets or sets the working directory for the zip file.
  10414. </summary>
  10415. <value>The working directory.</value>
  10416. <remarks>
  10417. The working directory is the base of the zip file.
  10418. All files will be made relative from the working directory.
  10419. </remarks>
  10420. </member>
  10421. <member name="P:MSBuild.Community.Tasks.Zip.Password">
  10422. <summary>
  10423. Gets or sets the password.
  10424. </summary>
  10425. <value>The password.</value>
  10426. </member>
  10427. <member name="P:MSBuild.Community.Tasks.Zip.Encryption">
  10428. <summary>
  10429. Gets or sets the encryption algorithm.
  10430. </summary>
  10431. <value>The encryption algorithm.</value>
  10432. <remarks>
  10433. Possible values are None, PkzipWeak, WinZipAes128 and WinZipAes256
  10434. </remarks>
  10435. </member>
  10436. </members>
  10437. </doc>