/tools/nant/NAnt.Contrib.Tasks.xml

http://github.com/philiplaureano/LinFu · XML · 18933 lines · 18931 code · 2 blank · 0 comment · 0 complexity · 996c18b83e8fcfe897def53448d66db5 MD5 · raw file

Large files are truncated click here to view the full file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>NAnt.Contrib.Tasks</name>
  5. </assembly>
  6. <members>
  7. <member name="T:NAnt.Contrib.Functions.FileSetFunctions">
  8. <summary>
  9. Provides methods for interrogating Filesets.
  10. </summary>
  11. </member>
  12. <member name="M:NAnt.Contrib.Functions.FileSetFunctions.GetFileCount(System.String)">
  13. <summary>
  14. Determines the number of files within a <see cref="T:NAnt.Core.Types.FileSet"/>.
  15. </summary>
  16. <param name="fileset">The id of the FileSet to scan.</param>
  17. <returns>The number of files included in the FileSet</returns>
  18. <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
  19. <example>
  20. <para>
  21. Define a fileset and check the number of files in it.
  22. </para>
  23. <code>
  24. <![CDATA[
  25. <fileset id="test.fileset">
  26. <include name="**/*.cs">
  27. </fileset>
  28. <echo message="FileSet contains ${fileset::get-file-count('test.fileset')} files." />
  29. ]]>
  30. </code>
  31. </example>
  32. </member>
  33. <member name="M:NAnt.Contrib.Functions.FileSetFunctions.HasFiles(System.String)">
  34. <summary>
  35. Determines whether <see cref="T:NAnt.Core.Types.FileSet"/> contains any files.
  36. </summary>
  37. <param name="fileset">The id of the fileset to check.</param>
  38. <returns><see langword="true"/> if the FileSet contains one or more files, otherwise <see langword="false"/>.</returns>
  39. <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
  40. <example>
  41. <para>
  42. Perform conditional processing on a fileset if it contains files.
  43. </para>
  44. <code>
  45. <![CDATA[
  46. <fileset id="test.fileset">
  47. <include name="**/*.cs">
  48. </fileset>
  49. <if test="${fileset::has-files('test.fileset')}">
  50. <dostuff... />
  51. </if>
  52. ]]>
  53. </code>
  54. </example>
  55. </member>
  56. <member name="M:NAnt.Contrib.Functions.FileSetFunctions.ToString(System.String,System.String)">
  57. <summary>
  58. Returns a delimited string of all the filenames within a <see cref="T:NAnt.Core.Types.FileSet"/> with each filename
  59. separated by the specified delimiter string.
  60. </summary>
  61. <param name="fileset">The id of the fileset to check.</param>
  62. <param name="delimiter">String to separate filenames with.</param>
  63. <returns>A delimited string of the filenames within the specified FileSet.</returns>
  64. <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
  65. <example>
  66. <para>
  67. Displays a space-pipe-space separated string fo the files within a defined FileSet.
  68. </para>
  69. <code>
  70. <![CDATA[
  71. <fileset id="test.fileset">
  72. <include name="**/*.cs">
  73. </fileset>
  74. <echo message="${fileset::to-string('test.fileset', ' | ')}">
  75. ]]>
  76. </code>
  77. </example>
  78. </member>
  79. <member name="T:NAnt.Contrib.Functions.ServiceFunctions">
  80. <summary>
  81. Allow information on a Windows service to be retrieved.
  82. </summary>
  83. </member>
  84. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsInstalled(System.String,System.String)">
  85. <summary>
  86. Returns a value indicating whether the specified service is
  87. installed on a given machine.
  88. </summary>
  89. <param name="service">The short name that identifies the service to the system.</param>
  90. <param name="machineName">The computer on which the service resides.</param>
  91. <returns>
  92. <see langword="true"/> if the service is installed; otherwise,
  93. <see langword="false"/>.
  94. </returns>
  95. <remarks>
  96. For the machineName parameter, you can use "." or a zero-length
  97. <see cref="T:System.String"/> to represent the local computer.
  98. </remarks>
  99. <example>
  100. <para>
  101. The following example starts the "World Wide Web Publishing"
  102. service if it's installed on the local computer.
  103. </para>
  104. <code>
  105. <![CDATA[
  106. <if test="${service::is-installed('World Wide Web Publishing', '.')}">
  107. <servicecontroller action="Start" service="World Wide Web Publishing" />
  108. </if>
  109. ]]>
  110. </code>
  111. </example>
  112. </member>
  113. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsRunning(System.String,System.String)">
  114. <summary>
  115. Returns a value indicating whether the specified service is running.
  116. </summary>
  117. <param name="service">The short name that identifies the service to the system.</param>
  118. <param name="machineName">The computer on which the service resides.</param>
  119. <returns>
  120. <see langword="true"/> if the service is running; otherwise,
  121. <see langword="false"/>.
  122. </returns>
  123. <remarks>
  124. For the machineName parameter, you can use "." or a zero-length
  125. <see cref="T:System.String"/> to represent the local computer.
  126. </remarks>
  127. </member>
  128. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsStopped(System.String,System.String)">
  129. <summary>
  130. Returns a value indicating whether the specified service is stopped.
  131. </summary>
  132. <param name="service">The short name that identifies the service to the system.</param>
  133. <param name="machineName">The computer on which the service resides.</param>
  134. <returns>
  135. <see langword="true"/> if the service is stopped; otherwise,
  136. <see langword="false"/>.
  137. </returns>
  138. <remarks>
  139. For the machineName parameter, you can use "." or a zero-length
  140. <see cref="T:System.String"/> to represent the local computer.
  141. </remarks>
  142. </member>
  143. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsPaused(System.String,System.String)">
  144. <summary>
  145. Returns a value indicating whether the specified service is paused.
  146. </summary>
  147. <param name="service">The short name that identifies the service to the system.</param>
  148. <param name="machineName">The computer on which the service resides.</param>
  149. <returns>
  150. <see langword="true"/> if the service is paused; otherwise,
  151. <see langword="false"/>.
  152. </returns>
  153. <remarks>
  154. For the machineName parameter, you can use "." or a zero-length
  155. <see cref="T:System.String"/> to represent the local computer.
  156. </remarks>
  157. </member>
  158. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetStatus(System.String,System.String)">
  159. <summary>
  160. Gets the status of the specified service.
  161. </summary>
  162. <param name="service">The short name that identifies the service to the system.</param>
  163. <param name="machineName">The computer on which the service resides.</param>
  164. <returns>
  165. One of the <see cref="T:System.ServiceProcess.ServiceControllerStatus"/> values that
  166. indicates whether the service is running, stopped, or paused, or
  167. whether a start, stop, pause, or continue command is pending.
  168. </returns>
  169. <remarks>
  170. <para>
  171. For the machineName parameter, you can use "." or a zero-length
  172. <see cref="T:System.String"/> to represent the local computer.
  173. </para>
  174. <para>
  175. The value returned by <see cref="M:NAnt.Contrib.Functions.ServiceFunctions.GetStatus(System.String,System.String)"/> can be compared
  176. to either a corresponding enum field name or the underlying
  177. integral value.
  178. </para>
  179. </remarks>
  180. <example>
  181. <para>
  182. Displays a warning if the <b>Alerter</b> service is stopping
  183. on <c>SV-ARD-EAI1</c>.
  184. </para>
  185. <code>
  186. <![CDATA[
  187. <if test="${service::get-status('Alerter', 'SV-ARD-EAI1') == 'StopPending'}">
  188. <echo level="Warning">The Alerter service is stopping.</echo>
  189. </if>
  190. ]]>
  191. </code>
  192. </example>
  193. <example>
  194. <para>
  195. The "deploy-web-application" target is only executed if
  196. IIS is running on the local computer.
  197. </para>
  198. <code>
  199. <![CDATA[
  200. <target name="deploy" depends="deploy-sql-scripts, deploy-web-application" />
  201. <target name="deploy-sql-scripts">
  202. ...
  203. </target>
  204. <target name="deploy-web-application" if="$(service::get-status('World Wide Web Publishing', '.') == 4)}">
  205. ...
  206. </target>
  207. ]]>
  208. </code>
  209. </example>
  210. </member>
  211. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetDisplayName(System.String,System.String)">
  212. <summary>
  213. Gets the friendly name of the specified service.
  214. </summary>
  215. <param name="service">The short name that identifies the service to the system.</param>
  216. <param name="machineName">The computer on which the service resides.</param>
  217. <returns>
  218. The friendly name of the service, which can be used to identify the service.
  219. </returns>
  220. </member>
  221. <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetServiceName(System.String,System.String)">
  222. <summary>
  223. Gets the name that identifies the specified service
  224. </summary>
  225. <param name="service">The short name that identifies the service to the system.</param>
  226. <param name="machineName">The computer on which the service resides.</param>
  227. <returns>
  228. The name that identifies the service.
  229. </returns>
  230. </member>
  231. <member name="P:NAnt.Contrib.Tasks.BizTalk.BizTalkBase.Database">
  232. <summary>
  233. The name of the management SQL database.
  234. </summary>
  235. </member>
  236. <member name="P:NAnt.Contrib.Tasks.BizTalk.BizTalkBase.Server">
  237. <summary>
  238. The name of the SQL Server where the management database is
  239. located.
  240. </summary>
  241. </member>
  242. <member name="T:NAnt.Contrib.Tasks.BizTalk.Deploy">
  243. <summary>
  244. Deploys an assembly to a given BizTalk configuration database.
  245. </summary>
  246. <remarks>
  247. Deployment will fail if the assembly is already deployed.
  248. </remarks>
  249. </member>
  250. <member name="M:NAnt.Contrib.Tasks.BizTalk.Deploy.ExecuteTask">
  251. <summary>
  252. Deploys the assembly.
  253. </summary>
  254. <exception cref="T:NAnt.Core.BuildException">
  255. <para>The assembly does not exist.</para>
  256. <para>-or-</para>
  257. <para>The assembly binding information file does not exist.</para>
  258. <para>-or-</para>
  259. <para>The assembly could not be deployed.</para>
  260. </exception>
  261. </member>
  262. <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.Assembly">
  263. <summary>
  264. The path to the BizTalk assembly to deploy.
  265. </summary>
  266. </member>
  267. <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.Install">
  268. <summary>
  269. Determines whether to install the assembly in the Global Assembly
  270. Cache. The default is <see langword="false" />.
  271. </summary>
  272. </member>
  273. <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.BindingFile">
  274. <summary>
  275. The path to an assembly binding information file to import bindings
  276. from.
  277. </summary>
  278. </member>
  279. <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.LogFile">
  280. <summary>
  281. The path to the HTML log file to generate.
  282. </summary>
  283. </member>
  284. <member name="T:NAnt.Contrib.Tasks.BizTalk.Export">
  285. <summary>
  286. Exports bindings for a BizTalk assembly to an assembly binding
  287. information file.
  288. </summary>
  289. </member>
  290. <member name="M:NAnt.Contrib.Tasks.BizTalk.Export.ExecuteTask">
  291. <summary>
  292. Exports the bindings.
  293. </summary>
  294. <exception cref="T:NAnt.Core.BuildException">
  295. <para>The assembly does not exist.</para>
  296. <para>-or-</para>
  297. <para>The bindings could not be exported.</para>
  298. </exception>
  299. </member>
  300. <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.Assembly">
  301. <summary>
  302. The path to the BizTalk assembly for which to export bindings.
  303. </summary>
  304. </member>
  305. <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.BindingFile">
  306. <summary>
  307. The path to an assembly binding information file in which the
  308. bindings will be saved.
  309. </summary>
  310. </member>
  311. <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.LogFile">
  312. <summary>
  313. The path to the HTML log file to generate.
  314. </summary>
  315. </member>
  316. <member name="T:NAnt.Contrib.Tasks.BizTalk.Host">
  317. <summary>
  318. Allows BizTalk (in-process) host instances to be controlled.
  319. </summary>
  320. <example>
  321. <para>
  322. Starts the &quot;BizTalkServerApplication&quot; host instance
  323. on server &quot;SV-ARD-EAI&quot;.
  324. </para>
  325. <code>
  326. <![CDATA[
  327. <btshost action="Start" host="BizTalkServerApplication" server="SV-ARD-EAI" />
  328. ]]>
  329. </code>
  330. </example>
  331. <example>
  332. <para>
  333. Stops all &quot;BizTalkServerApplication&quot; host instances.
  334. </para>
  335. <code>
  336. <![CDATA[
  337. <btshost action="Stop" host="BizTalkServerApplication" />
  338. ]]>
  339. </code>
  340. </example>
  341. </member>
  342. <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.HostName">
  343. <summary>
  344. The name of the host on which the perform the action.
  345. </summary>
  346. </member>
  347. <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.Server">
  348. <summary>
  349. The name of the BizTalk server on which to perform the action.
  350. If not specified, the action will be performed on all instances.
  351. </summary>
  352. </member>
  353. <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.Action">
  354. <summary>
  355. The action that should be performed on the host.
  356. </summary>
  357. </member>
  358. <member name="T:NAnt.Contrib.Tasks.BizTalk.Host.HostAction">
  359. <summary>
  360. Defines the actions that can be performed on a host instance.
  361. </summary>
  362. </member>
  363. <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Start">
  364. <summary>
  365. Starts the host instance.
  366. </summary>
  367. </member>
  368. <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Stop">
  369. <summary>
  370. Stops the host instance.
  371. </summary>
  372. </member>
  373. <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Restart">
  374. <summary>
  375. Stops and restarts the host instance.
  376. </summary>
  377. </member>
  378. <member name="T:NAnt.Contrib.Tasks.BizTalk.Import">
  379. <summary>
  380. Imports bindings from a given assembly binding information file into
  381. the specified BizTalk configuration database.
  382. </summary>
  383. </member>
  384. <member name="M:NAnt.Contrib.Tasks.BizTalk.Import.ExecuteTask">
  385. <summary>
  386. Imports the assembly binding information file.
  387. </summary>
  388. <exception cref="T:NAnt.Core.BuildException">
  389. <para>The assembly binding information file does not exist.</para>
  390. <para>-or-</para>
  391. <para>The assembly binding information file could not be imported.</para>
  392. </exception>
  393. </member>
  394. <member name="P:NAnt.Contrib.Tasks.BizTalk.Import.BindingFile">
  395. <summary>
  396. The path to the assembly binding information file containing the
  397. bindings to import.
  398. </summary>
  399. </member>
  400. <member name="P:NAnt.Contrib.Tasks.BizTalk.Import.LogFile">
  401. <summary>
  402. The path to the HTML log file to generate.
  403. </summary>
  404. </member>
  405. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration">
  406. <summary>
  407. Performs a set of actions on a given orchestration.
  408. </summary>
  409. </member>
  410. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.Server">
  411. <summary>
  412. The name of the BizTalk server on which to perform the action.
  413. </summary>
  414. </member>
  415. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationName">
  416. <summary>
  417. The name of the orchestration to perform an action on.
  418. </summary>
  419. </member>
  420. <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationActionBase.Log(NAnt.Core.Level,System.String)">
  421. <summary>
  422. Logs a message with the given priority.
  423. </summary>
  424. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  425. <param name="message">The message to be logged.</param>
  426. <remarks>
  427. The actual logging is delegated to the project.
  428. </remarks>
  429. </member>
  430. <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationActionBase.Log(NAnt.Core.Level,System.String,System.Object[])">
  431. <summary>
  432. Logs a message with the given priority.
  433. </summary>
  434. <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
  435. <param name="message">The message to log, containing zero or more format items.</param>
  436. <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
  437. <remarks>
  438. The actual logging is delegated to the project.
  439. </remarks>
  440. </member>
  441. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction">
  442. <summary>
  443. Starts the orchestration.
  444. </summary>
  445. <remarks>
  446. If the orchestration is not yet enlisted, then this will be done
  447. first.
  448. </remarks>
  449. </member>
  450. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoEnableReceiveLocation">
  451. <summary>
  452. Specifies whether receive locations associated with this
  453. orchestration should be automatically enabled. The default is
  454. <see langword="false" />.
  455. </summary>
  456. </member>
  457. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoResumeOrchestrationInstance">
  458. <summary>
  459. Specifies whether service instances of this orchestration that
  460. were manually suspended previously should be automatically
  461. resumed. The default is <see langword="true" />.
  462. </summary>
  463. </member>
  464. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoStartSendPorts">
  465. <summary>
  466. Specifies whether send ports and send port groups imported by
  467. this orchestration should be automatically started. The default
  468. is <see langword="true" />.
  469. </summary>
  470. </member>
  471. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction">
  472. <summary>
  473. Stops the orchestration.
  474. </summary>
  475. <remarks>
  476. If the status of the orchestration is <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Bound"/>,
  477. <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Unbound"/> or <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Stopped"/>,
  478. then no further processing is done.
  479. </remarks>
  480. </member>
  481. <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.Invoke(System.Management.ManagementObject)">
  482. <summary>
  483. Stops the orchestration.
  484. </summary>
  485. <param name="orchestration">The orchestration to stop.</param>
  486. <remarks>
  487. If the status of orchestration is <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Bound"/>,
  488. <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Unbound"/> or <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Stopped"/>,
  489. then no further processing is done.
  490. </remarks>
  491. </member>
  492. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.AutoDisableReceiveLocation">
  493. <summary>
  494. Specifies whether receive locations associated with this
  495. orchestration should be automatically disabled. The default
  496. is <see langword="false" />.
  497. </summary>
  498. </member>
  499. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.AutoSuspendOrchestrationInstance">
  500. <summary>
  501. Specifies whether instances of this orchestration should be
  502. automatically suspended. The default is <see langword="true" />.
  503. </summary>
  504. </member>
  505. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.EnlistOrchestrationAction">
  506. <summary>
  507. Enlists the orchestration by creating its activation subscription.
  508. </summary>
  509. </member>
  510. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.EnlistOrchestrationAction.Host">
  511. <summary>
  512. Specifies the BizTalk host on which to enlist the orchestration.
  513. </summary>
  514. </member>
  515. <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.UnenlistOrchestrationAction">
  516. <summary>
  517. Unenlists the orchestration by removing its activation subscription.
  518. </summary>
  519. </member>
  520. <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.UnenlistOrchestrationAction.AutoTerminateOrchestrationInstance">
  521. <summary>
  522. Specifies whether instances of this orchestration type should
  523. be automatically terminated. The default is <see langword="false" />.
  524. </summary>
  525. </member>
  526. <member name="T:NAnt.Contrib.Tasks.BizTalk.Reset">
  527. <summary>
  528. Allows stopping, starting and resetting of BizTalk in-process host
  529. instances on the specified server.
  530. </summary>
  531. </member>
  532. <member name="P:NAnt.Contrib.Tasks.BizTalk.Reset.Server">
  533. <summary>
  534. The name of the BizTalk server on which to perform the action.
  535. </summary>
  536. </member>
  537. <member name="P:NAnt.Contrib.Tasks.BizTalk.Reset.Action">
  538. <summary>
  539. Specifies the action(s) to perform on the BizTalk host instances. The
  540. default is <see cref="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Reset"/>.
  541. </summary>
  542. </member>
  543. <member name="T:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction">
  544. <summary>
  545. Defines the possible actions that can be performed on the BizTalk
  546. in-process host instances.
  547. </summary>
  548. </member>
  549. <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Stop">
  550. <summary>
  551. Stops all in-process host instances.
  552. </summary>
  553. </member>
  554. <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Start">
  555. <summary>
  556. Starts all in-process host instances.
  557. </summary>
  558. </member>
  559. <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Reset">
  560. <summary>
  561. Stops and restarts all in-process host instances.
  562. </summary>
  563. </member>
  564. <member name="T:NAnt.Contrib.Tasks.BizTalk.SendPort">
  565. <summary>
  566. Allows BizTalk send ports to be controlled.
  567. </summary>
  568. <example>
  569. <para>
  570. Starts the &quot;UmeHttpSendPort&quot; port on server
  571. &quot;SV-ARD-EAI&quot;.
  572. </para>
  573. <code>
  574. <![CDATA[
  575. <btssendport action="Start" port="UmeHttpSendPort" server="SV-ARD-EAI" />
  576. ]]>
  577. </code>
  578. </example>
  579. <example>
  580. <para>
  581. Unenlists the &quot;UmeHttpSendPort&quot; on server &quot;SV-ARD-EAI&quot;.
  582. </para>
  583. <code>
  584. <![CDATA[
  585. <btssendport action="UnEnlist" port="UmeHttpSendPort" server="SV-ARD-EAI" />
  586. ]]>
  587. </code>
  588. </example>
  589. </member>
  590. <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.PortName">
  591. <summary>
  592. The name of the send port on which the perform the action.
  593. </summary>
  594. </member>
  595. <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.Server">
  596. <summary>
  597. The name of the BizTalk server on which to perform the action.
  598. </summary>
  599. </member>
  600. <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.Action">
  601. <summary>
  602. The action that should be performed on the send port.
  603. </summary>
  604. </member>
  605. <member name="T:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction">
  606. <summary>
  607. Defines the actions that can be performed on a BizTalk send port.
  608. </summary>
  609. </member>
  610. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Start">
  611. <summary>
  612. Starts the send port.
  613. </summary>
  614. </member>
  615. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Stop">
  616. <summary>
  617. Stops the send port.
  618. </summary>
  619. </member>
  620. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Restart">
  621. <summary>
  622. Stops and restarts the send port.
  623. </summary>
  624. </member>
  625. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Enlist">
  626. <summary>
  627. Enlists the send port.
  628. </summary>
  629. </member>
  630. <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.UnEnlist">
  631. <summary>
  632. Unenlists the send port.
  633. </summary>
  634. </member>
  635. <member name="T:NAnt.Contrib.Tasks.BizTalk.Unbind">
  636. <summary>
  637. Removes all bindings for a given assembly from a BizTalk configuration
  638. database.
  639. </summary>
  640. </member>
  641. <member name="M:NAnt.Contrib.Tasks.BizTalk.Unbind.ExecuteTask">
  642. <summary>
  643. Removes bindings for the specified assembly.
  644. </summary>
  645. <exception cref="T:NAnt.Core.BuildException">
  646. <para>The assembly does not exist.</para>
  647. <para>-or-</para>
  648. <para>The bindings could not be removed.</para>
  649. </exception>
  650. </member>
  651. <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.Assembly">
  652. <summary>
  653. The path to the BizTalk assembly for which to remove all bindings.
  654. </summary>
  655. </member>
  656. <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.Server">
  657. <summary>
  658. The name of the BizTalk server on which to perform the operation.
  659. </summary>
  660. </member>
  661. <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.ReceivePipeline">
  662. <summary>
  663. The assembly qualified name of the receive pipeline to set when
  664. unbinding a receive pipeline.
  665. </summary>
  666. </member>
  667. <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.SendPipeline">
  668. <summary>
  669. The assembly qualified name of the SEND pipeline to set when
  670. unbinding a send pipeline.
  671. </summary>
  672. </member>
  673. <member name="T:NAnt.Contrib.Tasks.BizTalk.Undeploy">
  674. <summary>
  675. Removes a given assembly from a BizTalk configuration database.
  676. </summary>
  677. </member>
  678. <member name="M:NAnt.Contrib.Tasks.BizTalk.Undeploy.ExecuteTask">
  679. <summary>
  680. Removes an assembly from a BizTalk configuration database.
  681. </summary>
  682. <exception cref="T:NAnt.Core.BuildException">
  683. <para>The assembly does not exist.</para>
  684. <para>-or-</para>
  685. <para>The assembly could not be remove from the BizTalk configuration database.</para>
  686. </exception>
  687. </member>
  688. <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.Assembly">
  689. <summary>
  690. The path to the BizTalk assembly to remove.
  691. </summary>
  692. </member>
  693. <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.Uninstall">
  694. <summary>
  695. Determines whether to remove the assembly from the Global Assembly
  696. Cache. The default is <see langword="false" />.
  697. </summary>
  698. </member>
  699. <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.LogFile">
  700. <summary>
  701. The path to the HTML log file to generate.
  702. </summary>
  703. </member>
  704. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase">
  705. <summary>
  706. Base class for all the ClearCase tasks.
  707. </summary>
  708. </member>
  709. <member name="M:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.#ctor">
  710. <summary>
  711. Base Constructor.
  712. </summary>
  713. </member>
  714. <member name="M:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.ExecuteTask">
  715. <summary>
  716. Execute the perforce command assembled by subclasses.
  717. </summary>
  718. </member>
  719. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.CommandSpecificArguments">
  720. <summary>
  721. Derived classes should override this to provide command-specific
  722. commandline arguments.
  723. </summary>
  724. </member>
  725. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.ProgramArguments">
  726. <summary>
  727. Overrides the base class.
  728. </summary>
  729. </member>
  730. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs">
  731. <summary>
  732. Displays a ClearCase config spec.
  733. </summary>
  734. </member>
  735. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs.ViewTag">
  736. <summary>
  737. The view tag identifying the ClearCase view that will have its
  738. config spec displayed.
  739. </summary>
  740. </member>
  741. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs.CommandSpecificArguments">
  742. <summary>
  743. This is an override used by the base class to get command specific args.
  744. </summary>
  745. </member>
  746. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn">
  747. <summary>
  748. Checks files into a ClearCase VOB.
  749. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut"/>
  750. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut"/>
  751. </summary>
  752. <remarks>
  753. <para>
  754. This task uses the <c>cleartool checkin</c> command to check in ClearCase elements.
  755. </para>
  756. </remarks>
  757. <example>
  758. <para>
  759. Performs a ClearCase checkin on the file <c>c:/views/viewdir/afile</c>.
  760. All warning messages are suppressed, and the element is checked in even if identical to the original.
  761. Comment text from the file <c>acomment.txt</c> is added to ClearCase as a comment. All warning messages are suppressed. The file is checked in even if it is identical to the original.
  762. </para>
  763. <code>
  764. <![CDATA[
  765. <cccheckin viewpath="c:/views/viewdir/afile"
  766. commentfile="acomment.txt"
  767. nowarn="true"
  768. identical="true"/>
  769. ]]>
  770. </code>
  771. </example>
  772. </member>
  773. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.ViewPath">
  774. <summary>
  775. Path to the ClearCase view file or directory that the command will
  776. operate on.
  777. </summary>
  778. </member>
  779. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment">
  780. <summary>
  781. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment"/> or
  782. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile"/> may be used.
  783. </summary>
  784. </member>
  785. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile">
  786. <summary>
  787. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment"/>
  788. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile"/> may be used.
  789. </summary>
  790. </member>
  791. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.NoWarn">
  792. <summary>
  793. <see langword="true" /> if warning messages should be suppressed.
  794. The default is <see langword="false" />.
  795. </summary>
  796. </member>
  797. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.PreserveTime">
  798. <summary>
  799. If <see langword="true" />, the modification time will be preserved.
  800. Default is <see langword="false" />.
  801. </summary>
  802. </member>
  803. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.KeepCopy">
  804. <summary>
  805. <see langword="true" /> to keep a view-private copy of the file with
  806. a .keep extension. Default is <see langword="true" />.
  807. </summary>
  808. </member>
  809. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Identical">
  810. <summary>
  811. If <see langword="true" />, files may be checked in even if identical
  812. to the original. Default is <see langword="false" />.
  813. </summary>
  814. </member>
  815. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommandSpecificArguments">
  816. <summary>
  817. This is an override used by the base class to get command specific args.
  818. </summary>
  819. </member>
  820. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut">
  821. <summary>
  822. Checks files out of a ClearCase VOB.
  823. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn"/>
  824. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut"/>
  825. </summary>
  826. <remarks>
  827. <para>
  828. This task uses the <c>cleartool checkout</c> command to check out ClearCase elements.
  829. </para>
  830. </remarks>
  831. <example>
  832. <para>
  833. Performs a ClearCase checkout on the file <c>c:/views/viewdir/afile</c>.
  834. It is checked out as reserved on branch called <c>abranch</c>.
  835. All warning messages are suppressed.
  836. <c>Some comment text</c> is added to ClearCase as a comment.
  837. </para>
  838. <code>
  839. <![CDATA[
  840. <cccheckout viewpath="c:/views/viewdir/afile"
  841. reserved="true"
  842. branch="abranch"
  843. nowarn="true"
  844. comment="Some comment text"/>
  845. ]]>
  846. </code>
  847. </example>
  848. </member>
  849. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.ViewPath">
  850. <summary>
  851. Path to the ClearCase view file or directory that the command will
  852. operate on.
  853. </summary>
  854. </member>
  855. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Reserved">
  856. <summary>
  857. <see langword="true" /> to check the element out as reserved.
  858. Default is <see langword="true" />.
  859. </summary>
  860. </member>
  861. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.OutFile">
  862. <summary>
  863. Creates a writable file under a different filename.
  864. </summary>
  865. </member>
  866. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.NoData">
  867. <summary>
  868. If <see langword="true" />, checks out the file but does not create
  869. an editable file containing its data. Default is <see langword="false" />.
  870. </summary>
  871. </member>
  872. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Branch">
  873. <summary>
  874. Specify a branch to check out the file to.
  875. </summary>
  876. </member>
  877. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Version">
  878. <summary>
  879. If <see langword="true" />, checkouts of elements with a version
  880. other than main latest will be allowed. Default is <see langword="false" />.
  881. </summary>
  882. </member>
  883. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.NoWarn">
  884. <summary>
  885. <see langword="true" /> if warning messages should be suppressed.
  886. The default is <see langword="false" />.
  887. </summary>
  888. </member>
  889. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment">
  890. <summary>
  891. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment"/> or
  892. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile"/> may be used.
  893. </summary>
  894. </member>
  895. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile">
  896. <summary>
  897. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment"/>
  898. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile"/> may be used.
  899. </summary>
  900. </member>
  901. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.PreserveTime">
  902. <summary>
  903. If <see langword="true" />, the modification time will be preserved.
  904. Default is <see langword="false" />.
  905. </summary>
  906. </member>
  907. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommandSpecificArguments">
  908. <summary>
  909. This is an override used by the base class to get command specific args.
  910. </summary>
  911. </member>
  912. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock">
  913. <summary>
  914. Locks ClearCase elements.
  915. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock"/>
  916. </summary>
  917. <remarks>
  918. <para>
  919. This task uses the <c>cleartool lock</c> command to lock ClearCase elements.
  920. </para>
  921. </remarks>
  922. <example>
  923. <para>
  924. Performs a ClearCase lock on the object <c>stream:Application_Integration@\MyProject_PVOB</c>.
  925. </para>
  926. <code>
  927. <![CDATA[
  928. <cclock objsel="stream:Application_Integration@\MyProject_PVOB" />
  929. ]]>
  930. </code>
  931. </example>
  932. </member>
  933. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Replace">
  934. <summary>
  935. If <see langword="true" /> an existing lock can be replaced.
  936. Default is <see langword="false" />.
  937. </summary>
  938. </member>
  939. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers">
  940. <summary>
  941. Specifies user(s) who can still modify the object.
  942. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete"/> may be
  943. used.
  944. </summary>
  945. </member>
  946. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete">
  947. <summary>
  948. If <see langword="true"/> the object will be marked obsolete.
  949. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete"/> may
  950. be used. Default is <see langword="false"/>.
  951. </summary>
  952. </member>
  953. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment">
  954. <summary>
  955. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment"/> or
  956. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile"/> may be used.
  957. </summary>
  958. </member>
  959. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile">
  960. <summary>
  961. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment"/>
  962. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile"/> may be used.
  963. </summary>
  964. </member>
  965. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Pname">
  966. <summary>
  967. Specifies the object pathname to be locked.
  968. </summary>
  969. </member>
  970. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.ObjSel">
  971. <summary>
  972. Specifies the object(s) to be locked.
  973. </summary>
  974. </member>
  975. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommandSpecificArguments">
  976. <summary>
  977. This is an override used by the base class to get command specific args.
  978. </summary>
  979. </member>
  980. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem">
  981. <summary>
  982. Creates elements in a ClearCase VOB.
  983. </summary>
  984. <remarks>
  985. <para>
  986. This task uses the <c>cleartool mkelem</c> command to create ClearCase elements.
  987. </para>
  988. </remarks>
  989. <example>
  990. <para>
  991. Performs a ClearCase mkelem on the file <c>c:/views/viewdir/afile</c> with element type <c>text_file</c>.
  992. It checks in the file after creation and adds <c>Some comment text</c> as a comment.
  993. </para>
  994. <code>
  995. <![CDATA[
  996. <ccmkelem viewpath="c:/views/viewdir/afile"
  997. eltype="text_file"
  998. checkin="true"
  999. comment="Some comment text"/>
  1000. ]]>
  1001. </code>
  1002. </example>
  1003. </member>
  1004. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.ViewPath">
  1005. <summary>
  1006. Path to the ClearCase view file or directory that the command will
  1007. operate on.
  1008. </summary>
  1009. </member>
  1010. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment">
  1011. <summary>
  1012. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment"/> or
  1013. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile"/> may be used.
  1014. </summary>
  1015. </member>
  1016. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile">
  1017. <summary>
  1018. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment"/>
  1019. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile"/> may be used.
  1020. </summary>
  1021. </member>
  1022. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.NoWarn">
  1023. <summary>
  1024. If <see langword="true" />, warning will be suppressed.
  1025. The default is <see langword="false" />.
  1026. </summary>
  1027. </member>
  1028. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.NoCheckout">
  1029. <summary>
  1030. Perform a checkout after element creation.
  1031. Default is <see langword="false" />.
  1032. </summary>
  1033. </member>
  1034. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Checkin">
  1035. <summary>
  1036. Checkin element after creation.
  1037. Default is <see langword="false" />.
  1038. </summary>
  1039. </member>
  1040. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.PreserveTime">
  1041. <summary>
  1042. If <see langword="true" />, the modification time will be preserved.
  1043. Default is <see langword="false" />.
  1044. </summary>
  1045. </member>
  1046. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Master">
  1047. <summary>
  1048. Assign mastership of the main branch to the current site.
  1049. Default is <see langword="false" />.
  1050. </summary>
  1051. </member>
  1052. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.ElType">
  1053. <summary>
  1054. Element type to use during element creation.
  1055. </summary>
  1056. </member>
  1057. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.MkPath">
  1058. <summary>
  1059. Create elements from the view-private parent directories.
  1060. Default is <see langword="false" />.
  1061. </summary>
  1062. </member>
  1063. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommandSpecificArguments">
  1064. <summary>
  1065. This is an override used by the base class to get command specific args.
  1066. </summary>
  1067. </member>
  1068. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel">
  1069. <summary>
  1070. Applies a ClearCase label.
  1071. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType"/>
  1072. </summary>
  1073. <remarks>
  1074. <para>
  1075. This task uses the <c>cleartool mklabel</c> command to apply a ClearCase label to specified elements.
  1076. </para>
  1077. </remarks>
  1078. <example>
  1079. <para>
  1080. Performs a ClearCase mklabel on the file <c>c:/views/viewdir/afile</c> under
  1081. the <c>main</c> branch for <c>version 2</c> (<c>\main\2</c>). All matching
  1082. elements will be applied with label <c>VERSION_1</c>.
  1083. <c>Some comment text</c> is added as a comment. Subdirectories will be recursed.
  1084. </para>
  1085. <code>
  1086. <![CDATA[
  1087. <ccmklabel viewpath="c:/views/viewdir/afile"
  1088. comment="Some comment text"
  1089. recurse="true"
  1090. version="\main\2"
  1091. typename="VERSION_1"/>
  1092. ]]>
  1093. </code>
  1094. </example>
  1095. </member>
  1096. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Typename">
  1097. <summary>
  1098. Name of the label type
  1099. </summary>
  1100. </member>
  1101. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.ViewPath">
  1102. <summary>
  1103. Path to the ClearCase view file or directory that the command will
  1104. operate on.
  1105. </summary>
  1106. </member>
  1107. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Replace">
  1108. <summary>
  1109. If <see langword="true" />, allow the replacement of a
  1110. label of the same type on the same branch.
  1111. The default is <see langword="false" />.
  1112. </summary>
  1113. </member>
  1114. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Recurse">
  1115. <summary>