PageRenderTime 123ms CodeModel.GetById 19ms RepoModel.GetById 0ms app.codeStats 2ms

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

http://github.com/philiplaureano/LinFu
XML | 9984 lines | 9982 code | 2 blank | 0 comment | 0 complexity | 996c18b83e8fcfe897def53448d66db5 MD5 | raw 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>
  1116. If <see langword="true" />, process each subdirectory recursively under the viewpath.
  1117. Default is <see langword="false" />.
  1118. </summary>
  1119. </member>
  1120. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Version">
  1121. <summary>
  1122. Identify a specific version to attach the label to.
  1123. </summary>
  1124. </member>
  1125. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Vob">
  1126. <summary>
  1127. Path to the ClearCase view file or directory that the command will operate on.
  1128. </summary>
  1129. </member>
  1130. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment">
  1131. <summary>
  1132. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment"/> or
  1133. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile"/> may be used.
  1134. </summary>
  1135. </member>
  1136. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile">
  1137. <summary>
  1138. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment"/>
  1139. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile"/> may be used.
  1140. </summary>
  1141. </member>
  1142. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Follow">
  1143. <summary>
  1144. For any VOB symbolic links encountered, labels the corresponding target.
  1145. </summary>
  1146. </member>
  1147. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommandSpecificArguments">
  1148. <summary>
  1149. This is an override used by the base class to get command specific args.
  1150. </summary>
  1151. </member>
  1152. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType">
  1153. <summary>
  1154. Creates a label object in a ClearCase VOB.
  1155. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel"/>
  1156. </summary>
  1157. <remarks>
  1158. <para>
  1159. This task uses the <c>cleartool mklabeltype</c> command to create a ClearCase label object.
  1160. </para>
  1161. </remarks>
  1162. <example>
  1163. <para>
  1164. Performs a ClearCase mklbtype to create a label type named <c>VERSION_1</c>.
  1165. It is created as <c>ordinary</c> so it is available only to the current VOB.
  1166. The text <c>Development version 1</c> is added as a comment.
  1167. </para>
  1168. <code>
  1169. <![CDATA[
  1170. <ccmklbtype typename="VERSION_1"
  1171. ordinary="true"
  1172. comment="Development version 1"/>
  1173. ]]>
  1174. </code>
  1175. </example>
  1176. </member>
  1177. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Typename">
  1178. <summary>
  1179. Name of the label type to create.
  1180. </summary>
  1181. </member>
  1182. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Vob">
  1183. <summary>
  1184. Name of the VOB. Must be a valid path to somewhere on a VOB.
  1185. </summary>
  1186. </member>
  1187. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Replace">
  1188. <summary>
  1189. If <see langword="true" />, allow an existing label definition to be replaced.
  1190. The default is <see langword="false" />.
  1191. </summary>
  1192. </member>
  1193. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Global">
  1194. <summary>
  1195. Creates a label type that is global to the VOB or to VOB's that use this VOB.
  1196. Either global or ordinary can be specified, not both.
  1197. The default is <see langword="false" />.
  1198. </summary>
  1199. </member>
  1200. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Ordinary">
  1201. <summary>
  1202. Creates a label type that can be used only in the current VOB.
  1203. Either global or ordinary can be specified, not both.
  1204. Although <see langword="false" /> by default, if global is also <see langword="false" /> or not specified ordinary is the default behaviour.
  1205. </summary>
  1206. </member>
  1207. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.PBranch">
  1208. <summary>
  1209. If <see langword="true" /> the label type is allowed to be used once per branch in a given element's version tree.
  1210. The default is <see langword="false" />.
  1211. </summary>
  1212. </member>
  1213. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Shared">
  1214. <summary>
  1215. Sets the way mastership is checked by ClearCase. See ClearCase documentation for details.
  1216. The default is <see langword="false" />.
  1217. </summary>
  1218. </member>
  1219. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment">
  1220. <summary>
  1221. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment"/> or
  1222. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile"/> may be used.
  1223. </summary>
  1224. </member>
  1225. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile">
  1226. <summary>
  1227. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment"/>
  1228. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile"/> may be used.
  1229. </summary>
  1230. </member>
  1231. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommandSpecificArguments">
  1232. <summary>
  1233. This is an override used by the base class to get command specific args.
  1234. </summary>
  1235. </member>
  1236. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType">
  1237. <summary>
  1238. Removes elements from a ClearCase VOB.
  1239. </summary>
  1240. <remarks>
  1241. <para>
  1242. This task uses the <c>cleartool rmtype</c> command to remove a ClearCase object.
  1243. </para>
  1244. </remarks>
  1245. <example>
  1246. <para>
  1247. Performs a ClearCase rmtype to remove a <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Label"/>
  1248. type named <c>VERSION_1</c>.
  1249. Comment text from the file <c>acomment.txt</c> is added as a comment.
  1250. All instances of the type are removed, including the type object itself.
  1251. </para>
  1252. <code>
  1253. <![CDATA[
  1254. <ccrmtype typekind="Label"
  1255. typename="VERSION_1"
  1256. commentfile="acomment.txt"
  1257. removeall="true" />
  1258. ]]>
  1259. </code>
  1260. </example>
  1261. </member>
  1262. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.TypeKind">
  1263. <summary>
  1264. The kind of type to remove.
  1265. </summary>
  1266. </member>
  1267. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.TypeName">
  1268. <summary>
  1269. The name of the object to remove.
  1270. </summary>
  1271. </member>
  1272. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Ignore">
  1273. <summary>
  1274. Used with <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Trigger"/> types only.
  1275. Forces removal of <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Trigger"/> type even if a
  1276. pre-operation trigger would prevent its removal.
  1277. The default is <see langword="false"/>.
  1278. </summary>
  1279. </member>
  1280. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.RemoveAll">
  1281. <summary>
  1282. Removes all instances of a type and the type object itself.
  1283. The default is <see langword="false" />.
  1284. </summary>
  1285. </member>
  1286. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment">
  1287. <summary>
  1288. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment"/> or
  1289. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile"/> may be used.
  1290. </summary>
  1291. </member>
  1292. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile">
  1293. <summary>
  1294. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment"/>
  1295. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile"/> may be used.
  1296. </summary>
  1297. </member>
  1298. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommandSpecificArguments">
  1299. <summary>
  1300. This is an override used by the base class to get command specific args.
  1301. </summary>
  1302. </member>
  1303. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut">
  1304. <summary>
  1305. Uncheckout ClearCase elements.
  1306. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn"/>
  1307. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut"/>
  1308. </summary>
  1309. <remarks>
  1310. <para>
  1311. This task uses the <c>cleartool unco</c> command to remove a ClearCase object.
  1312. </para>
  1313. </remarks>
  1314. <example>
  1315. <para>
  1316. Does a ClearCase uncheckout on the file <c>c:/views/viewdir/afile</c>.
  1317. A copy of the file called <c>c:/views/viewdir/afile.keep</c> is kept.
  1318. </para>
  1319. <code>
  1320. <![CDATA[
  1321. <ccuncheckout viewpath="c:/views/viewdir/afile"
  1322. keepcopy="true"/>
  1323. ]]>
  1324. </code>
  1325. </example>
  1326. </member>
  1327. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.ViewPath">
  1328. <summary>
  1329. Path to the ClearCase view file or directory that the command will
  1330. operate on.
  1331. </summary>
  1332. </member>
  1333. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.KeepCopy">
  1334. <summary>
  1335. If <see langword="true" />, a view-private copy of the file with a
  1336. .keep extension will be kept. Default is <see langword="true" />.
  1337. </summary>
  1338. </member>
  1339. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.CommandSpecificArguments">
  1340. <summary>
  1341. This is an override used by the base class to get command specific args.
  1342. </summary>
  1343. </member>
  1344. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock">
  1345. <summary>
  1346. Unlocks ClearCase elements.
  1347. <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock"/>
  1348. </summary>
  1349. <remarks>
  1350. <para>
  1351. This task uses the <c>cleartool unlock</c> command to unlock a ClearCase object.
  1352. </para>
  1353. </remarks>
  1354. <example>
  1355. <para>
  1356. Performs a ClearCase unlock on the object <c>stream:Application_Integration@\MyProject_PVOB</c>.
  1357. </para>
  1358. <code>
  1359. <![CDATA[
  1360. <ccunlock objsel="stream:Application_Integration@\MyProject_PVOB" />
  1361. ]]>
  1362. </code>
  1363. </example>
  1364. </member>
  1365. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment">
  1366. <summary>
  1367. Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment"/> or
  1368. <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile"/> may be used.
  1369. </summary>
  1370. </member>
  1371. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile">
  1372. <summary>
  1373. Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment"/>
  1374. or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile"/> may be used.
  1375. </summary>
  1376. </member>
  1377. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Pname">
  1378. <summary>
  1379. Specifies the object pathname to be unlocked.
  1380. </summary>
  1381. </member>
  1382. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.ObjSel">
  1383. <summary>
  1384. Specifies the object(s) to be unlocked.
  1385. </summary>
  1386. </member>
  1387. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommandSpecificArguments">
  1388. <summary>
  1389. This is an override used by the base class to get command specific args.
  1390. </summary>
  1391. </member>
  1392. <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate">
  1393. <summary>
  1394. Updates a ClearCase view.
  1395. </summary>
  1396. <remarks>
  1397. <para>
  1398. This task uses the <c>cleartool update</c> command to update a ClearCase view.
  1399. </para>
  1400. </remarks>
  1401. <example>
  1402. <para>
  1403. Performs a ClearCase update on the snapshot view directory <c>c:/views/viewdir</c>.
  1404. A graphical dialog will be displayed.
  1405. The output will be logged to <c>log.log</c> and it will overwrite any hijacked files.
  1406. The modified time will be set to the current time.
  1407. </para>
  1408. <code>
  1409. <![CDATA[
  1410. <ccupdate viewpath="c:/views/viewdir"
  1411. graphical="false"
  1412. log="log.log"
  1413. overwrite="true"
  1414. currenttime="true"
  1415. rename="false"/>
  1416. ]]>
  1417. </code>
  1418. </example>
  1419. </member>
  1420. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.ViewPath">
  1421. <summary>
  1422. Path to the ClearCase view file or directory that the command will
  1423. operate on.
  1424. </summary>
  1425. </member>
  1426. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Graphical">
  1427. <summary>
  1428. Displays a graphical dialog during the update.
  1429. The default is <see langword="false" />.
  1430. </summary>
  1431. </member>
  1432. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.LogFile">
  1433. <summary>
  1434. Specifies a log file for ClearCase to write to.
  1435. </summary>
  1436. </member>
  1437. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Overwrite">
  1438. <summary>
  1439. If <see langword="true" />, hijacked files will be overwritten.
  1440. The default is <see langword="false" />.
  1441. </summary>
  1442. </member>
  1443. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Rename">
  1444. <summary>
  1445. If <see langword="true" />, hijacked files will be renamed with a .keep extension.
  1446. The default is <see langword="false" />.
  1447. </summary>
  1448. </member>
  1449. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime">
  1450. <summary>
  1451. Specifies that modification time should be written as the current time.
  1452. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime"/>
  1453. can be specified. The default is <see langword="false"/>.
  1454. </summary>
  1455. </member>
  1456. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime">
  1457. <summary>
  1458. Specifies that modification time should preserved from the VOB time.
  1459. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime"/>
  1460. can be specified. The default is <see langword="false"/>.
  1461. </summary>
  1462. </member>
  1463. <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CommandSpecificArguments">
  1464. <summary>
  1465. This is an override used by the base class to get command specific args.
  1466. </summary>
  1467. </member>
  1468. <member name="T:NAnt.Contrib.Tasks.Grep.GrepTask">
  1469. <summary>
  1470. Searches files for a regular-expression and produces an XML report of
  1471. the matches.
  1472. </summary>
  1473. <example>
  1474. <para>
  1475. Extract all <i>TODO:</i>, <i>UNDONE:</i> or <i>HACK:</i>-
  1476. comment-tags from C# source files and write them to a file
  1477. <i>out.xml</i>. (A xslt-stylesheet could then transform it to
  1478. a nice html-page for your project-homepage, but that is beyond
  1479. the scope of this example.)
  1480. </para>
  1481. <para>
  1482. <i>Path</i>, <i>File</i> and <i>LineNumber</i> are automatically
  1483. generated elements.
  1484. </para>
  1485. <code>
  1486. <![CDATA[
  1487. <grep output="out.xml" pattern="// (?'Type'TODO|UNDONE|HACK): (\[(?'Author'\w*),(?'Date'.*)\])? (?'Text'[^\n\r]*)">
  1488. <fileset>
  1489. <include name="*.cs" />
  1490. </fileset>
  1491. </grep>
  1492. ]]>
  1493. </code>
  1494. <para>
  1495. The resulting XML file for a comment-tag
  1496. 'TODO: [md, 14-02-2004] comment this method'
  1497. will look like
  1498. </para>
  1499. <code>
  1500. <![CDATA[
  1501. <?xml version="1.0" encoding="utf-8" ?>
  1502. <Matches>
  1503. <Match>
  1504. <Type>TODO</Type>
  1505. <Text>comment this method</Text>
  1506. <Path>C:\MyProjects\MyPath</Path>
  1507. <File>MyFile.cs</Filename>
  1508. <LineNumber>146</LineNumber>
  1509. <Author>md</Author>
  1510. <Date>14-02-2004</Date>
  1511. </Match>
  1512. ...
  1513. </Matches>
  1514. ]]>
  1515. </code>
  1516. </example>
  1517. </member>
  1518. <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.ExecuteTask">
  1519. <summary>
  1520. Performs the regex-search.
  1521. </summary>
  1522. </member>
  1523. <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.WriteXml(NAnt.Contrib.Tasks.Grep.MatchCollection,System.IO.StreamWriter)">
  1524. <summary>
  1525. Writes the collection of matches to the specified <see cref="T:System.IO.StreamWriter"/>
  1526. in XML format.
  1527. </summary>
  1528. <param name="matches">The matches to write.</param>
  1529. <param name="writer"><see cref="T:System.IO.StreamWriter"/> to write the matches to.</param>
  1530. </member>
  1531. <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.WriteMatches(NAnt.Contrib.Tasks.Grep.MatchCollection)">
  1532. <summary>
  1533. Writes the specified matches to <see cref="P:NAnt.Contrib.Tasks.Grep.GrepTask.OutputFile"/>.
  1534. </summary>
  1535. <param name="matches">The collection of matches to write.</param>
  1536. </member>
  1537. <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.OutputFile">
  1538. <summary>
  1539. Specifies the name of the output file.
  1540. </summary>
  1541. </member>
  1542. <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.Pattern">
  1543. <summary>
  1544. Specifies the regular-expression to search for.
  1545. </summary>
  1546. </member>
  1547. <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.InputFiles">
  1548. <summary>
  1549. The set of files in which the expression is searched.
  1550. </summary>
  1551. </member>
  1552. <member name="T:NAnt.Contrib.Tasks.Grep.LineCounter">
  1553. <summary>
  1554. This purpose of this class is to get the line-numbers within
  1555. a string for a specific position of a character
  1556. (an index, as returned by the <see cref="T:System.Text.RegularExpressions.Regex"/> class).
  1557. </summary>
  1558. </member>
  1559. <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._string">
  1560. <summary>
  1561. The string to count in
  1562. </summary>
  1563. </member>
  1564. <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentPos">
  1565. <summary>
  1566. The current position within <see cref="F:NAnt.Contrib.Tasks.Grep.LineCounter._string"/>.
  1567. </summary>
  1568. </member>
  1569. <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentLine">
  1570. <summary>
  1571. The number of line feeds upto (but exluding) <see cref="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentPos"/>.
  1572. </summary>
  1573. </member>
  1574. <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.#ctor(System.String)">
  1575. <summary>
  1576. Constructs a line-counter for a <see cref="T:System.String"/>.
  1577. </summary>
  1578. <param name="str"><see cref="T:System.String"/> for which lines are counted.</param>
  1579. </member>
  1580. <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.CountTo(System.Int32)">
  1581. <summary>
  1582. Counts the line-numbers until the position <paramref name="pos" />
  1583. is reached.
  1584. </summary>
  1585. <param name="pos">Index into the string given during construction </param>
  1586. <returns>
  1587. The number of lines.
  1588. </returns>
  1589. </member>
  1590. <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.Count(System.String,System.Char,System.Int32,System.Int32)">
  1591. <summary>
  1592. Counts the number of occurences of <paramref name="c"/> in the
  1593. range from <paramref name="start"/> to <paramref name="end"/> in
  1594. string <paramref name="str"/>.
  1595. </summary>
  1596. <param name="str"><see cref="T:System.String"/> to count in.</param>
  1597. <param name="c">Character to count.</param>
  1598. <param name="start">Start of range.</param>
  1599. <param name="end">End of range.</param>
  1600. <returns>
  1601. The number of occurences of <paramref name="c"/> in the range from
  1602. <paramref name="start"/> to <paramref name="end"/> in string
  1603. <paramref name="str"/>.
  1604. </returns>
  1605. </member>
  1606. <member name="T:NAnt.Contrib.Tasks.Grep.Match">
  1607. <summary>
  1608. Encapsulation of a match of a regular-expression with the
  1609. associated named capture-groups.
  1610. </summary>
  1611. </member>
  1612. <member name="F:NAnt.Contrib.Tasks.Grep.Match.values">
  1613. <summary>
  1614. <see cref="T:System.Collections.Hashtable"/> containing the mapping from group names
  1615. to values.
  1616. </summary>
  1617. </member>
  1618. <member name="M:NAnt.Contrib.Tasks.Grep.Match.WriteXml(System.Xml.XmlTextWriter)">
  1619. <summary>
  1620. Writes this match to an <see cref="T:System.Xml.XmlTextWriter"/>.
  1621. </summary>
  1622. <param name="xmlWriter">The <see cref="T:System.Xml.XmlTextWriter"/> to write to.</param>
  1623. </member>
  1624. <member name="P:NAnt.Contrib.Tasks.Grep.Match.Item(System.String)">
  1625. <summary>
  1626. Gets or sets the value for a capture group.
  1627. </summary>
  1628. </member>
  1629. <member name="T:NAnt.Contrib.Tasks.Grep.MatchCollection">
  1630. <summary>
  1631. A strongly-typed collection of <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances.
  1632. </summary>
  1633. </member>
  1634. <member name="M:NAnt.Contrib.Tasks.Grep.MatchCollection.Add(NAnt.Contrib.Tasks.Grep.Match)">
  1635. <summary>
  1636. Adds a <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> to this collection.
  1637. </summary>
  1638. <param name="match"><see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> to add.</param>
  1639. </member>
  1640. <member name="M:NAnt.Contrib.Tasks.Grep.MatchCollection.Add(NAnt.Contrib.Tasks.Grep.MatchCollection)">
  1641. <summary>
  1642. Adds all <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances <paramref name="matches"/>
  1643. to this collection.
  1644. </summary>
  1645. <param name="matches">Collection of <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances to add.</param>
  1646. </member>
  1647. <member name="P:NAnt.Contrib.Tasks.Grep.MatchCollection.Item(System.Int32)">
  1648. <summary>
  1649. Gets the <paramref name="idx" />th match stored in this collection.
  1650. </summary>
  1651. </member>
  1652. <member name="T:NAnt.Contrib.Tasks.Grep.Pattern">
  1653. <summary>
  1654. Encapsulation of a search pattern.
  1655. </summary>
  1656. </member>
  1657. <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.#ctor(System.String)">
  1658. <summary>
  1659. Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.Grep.Pattern"/> class from
  1660. a regular-expression.
  1661. </summary>
  1662. <param name="regex">The regular-expression.</param>
  1663. </member>
  1664. <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.ConcatenateCaptures(System.Text.RegularExpressions.Group)">
  1665. <summary>
  1666. Concatenates the captures of <paramref name="group"/> to a string.
  1667. </summary>
  1668. <param name="group"><see cref="T:System.Text.RegularExpressions.Group"/> containing the captures.</param>
  1669. <returns>
  1670. <see cref="T:System.String"/> containg the concatenated captures.
  1671. </returns>
  1672. <remarks>
  1673. A named-group can captured multiple times, when the regular
  1674. expression has a quantifier, e.g. (// (?'Text'.*) )* will match
  1675. multiline comments with group <i>Text</i> having a capture for
  1676. every line.
  1677. </remarks>
  1678. </member>
  1679. <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.Extract(System.String,System.String)">
  1680. <summary>
  1681. Extracts the matches of this pattern from <paramref name="source" />.
  1682. </summary>
  1683. <param name="filename">The name of the file associated with <paramref name="source" />.</param>
  1684. <param name="source">The source string</param>
  1685. <returns>
  1686. A collection of found matches.
  1687. </returns>
  1688. </member>
  1689. <member name="T:NAnt.Contrib.Tasks.Mks.BaseTask">
  1690. <summary>
  1691. The base abstract class for all MKS Tasks.
  1692. </summary>
  1693. <remarks>
  1694. Provides the core attributes, and functionality for opening an item
  1695. in a MKS database.
  1696. </remarks>
  1697. </member>
  1698. <member name="M:NAnt.Contrib.Tasks.Mks.BaseTask.Open">
  1699. <summary>
  1700. Opens the MKS database and sets the reference to the specified
  1701. item and version.
  1702. </summary>
  1703. </member>
  1704. <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Password">
  1705. <summary>
  1706. The password to use to login to the MKS database.
  1707. </summary>
  1708. </member>
  1709. <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.UserName">
  1710. <summary>
  1711. The name of the user needed to access the MKS database.
  1712. </summary>
  1713. </member>
  1714. <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Host">
  1715. <summary>
  1716. The name of the host MKS server to connect to
  1717. </summary>
  1718. </member>
  1719. <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Port">
  1720. <summary>
  1721. The port number on which the host server is accepting requests
  1722. </summary>
  1723. </member>
  1724. <member name="T:NAnt.Contrib.Tasks.Mks.CheckpointTask">
  1725. <summary>
  1726. Checkpoints a project in an MKS Source Integrity database.
  1727. </summary>
  1728. <example>
  1729. <para>Checkpoint a project in an MKS database.</para>
  1730. <code><![CDATA[
  1731. <mkscheckpoint
  1732. username="myusername"
  1733. password="mypassword"
  1734. host="servername"
  1735. port="123"
  1736. project="myproject"
  1737. recursive="false"
  1738. label="test from nant"
  1739. description="this is a test description"
  1740. />
  1741. ]]></code>
  1742. </example>
  1743. </member>
  1744. <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Label">
  1745. <summary>
  1746. The label to apply to the checkpoint.
  1747. </summary>
  1748. </member>
  1749. <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.ProjectName">
  1750. <summary>
  1751. The project to checkpoint.
  1752. </summary>
  1753. </member>
  1754. <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Recursive">
  1755. <summary>
  1756. Apply label to all members. The default is <see langword="false" />.
  1757. </summary>
  1758. </member>
  1759. <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Description">
  1760. <summary>
  1761. The description of the checkpoint.
  1762. </summary>
  1763. </member>
  1764. <member name="T:NAnt.Contrib.Tasks.Mks.GetTask">
  1765. <summary>
  1766. Retrieves an item or project from MKS Source Integrity.
  1767. </summary>
  1768. <example>
  1769. <para>Synchronise sandbox with MKS project.</para>
  1770. <code><![CDATA[
  1771. <mksget
  1772. username="myusername"
  1773. password="mypassword"
  1774. host="servername"
  1775. port="123"
  1776. localpath="c:\sourcecode"
  1777. project="e:/MKS projects/myproject/testproject.pj"
  1778. />
  1779. ]]></code>
  1780. </example>
  1781. </member>
  1782. <member name="P:NAnt.Contrib.Tasks.Mks.GetTask.LocalPath">
  1783. <summary>
  1784. The path to the local working directory.
  1785. </summary>
  1786. </member>
  1787. <member name="P:NAnt.Contrib.Tasks.Mks.GetTask.ProjectName">
  1788. <summary>
  1789. The project to get from MKS.
  1790. </summary>
  1791. </member>
  1792. <member name="T:NAnt.Contrib.Tasks.Mks.ChangesTask">
  1793. <summary>
  1794. Generates an XML file containing the differences between the sandbox and
  1795. the project in the MKS database.
  1796. </summary>
  1797. <example>
  1798. <para>Get changes to a project in an MKS database.</para>
  1799. <code><![CDATA[
  1800. <mkschanges
  1801. username="myusername"
  1802. password="mypassword"
  1803. host="servername"
  1804. port="123"
  1805. sandbox="mysandbox.pj"
  1806. output="mychanges.xml"
  1807. />
  1808. ]]></code>
  1809. </example>
  1810. </member>
  1811. <member name="P:NAnt.Contrib.Tasks.Mks.ChangesTask.Sandbox">
  1812. <summary>
  1813. The project to retrieve the changes for.
  1814. </summary>
  1815. </member>
  1816. <member name="P:NAnt.Contrib.Tasks.Mks.ChangesTask.OutputFile">
  1817. <summary>
  1818. The file where the output will be stored in XML format.
  1819. </summary>
  1820. </member>
  1821. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand">
  1822. <summary>
  1823. Base class for <see cref="T:NAnt.Contrib.Tasks.Msi.MsiCreationCommand"/> and <see cref="T:NAnt.Contrib.Tasks.Msi.MsmCreationCommand"/>.
  1824. </summary>
  1825. </member>
  1826. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.IsVersion(System.String@)">
  1827. <summary>
  1828. Determines if the supplied version string is valid. A valid version string should look like:
  1829. 1
  1830. 1.1
  1831. 1.1.1
  1832. 1.1.1.1
  1833. </summary>
  1834. <param name="Version">The version string to verify.</param>
  1835. <returns></returns>
  1836. </member>
  1837. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ReorderFiles(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32@)">
  1838. <summary>
  1839. Sets the sequence number of files to match their
  1840. storage order in the cabinet file, after some
  1841. files have had their filenames changed to go in
  1842. their own component.
  1843. </summary>
  1844. <param name="database">The MSI database.</param>
  1845. <param name="LastSequence">The last file's sequence number.</param>
  1846. </member>
  1847. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CleanOutput(System.String,System.String)">
  1848. <summary>
  1849. Cleans the output directory after a build.
  1850. </summary>
  1851. <param name="cabFile">The path to the cabinet file.</param>
  1852. <param name="tempPath">The path to temporary files.</param>
  1853. </member>
  1854. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1855. <summary>
  1856. Loads records for the Properties table.
  1857. </summary>
  1858. <param name="database">The MSI database.</param>
  1859. </member>
  1860. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDirectories(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1861. <summary>
  1862. Loads records for the Directories table.
  1863. </summary>
  1864. <param name="database">The MSI database.</param>
  1865. </member>
  1866. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddDirectory(NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,NAnt.Contrib.Schemas.Msi.MSIDirectory,System.Int32)">
  1867. <summary>
  1868. Adds a directory record to the directories table.
  1869. </summary>
  1870. <param name="database">The MSI database.</param>
  1871. <param name="directoryTable">The MSI database view.</param>
  1872. <param name="ParentDirectory">The parent directory.</param>
  1873. <param name="Directory">This directory's Schema object.</param>
  1874. <param name="Depth">The tree depth of this directory.</param>
  1875. </member>
  1876. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetRelativePath(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,System.String,System.String,System.Text.StringBuilder,NAnt.Contrib.Tasks.Msi.InstallerTable)">
  1877. <summary>
  1878. Retrieves the relative path of a file based on
  1879. the component it belongs to and its entry in
  1880. the MSI directory table.
  1881. </summary>
  1882. <param name="database">The MSI database.</param>
  1883. <param name="Name">The Name of the Folder</param>
  1884. <param name="Parent">The Parent of the Folder</param>
  1885. <param name="Default">The Relative Filesystem Path of the Folder</param>
  1886. <param name="Path">The Path to the Folder from previous calls.</param>
  1887. <param name="directoryTable">The MSI database view.</param>
  1888. </member>
  1889. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetDisplayablePath(System.String)">
  1890. <summary>
  1891. If the specified path is longer than 40 characters, 37 are returned plus ...
  1892. </summary>
  1893. <param name="path">A shortened path</param>
  1894. <returns></returns>
  1895. </member>
  1896. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortFile(System.String)">
  1897. <summary>
  1898. Retrieves a DOS 8.3 filename for a file.
  1899. </summary>
  1900. <param name="LongFile">The file to shorten.</param>
  1901. <returns>The new shortened file.</returns>
  1902. </member>
  1903. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortPath(System.String)">
  1904. <summary>
  1905. Retrieves a DOS 8.3 filename for a directory.
  1906. </summary>
  1907. <param name="LongPath">The path to shorten.</param>
  1908. <returns>The new shortened path.</returns>
  1909. </member>
  1910. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortDir(System.String)">
  1911. <summary>
  1912. Retrieves a DOS 8.3 filename for a complete directory.
  1913. </summary>
  1914. <param name="LongPath">The path to shorten.</param>
  1915. <returns>The new shortened path.</returns>
  1916. </member>
  1917. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">
  1918. <summary>
  1919. Recursively expands properties of all attributes of
  1920. a nodelist and their children.
  1921. </summary>
  1922. <param name="Nodes">The nodes to recurse.</param>
  1923. </member>
  1924. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ByteArrayToString(System.Byte[])">
  1925. <summary>
  1926. Converts the Byte array in a public key
  1927. token of an assembly to a string MSI expects.
  1928. </summary>
  1929. <param name="ByteArray">The array of bytes.</param>
  1930. <returns>The string containing the array.</returns>
  1931. </member>
  1932. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadTypeLibs(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1933. <summary>
  1934. Loads TypeLibs for the TypeLib table.
  1935. </summary>
  1936. <param name="database">The MSI database.</param>
  1937. </member>
  1938. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadEnvironmentVariables(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1939. <summary>
  1940. Loads environment variables for the Environment table.
  1941. </summary>
  1942. <param name="database">The MSI database.</param>
  1943. </member>
  1944. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadRegistry(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1945. <summary>
  1946. Loads records for the Registry table.
  1947. </summary>
  1948. <param name="database">The MSI database.</param>
  1949. </member>
  1950. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadRegistryLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1951. <summary>
  1952. Loads records for the RegLocator table
  1953. </summary>
  1954. <param name="database">The MSI database.</param>
  1955. </member>
  1956. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1957. <summary>
  1958. Loads records for the CompLocator table
  1959. </summary>
  1960. <param name="database">The MSI database.</param>
  1961. </member>
  1962. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIniLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1963. <summary>
  1964. Loads records for the IniLocator table
  1965. </summary>
  1966. <param name="database">The MSI database.</param>
  1967. </member>
  1968. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDirFileLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1969. <summary>
  1970. Loads records for the DrLocator table
  1971. </summary>
  1972. <param name="database">The MSI database.</param>
  1973. </member>
  1974. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDepreciatedLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1975. <summary>
  1976. Loads records for the RegLocator table
  1977. </summary>
  1978. <param name="database">The MSI database.</param>
  1979. </member>
  1980. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetRegistryRootByName(System.String)">
  1981. <summary>
  1982. Gets the name of the registry root id by it's name.
  1983. </summary>
  1984. <param name="root">Name of the registry root</param>
  1985. <returns></returns>
  1986. </member>
  1987. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadApplicationSearch(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1988. <summary>
  1989. Loads records for the AppSearch table
  1990. </summary>
  1991. <param name="database">The MSI database.</param>
  1992. </member>
  1993. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIconData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  1994. <summary>
  1995. Loads records for the Icon table.
  1996. </summary>
  1997. <param name="database">The MSI database.</param>
  1998. </member>
  1999. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadShortcutData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2000. <summary>
  2001. Loads records for the Shortcut table.
  2002. </summary>
  2003. <param name="database">The MSI database.</param>
  2004. </member>
  2005. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadUserDefinedTables(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2006. <summary>
  2007. Adds custom table(s) to the msi database
  2008. </summary>
  2009. <param name="database">The MSI database.</param>
  2010. </member>
  2011. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddTableData(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,NAnt.Contrib.Schemas.Msi.MSITable,System.Collections.ArrayList)">
  2012. <summary>
  2013. Adds table data to the msi database table structure
  2014. </summary>
  2015. <param name="database">The MSI database.</param>
  2016. <param name="currentTable">The current table name</param>
  2017. <param name="xmlTable">Xml node representing the current table</param>
  2018. <param name="columnList">List of column objects for the current table (Containing: column name, id, type).</param>
  2019. </member>
  2020. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadBinaryData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2021. <summary>
  2022. Loads records for the Binary table. This table stores items
  2023. such as bitmaps, animations, and icons. The binary table is
  2024. also used to store data for custom actions.
  2025. </summary>
  2026. <param name="database">The MSI database.</param>
  2027. </member>
  2028. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2029. <summary>
  2030. Loads records for the Dialog table.
  2031. </summary>
  2032. <param name="database">The MSI database.</param>
  2033. </member>
  2034. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2035. <summary>
  2036. Loads records for the Control table.
  2037. </summary>
  2038. <param name="database">The MSI database.</param>
  2039. </member>
  2040. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlConditionData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2041. <summary>
  2042. Loads records for the ControlCondtion table.
  2043. </summary>
  2044. <param name="database">The MSI database.</param>
  2045. </member>
  2046. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlEventData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2047. <summary>
  2048. Loads records for the ControlEvent table.
  2049. </summary>
  2050. <param name="database">The MSI database.</param>
  2051. </member>
  2052. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadCustomAction(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2053. <summary>
  2054. Loads records for the CustomAction table
  2055. </summary>
  2056. <param name="database">The MSI database.</param>
  2057. </member>
  2058. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadActionText(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2059. <summary>
  2060. Loads records for the ActionText table. Allows users to specify descriptions/templates for actions.
  2061. </summary>
  2062. <param name="database">The MSI database.</param>
  2063. </member>
  2064. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppMappings(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2065. <summary>
  2066. Loads records for the _AppMappings table.
  2067. </summary>
  2068. <param name="database">The MSI database.</param>
  2069. </member>
  2070. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadUrlProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2071. <summary>
  2072. Loads records for the _UrlToDir table.
  2073. "Load the url properties to convert
  2074. url properties to a properties object" ??
  2075. </summary>
  2076. <param name="database">The MSI database.</param>
  2077. </member>
  2078. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadVDirProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2079. <summary>
  2080. Loads records for the _VDirToUrl table.
  2081. Used for converting a vdir to an url
  2082. </summary>
  2083. <param name="database">The MSI database.</param>
  2084. </member>
  2085. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppRootCreate(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2086. <summary>
  2087. Loads records for the _AppRootCreate table.
  2088. Used for making a virtual directory a virtual application
  2089. </summary>
  2090. <param name="database">The MSI database.</param>
  2091. </member>
  2092. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIISDirectoryProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2093. <summary>
  2094. Loads records for the _IISProperties table.
  2095. </summary>
  2096. <param name="database">The MSI database.</param>
  2097. </member>
  2098. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CheckAssemblyForCOMInterop(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,System.Reflection.Assembly,System.String,System.String,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable)">
  2099. <summary>
  2100. Enumerates the registry to see if an assembly has been registered
  2101. for COM interop, and if so adds these registry keys to the Registry
  2102. table, ProgIds to the ProgId table, classes to the Classes table,
  2103. and a TypeLib to the TypeLib table.
  2104. </summary>
  2105. <param name="database">The MSI database.</param>
  2106. <param name="fileName">The Assembly filename.</param>
  2107. <param name="fileAssembly">The Assembly to check.</param>
  2108. <param name="componentName">The name of the containing component.</param>
  2109. <param name="assemblyComponentName">The name of the containing component's assembly GUID.</param>
  2110. <param name="classTable">View containing the Class table.</param>
  2111. <param name="progIdTable">View containing the ProgId table.</param>
  2112. </member>
  2113. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadSummaryInformation(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2114. <summary>
  2115. Loads properties for the Summary Information Stream.
  2116. </summary>
  2117. <param name="database">The MSI database.</param>
  2118. </member>
  2119. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CreateCabFile(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2120. <summary>
  2121. Creates a .cab file with all source files included.
  2122. </summary>
  2123. <param name="database">The MSI database.</param>
  2124. </member>
  2125. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadSequence(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  2126. <summary>
  2127. Loads records for the sequence tables.
  2128. </summary>
  2129. <param name="database">The MSI database.</param>
  2130. </member>
  2131. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddFiles(NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Schemas.Msi.MSIComponent,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,System.String,System.Int32@,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable)">
  2132. <summary>
  2133. Adds a file record to the Files table.
  2134. </summary>
  2135. <param name="database">The MSI database.</param>
  2136. <param name="directoryTable">The MSI database view.</param>
  2137. <param name="Component">The Component's XML Element.</param>
  2138. <param name="fileTable">The MSI database view.</param>
  2139. <param name="ComponentDirectory">The directory of this file's component.</param>
  2140. <param name="ComponentName">The name of this file's component.</param>
  2141. <param name="Sequence">The installation sequence number of this file.</param>
  2142. <param name="msiAssemblyTable">View containing the MsiAssembly table.</param>
  2143. <param name="msiAssemblyNameTable">View containing the MsiAssemblyName table.</param>
  2144. <param name="componentTable">View containing the Components table.</param>
  2145. <param name="featureComponentTable">View containing the FeatureComponents table.</param>
  2146. <param name="classTable">View containing the Class table.</param>
  2147. <param name="progIdTable">View containing the ProgId table.</param>
  2148. <param name="selfRegTable">View containing the SelfReg table.</param>
  2149. <param name="modComponentTable">ModuleComponent table.</param>
  2150. </member>
  2151. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadComponents(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32@)">
  2152. <summary>
  2153. Loads records for the Components table.
  2154. </summary>
  2155. <param name="database">The MSI database.</param>
  2156. <param name="LastSequence">The sequence number of the last file in the .cab</param>
  2157. </member>
  2158. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.Execute">
  2159. <summary>
  2160. Executes the Task.
  2161. </summary>
  2162. <remarks>None.</remarks>
  2163. </member>
  2164. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerDatabase">
  2165. <summary>
  2166. .NET wrapper for a Windows Installer database
  2167. </summary>
  2168. </member>
  2169. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.DropEmptyTables">
  2170. <summary>
  2171. Drops empty tables.
  2172. </summary>
  2173. </member>
  2174. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.DropEmptyTables(System.Boolean)">
  2175. <summary>
  2176. Drops the empty tables.
  2177. </summary>
  2178. <param name="isMergeModule">Determines if this is a merge module or not</param>
  2179. <remarks>If it is a merge module, the FeatureComponents table should not be dropped.</remarks>
  2180. </member>
  2181. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.VerifyTableEmpty(System.String)">
  2182. <summary>
  2183. Checks to see if the specified table is empty.
  2184. </summary>
  2185. <param name="TableName">Name of the table to check existance.</param>
  2186. <returns>True if empy and False if full.</returns>
  2187. </member>
  2188. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.VerifyTableExistance(System.String)">
  2189. <summary>
  2190. Checks to see if the specified table exists in the database
  2191. already.
  2192. </summary>
  2193. <param name="TableName">Name of the table to check existance.</param>
  2194. <returns>True if successful.</returns>
  2195. </member>
  2196. <member name="T:NAnt.Contrib.Tasks.Msi.Installer">
  2197. <remarks>
  2198. Helper class used to avoid errors when instantiating
  2199. WindowsInstaller.Installer.
  2200. </remarks>
  2201. </member>
  2202. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerRecordReader">
  2203. <summary>
  2204. Use to read and manipulate existing records.
  2205. </summary>
  2206. </member>
  2207. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.#ctor(WindowsInstaller.View)">
  2208. <summary>
  2209. Creates a new reader for the entries in the view
  2210. </summary>
  2211. <param name="view">Database view to read entries from. Must be Execute()'ed already.</param>
  2212. </member>
  2213. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.Read">
  2214. <summary>
  2215. Moves to the next record
  2216. </summary>
  2217. <returns>False iff no more records</returns>
  2218. </member>
  2219. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.DeleteCurrentRecord">
  2220. <summary>
  2221. Deletes the current record. Needs no Commit().
  2222. </summary>
  2223. </member>
  2224. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.SetValue(System.Int32,System.Object)">
  2225. <summary>
  2226. Set the value of a field in the current record. Remember to Commit()
  2227. </summary>
  2228. <param name="index">Zero-based index of the field to set</param>
  2229. <param name="value">New value</param>
  2230. </member>
  2231. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.GetString(System.Int32)">
  2232. <summary>
  2233. Get the string value of a field in the current record.
  2234. </summary>
  2235. <param name="index">Zero-based index of the field to get</param>
  2236. </member>
  2237. <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.Commit">
  2238. <summary>
  2239. Commits changes to the current record.
  2240. </summary>
  2241. </member>
  2242. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerSearchClause">
  2243. <summary>
  2244. A simple class for a single search clause.
  2245. TODO: more comparison types, use of the Composite pattern, etc.
  2246. </summary>
  2247. </member>
  2248. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerTable">
  2249. <summary>
  2250. Represents a single table in a Windows Installer archive
  2251. </summary>
  2252. </member>
  2253. <member name="T:NAnt.Contrib.Tasks.Msi.InstallerTaskBase">
  2254. <summary>
  2255. Base class for msi/msm installer tasks
  2256. </summary>
  2257. </member>
  2258. <member name="T:NAnt.Contrib.Tasks.SchemaValidatedTask">
  2259. <summary>
  2260. Abstract <see cref="T:NAnt.Core.Task"/> that validates inheriting classes against
  2261. an XML schema of the same name.
  2262. </summary>
  2263. </member>
  2264. <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)">
  2265. <summary>
  2266. Initializes the task and verifies parameters.
  2267. </summary>
  2268. <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
  2269. </member>
  2270. <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.Task_OnSchemaValidate(System.Object,System.Xml.Schema.ValidationEventArgs)">
  2271. <summary>
  2272. Occurs when a validation error is raised.
  2273. </summary>
  2274. <param name="sender">The object that sent the event.</param>
  2275. <param name="args">Validation arguments passed in.</param>
  2276. </member>
  2277. <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">
  2278. <summary>
  2279. Recursively expands properties of all attributes of
  2280. a nodelist and their children.
  2281. </summary>
  2282. <param name="Nodes">The nodes to recurse.</param>
  2283. </member>
  2284. <member name="P:NAnt.Contrib.Tasks.SchemaValidatedTask.SchemaObject">
  2285. <summary>
  2286. Returns the object from the Schema wrapper after
  2287. <see cref="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)"/> is called.
  2288. </summary>
  2289. <value>The object from the Schema wrapper after <see cref="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)"/> is called.</value>
  2290. </member>
  2291. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiOutput">
  2292. <summary>
  2293. The name of the file that will be generated when the task completes
  2294. execution (eg. MyInstall.msi or MyMergeModule.msm).
  2295. </summary>
  2296. </member>
  2297. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiSourceDir">
  2298. <summary>
  2299. A directory relative to the NAnt script in which the msi task resides
  2300. from which to retrieve files that will be installed by the msi
  2301. database. All files that will be included in your installation need
  2302. to be located directly within or in subdirectories of this directory.
  2303. </summary>
  2304. </member>
  2305. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiTemplate">
  2306. <summary>
  2307. A installer file to use as the starting database in which all files
  2308. and entries will be made, and then copied to the filename specified
  2309. by the output parameter. Install templates are included with the
  2310. install tasks, you only need to supply this value if you want to
  2311. override the default template.
  2312. </summary>
  2313. </member>
  2314. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiErrorTemplate">
  2315. <summary>
  2316. A .mst file to use as the starting database containing strings
  2317. displayed to the user when errors occur during installation.
  2318. A .mst template is included with the msi task, you only need to
  2319. supply this value if you want to override the default error
  2320. template and cannot perform something through the features of the
  2321. msi task.
  2322. </summary>
  2323. </member>
  2324. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiDebug">
  2325. <summary>
  2326. Causes the generated msi database file to contain debug messages for
  2327. errors created by inconsistencies in creation of the database. This
  2328. makes the file slightly larger and should be avoided when generating
  2329. a production release of your software.
  2330. </summary>
  2331. </member>
  2332. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSummaryInformationElement">
  2333. <summary>
  2334. <para>
  2335. Sets various properties in the SummaryInformation stream
  2336. (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_information_stream.asp)
  2337. </para>
  2338. <para>
  2339. All of the sub-elements are optional.
  2340. </para>
  2341. <h3>Nested Elements:</h3>
  2342. <h4>&lt;title&gt;</h4>
  2343. <ul>
  2344. Briefly describes the type of installer package. Phrases such as "Installation Database" or
  2345. "Transform" or "Patch" may be used for this property.
  2346. <br />Default value: Value of the <c>ProductName</c> property, if defined.
  2347. </ul>
  2348. <h4>&lt;/title&gt;</h4>
  2349. <h4>&lt;subject&gt;</h4>
  2350. <ul>
  2351. A short description of the product to be installed. This value is typically set from the installer
  2352. property <c>ProductName</c>
  2353. <br />Default value: Value of the <c>ProductName</c> property, if defined.
  2354. </ul>
  2355. <h4>&lt;/subject&gt;</h4>
  2356. <h4>&lt;author&gt;</h4>
  2357. <ul>
  2358. The manufacturer of the installation database. This value is typically set from the installer
  2359. property <c>Manufacturer</c>.
  2360. <br />Default value: Value of the <c>Manufacturer</c> property, if defined.
  2361. </ul>
  2362. <h4>&lt;/author&gt;</h4>
  2363. <h4>&lt;keywords&gt;</h4>
  2364. <ul>
  2365. Used by file browsers to hold keywords that permit the database file to be found in a keyword search.
  2366. The set of keywords typically includes "Installer" as well as product-specific keywords, and may be
  2367. localized.
  2368. <br />Default value: Value of the <c>Keywords</c> property, if defined.
  2369. </ul>
  2370. <h4>&lt;/keywords&gt;</h4>
  2371. <h4>&lt;comments&gt;</h4>
  2372. <ul>
  2373. A general description/purpose of the installer database.
  2374. <br />Default value: Value of the <c>Comments</c> property, if defined.
  2375. </ul>
  2376. <h4>&lt;/comments&gt;</h4>
  2377. <h4>&lt;template&gt;</h4>
  2378. <ul>
  2379. <para>
  2380. Indicates the platform and language versions that are supported by the database. The Template Summary
  2381. Property of a patch package is a semicolon-delimited list of the product codes that can accept the
  2382. patch.
  2383. </para>
  2384. <para>
  2385. See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/template_summary_property.asp for more information.
  2386. </para>
  2387. </ul>
  2388. <h4>&lt;/template&gt;</h4>
  2389. <h4>&lt;revisionnumber&gt;</h4>
  2390. <ul>
  2391. Contains the package code (GUID) for the installer package. The package code is a unique identifier
  2392. of the installer package. Note: Default behavior - a new GUID is generated every time
  2393. </ul>
  2394. <h4>&lt;/revisionnumber&gt;</h4>
  2395. <h4>&lt;creatingapplication&gt;</h4>
  2396. <ul>
  2397. The name of the application used to author the database. Note: Default value is NAnt.
  2398. </ul>
  2399. <h4>&lt;/creatingapplication&gt;</h4>
  2400. <h3>Examples</h3>
  2401. <example>
  2402. <para>Define specific summary information.</para>
  2403. <code>
  2404. &lt;summaryinformation&gt;
  2405. &lt;title&gt;Installation Database&lt;/title&gt;
  2406. &lt;subject&gt;${install.productname}&lt;/subject&gt;
  2407. &lt;author&gt;${install.manufacturer}&lt;/author&gt;
  2408. &lt;keywords&gt;MSI, database, NAnt, Installer&lt;/keywords&gt;
  2409. &lt;comments&gt;This installer database contains the logic and data required to install NAnt&lt;/comments&gt;
  2410. &lt;template&gt;;1033&lt;/template&gt;
  2411. &lt;creatingapplication&gt;NAnt - http://nant.sf.net &lt;/creatingapplication&gt;
  2412. &lt;/summaryinformation&gt;
  2413. </code>
  2414. </example>
  2415. </summary>
  2416. </member>
  2417. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerPropertiesElement">
  2418. <summary>
  2419. <para>
  2420. Name/value pairs which will be set in the PROPERTY table of the
  2421. installer database.
  2422. </para>
  2423. <para>
  2424. The properties element contains within it one to any number of property elements.<br/>
  2425. <see href="http://msdn.microsoft.com/library/en-us/msi/setup/protected_properties.asp">Public property</see> names cannot contain lowercase letters.<br/>
  2426. <see href="http://msdn.microsoft.com/library/en-us/msi/setup/protected_properties.asp">Private property</see> names must contain some lowercase letters.<br/>
  2427. Property names prefixed with % represent system and user environment variables. These are
  2428. never entered into the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/property_table.asp">Property
  2429. table</see>. The permanent settings of environment variables can only be modified using the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">Environment Table</see>.
  2430. More information is available <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/properties.asp">here</see>.
  2431. </para>
  2432. <h3>Parameters</h3>
  2433. <list type="table">
  2434. <listheader>
  2435. <term>Attribute</term>
  2436. <term>Type</term>
  2437. <term>Description</term>
  2438. <term>Required</term>
  2439. </listheader>
  2440. <item>
  2441. <term>name</term>
  2442. <term>string</term>
  2443. <term>A name used to refer to the property.</term>
  2444. <term>True</term>
  2445. </item>
  2446. <item>
  2447. <term>value</term>
  2448. <term>string</term>
  2449. <term>The value of the property. This value can contain references to other, predefined properties to build a compound property.</term>
  2450. <term>True</term>
  2451. </item>
  2452. </list>
  2453. <h3>Examples</h3>
  2454. <example>
  2455. <para>Define the required properties.</para>
  2456. <code>
  2457. &lt;properties&gt;
  2458. &lt;property name="ProductName" value="My Product" /&gt;
  2459. &lt;property name="ProductVersion" value="1.0.0" /&gt;
  2460. &lt;property name="Manufacturer" value="ACME Inc." /&gt;
  2461. &lt;property name="ProductCode" value="{29D8F096-3371-4cba-87E1-A8C6511F7B4C}" /&gt;
  2462. &lt;property name="UpgradeCode" value="{69E66919-0DE1-4280-B4C1-94049F76BA1A}" /&gt;
  2463. &lt;/properties&gt;
  2464. </code>
  2465. </example>
  2466. </summary>
  2467. </member>
  2468. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSearchElement">
  2469. <summary>
  2470. <para>
  2471. Contains within it one to any number of app, registry, ini, or dirfile elements.
  2472. These elements are used to search for an existing filesystem directory, file, or
  2473. Windows Registry setting. A property in the installer database is
  2474. then set with the value obtained from the search.
  2475. </para>
  2476. <h3>&lt;app&gt;</h3>
  2477. <para>
  2478. More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/complocator_table.asp
  2479. </para>
  2480. <list type="table">
  2481. <listheader>
  2482. <term>Attribute</term>
  2483. <term>Type</term>
  2484. <term>Description</term>
  2485. <term>Required</term>
  2486. </listheader>
  2487. <item>
  2488. <term>componentid</term>
  2489. <term>string</term>
  2490. <term>The component ID of the component whose key path is to be used for the search.</term>
  2491. <term>True</term>
  2492. </item>
  2493. <item>
  2494. <term>type</term>
  2495. <term>msi:MSILocatorTypeDirFile</term>
  2496. <term>Valid input: <c>file</c> or <c>directory</c></term>
  2497. <term>True</term>
  2498. </item>
  2499. <item>
  2500. <term>setproperty</term>
  2501. <term>string</term>
  2502. <term>A name used to refer to the property within the Msi database. Set at install time.</term>
  2503. <term>True</term>
  2504. </item>
  2505. </list>
  2506. <h3>&lt;/app&gt;</h3>
  2507. <h3>&lt;registry&gt;</h3>
  2508. <para>
  2509. More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/reglocator_table.asp
  2510. </para>
  2511. <list type="table">
  2512. <listheader>
  2513. <term>Attribute</term>
  2514. <term>Type</term>
  2515. <term>Description</term>
  2516. <term>Required</term>
  2517. </listheader>
  2518. <item>
  2519. <term>type</term>
  2520. <term>msi:MSILocatorTypeDirFileReg64</term>
  2521. <term>Valid input: <c>registry</c>, <c>file</c>, <c>directory</c>, <c>64bit</c></term>
  2522. <term>True</term>
  2523. </item>
  2524. <item>
  2525. <term>path</term>
  2526. <term>string</term>
  2527. <term>Depending on the <c>type</c> specified:
  2528. <list type="bullet">
  2529. <item>Path is a directory.</item>
  2530. <item>Path is a registry key.</item>
  2531. </list>
  2532. </term>
  2533. <term>True</term>
  2534. </item>
  2535. <item>
  2536. <term>root</term>
  2537. <term>msi:MSIRegistryKeyRoot</term>
  2538. <term>Valid input:
  2539. <list type="bullet">
  2540. <item><c>dependent</c> - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1.</item>
  2541. <item><c>machine</c> represents HKEY_LOCAL_MACHINE</item>
  2542. <item><c>classes</c> represents HKEY_CLASSES_ROOT</item>
  2543. <item><c>user</c> represents HKEY_CURRENT_USER</item>
  2544. <item><c>users</c> represents HKEY_USERS</item>
  2545. </list>
  2546. </term>
  2547. <term>True</term>
  2548. </item>
  2549. </list>
  2550. <ul>
  2551. <h3>Nested Elements:</h3>
  2552. <h4>&lt;value&gt;</h4>
  2553. <h3>Parameters</h3>
  2554. <list type="table">
  2555. <listheader>
  2556. <term>Attribute</term>
  2557. <term>Type</term>
  2558. <term>Description</term>
  2559. <term>Required</term>
  2560. </listheader>
  2561. <item>
  2562. <term>name</term>
  2563. <term>string</term>
  2564. <term>Depending on the <c>type</c> specified:
  2565. <list type="bullet">
  2566. <item>Key path is a file name.</item>
  2567. <item>Key path is a registry value.</item>
  2568. </list>
  2569. </term>
  2570. <term>False</term>
  2571. </item>
  2572. <item>
  2573. <term>setproperty</term>
  2574. <term>string</term>
  2575. <term>A name used to refer to the property within the Msi database. Set at install time.</term>
  2576. <term>True</term>
  2577. </item>
  2578. </list>
  2579. <h4>&lt;/value&gt;</h4>
  2580. </ul>
  2581. <h3>&lt;/registry&gt;</h3>
  2582. <h3>&lt;ini&gt;</h3>
  2583. <para>
  2584. More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/inilocator_table.asp
  2585. </para>
  2586. <list type="table">
  2587. <listheader>
  2588. <term>Attribute</term>
  2589. <term>Type</term>
  2590. <term>Description</term>
  2591. <term>Required</term>
  2592. </listheader>
  2593. <item>
  2594. <term>filename</term>
  2595. <term>string</term>
  2596. <term>The .ini file name. (The .ini file must be present in the default Microsoft Windows directory.)
  2597. </term>
  2598. <term>True</term>
  2599. </item>
  2600. <item>
  2601. <term>section</term>
  2602. <term>string</term>
  2603. <term>Section name within the .ini file.
  2604. </term>
  2605. <term>True</term>
  2606. </item>
  2607. <item>
  2608. <term>key</term>
  2609. <term>string</term>
  2610. <term>Key value within the section.
  2611. </term>
  2612. <term>True</term>
  2613. </item>
  2614. <item>
  2615. <term>field</term>
  2616. <term>msi:nonNegativeInt</term>
  2617. <term>The field in the .ini line. If Field is Null or 0, then the entire line is read.
  2618. This must be a non-negative number.
  2619. </term>
  2620. <term>False</term>
  2621. </item>
  2622. <item>
  2623. <term>type</term>
  2624. <term>msi:MSILocatorTypeDirFileRaw</term>
  2625. <term>Valid input: <c>file</c> ,<c>directory</c>, or <c>raw</c></term>
  2626. <term>True</term>
  2627. </item>
  2628. <item>
  2629. <term>setproperty</term>
  2630. <term>string</term>
  2631. <term>A name used to refer to the property within the Msi database. Set at install time.</term>
  2632. <term>True</term>
  2633. </item>
  2634. </list>
  2635. <h3>&lt;/ini&gt;</h3>
  2636. <h3>&lt;dirfile&gt;</h3>
  2637. <para>
  2638. More information on these attributes can be found at:
  2639. http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/drlocator_table.asp
  2640. and
  2641. http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/signature_table.asp
  2642. </para>
  2643. <list type="table">
  2644. <listheader>
  2645. <term>Attribute</term>
  2646. <term>Type</term>
  2647. <term>Description</term>
  2648. <term>Required</term>
  2649. </listheader>
  2650. <item>
  2651. <term>parent</term>
  2652. <term>string</term>
  2653. <term>An identifier to RegLocator, IniLocator, or CompLocator tables.
  2654. If it does not expand to a full path, then all the fixed drives of the user's system are searched by using the Path.
  2655. <br/>In order to determine what the key is for a table, prefix the property name assigned
  2656. to that locator with SIG_
  2657. </term>
  2658. <term>False</term>
  2659. </item>
  2660. <item>
  2661. <term>path</term>
  2662. <term>string</term>
  2663. <term>the path on the user's system. This is a either a full path or a relative subpath
  2664. below the directory specified in the Parent column.
  2665. </term>
  2666. <term>False</term>
  2667. </item>
  2668. <item>
  2669. <term>depth</term>
  2670. <term>msi:nonNegativeInt</term>
  2671. <term>The depth below the path that the installer searches for the file or directory.
  2672. </term>
  2673. <term>False</term>
  2674. </item>
  2675. <item>
  2676. <term>setproperty</term>
  2677. <term>string</term>
  2678. <term>A name used to refer to the property within the Msi database. Set at install time.</term>
  2679. <term>True</term>
  2680. </item>
  2681. </list>
  2682. <ul>
  2683. <h3>Nested Elements:</h3>
  2684. <h4>&lt;file&gt;</h4>
  2685. <h3>Parameters</h3>
  2686. <list type="table">
  2687. <listheader>
  2688. <term>Attribute</term>
  2689. <term>Type</term>
  2690. <term>Description</term>
  2691. <term>Required</term>
  2692. </listheader>
  2693. <item>
  2694. <term>name</term>
  2695. <term>string</term>
  2696. <term>The name of the file.</term>
  2697. <term>True</term>
  2698. </item>
  2699. <item>
  2700. <term>minversion</term>
  2701. <term>string</term>
  2702. <term>The minimum version of the file, with a language comparison. If this field is
  2703. specified, then the file must have a version that is at least equal to MinVersion.
  2704. If the file has an equal version to the MinVersion field value but the language
  2705. specified in the Languages column differs, the file does not satisfy the signature
  2706. filter criteria.</term>
  2707. <term>False</term>
  2708. </item>
  2709. <item>
  2710. <term>maxversion</term>
  2711. <term>string</term>
  2712. <term>The maximum version of the file. If this field is specified, then the file
  2713. must have a version that is at most equal to MaxVersion.</term>
  2714. <term>False</term>
  2715. </item>
  2716. <item>
  2717. <term>minsize</term>
  2718. <term>msi:nonNegativeInt</term>
  2719. <term>The minimum size of the file. If this field is specified, then the file
  2720. under inspection must have a size that is at least equal to MinSize. This must
  2721. be a non-negative number.</term>
  2722. <term>False</term>
  2723. </item>
  2724. <item>
  2725. <term>maxsize</term>
  2726. <term>msi:nonNegativeInt</term>
  2727. <term>The maximum size of the file. If this field is specified, then the file
  2728. under inspection must have a size that is at most equal to MaxSize. This must
  2729. be a non-negative number.</term>
  2730. <term>False</term>
  2731. </item>
  2732. <item>
  2733. <term>mindate</term>
  2734. <term>msi:nonNegativeInt</term>
  2735. <term>The minimum modification date and time of the file. If this field is
  2736. specified, then the file under inspection must have a modification date and time
  2737. that is at least equal to MinDate. This must be a non-negative number.</term>
  2738. <term>False</term>
  2739. </item>
  2740. <item>
  2741. <term>maxdate</term>
  2742. <term>msi:nonNegativeInt</term>
  2743. <term>The maximum creation date of the file. If this field is specified, then the
  2744. file under inspection must have a creation date that is at most equal to MaxDate.
  2745. This must be a non-negative number.</term>
  2746. <term>False</term>
  2747. </item>
  2748. <item>
  2749. <term>languages</term>
  2750. <term>string</term>
  2751. <term>The languages supported by the file.</term>
  2752. <term>False</term>
  2753. </item>
  2754. </list>
  2755. <h4>&lt;/file&gt;</h4>
  2756. </ul>
  2757. <h3>&lt;/dirfile&gt;</h3>
  2758. <h3>Examples</h3>
  2759. <example>
  2760. <para>Get the path of the web directory and the version of IIS. Create new properties in the Msi file with those values.</para>
  2761. <code>
  2762. &lt;search&gt;
  2763. &lt;registry type="registry" path="Software\Microsoft\InetStp" root="machine" &gt;
  2764. &lt;value name="PathWWWRoot" setproperty="IISWWWROOT" /&gt;
  2765. &lt;/registry&gt;
  2766. &lt;registry type="registry" path="SYSTEM\CurrentControlSet\Services\W3SVC\Parameters" root="machine" &gt;
  2767. &lt;value name="MajorVersion" setproperty="IISVERSION" /&gt;
  2768. &lt;/registry&gt;
  2769. &lt;/search&gt;
  2770. </code>
  2771. </example>
  2772. <example>
  2773. <para>Shows two ways to get the default key value for the specified key. Create new properties in the Msi file with those values.</para>
  2774. <code>
  2775. &lt;search&gt;
  2776. &lt;registry type="registry" path="Software\Microsoft\MessengerService" root="machine" &gt;
  2777. &lt;value setproperty="MSGSRVNAME" /&gt;
  2778. &lt;value name="" setproperty="MSGSRVNAME2" /&gt;
  2779. &lt;/registry&gt;
  2780. &lt;/search&gt;
  2781. </code>
  2782. </example>
  2783. </summary>
  2784. </member>
  2785. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerLaunchConditionsElement">
  2786. <summary>
  2787. <para>
  2788. Contains within it one to any number of launchcondition elements.
  2789. Launch conditions are conditions that all must be satisfied for the
  2790. installation to begin.
  2791. </para>
  2792. <h3>Parameters</h3>
  2793. <list type="table">
  2794. <listheader>
  2795. <term>Attribute</term>
  2796. <term>Type</term>
  2797. <term>Description</term>
  2798. <term>Required</term>
  2799. </listheader>
  2800. <item>
  2801. <term>name</term>
  2802. <term>string</term>
  2803. <term>A name used to identify the launch condition.</term>
  2804. <term>True</term>
  2805. </item>
  2806. <item>
  2807. <term>condition</term>
  2808. <term>string</term>
  2809. <term>Expression that must evaluate to True for installation to begin.</term>
  2810. <term>True</term>
  2811. </item>
  2812. </list>
  2813. <h3>Nested Elements:</h3>
  2814. <h4>&lt;description&gt;</h4>
  2815. <ul>
  2816. Localizable text to display when the condition fails and the installation must be terminated.
  2817. </ul>
  2818. <h4>&lt;/description&gt;</h4>
  2819. <h3>Examples</h3>
  2820. <example>
  2821. <para>Create a check to make sure that IIS 5.x is installed.</para>
  2822. <code>
  2823. &lt;launchconditions&gt;
  2824. &lt;launchcondition name="CheckIIS" condition="(IISVERSION = &amp;quot;#5&amp;quot;)" &gt;
  2825. &lt;description&gt;
  2826. This setup requires Internet information Server 5.x. Please install Internet Information Server and run this setup again.
  2827. &lt;/description&gt;
  2828. &lt;/launchcondition&gt;
  2829. &lt;/launchconditions&gt;
  2830. </code>
  2831. </example>
  2832. </summary>
  2833. </member>
  2834. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerTablesElement">
  2835. <summary>
  2836. <para>
  2837. Creates custom tables not directly managed by default features of
  2838. the installer task.
  2839. </para>
  2840. <h3>Parameters</h3>
  2841. <list type="table">
  2842. <listheader>
  2843. <term>Attribute</term>
  2844. <term>Type</term>
  2845. <term>Description</term>
  2846. <term>Required</term>
  2847. </listheader>
  2848. <item>
  2849. <term>name</term>
  2850. <term>string</term>
  2851. <term>A unique name used to identify the table.</term>
  2852. <term>True</term>
  2853. </item>
  2854. </list>
  2855. <h3>Nested Elements:</h3>
  2856. <h4>&lt;columns&gt;</h4>
  2857. <ul>
  2858. <h4>&lt;column&gt;</h4>
  2859. <ul>
  2860. Defines the columns making up the table
  2861. <h3>Parameters</h3>
  2862. <list type="table">
  2863. <listheader>
  2864. <term>Attribute</term>
  2865. <term>Type</term>
  2866. <term>Description</term>
  2867. <term>Required</term>
  2868. </listheader>
  2869. <item>
  2870. <term>name</term>
  2871. <term>string</term>
  2872. <term>A unique name used to define the column.</term>
  2873. <term>True</term>
  2874. </item>
  2875. <item>
  2876. <term>nullable</term>
  2877. <term>bool</term>
  2878. <term>When set to <c>true</c>, allows the column to accept null values; <c>false</c> does not allow null values.</term>
  2879. <term>True</term>
  2880. </item>
  2881. <item>
  2882. <term>category</term>
  2883. <term>msi:MSITableColumnCategoryType</term>
  2884. <term>Valid input:
  2885. <list type="bullet">
  2886. <item><c>Text</c></item>
  2887. <item><c>UpperCase</c></item>
  2888. <item><c>LowerCase</c></item>
  2889. <item><c>Integer</c></item>
  2890. <item><c>DoubleInteger</c></item>
  2891. <item><c>Time/Date</c></item>
  2892. <item><c>Identifier</c></item>
  2893. <item><c>Property</c></item>
  2894. <item><c>Filename</c></item>
  2895. <item><c>WildCardFilename</c></item>
  2896. <item><c>Path</c></item>
  2897. <item><c>Paths</c></item>
  2898. <item><c>AnyPath</c></item>
  2899. <item><c>DefaultDir</c></item>
  2900. <item><c>RegPath</c></item>
  2901. <item><c>Formatted</c></item>
  2902. <item><c>Template</c></item>
  2903. <item><c>Condition</c></item>
  2904. <item><c>GUID</c></item>
  2905. <item><c>Version</c></item>
  2906. <item><c>Language</c></item>
  2907. <item><c>Binary</c></item>
  2908. <item><c>Cabinet</c></item>
  2909. <item><c>Shortcut</c></item>
  2910. </list>
  2911. More information here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp">http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp</a>
  2912. </term>
  2913. <term>False</term>
  2914. </item>
  2915. <item>
  2916. <term>type</term>
  2917. <term>string</term>
  2918. <term>Overrides the <c>category</c> specification. An example of valid input would be: <c>S255</c></term>
  2919. <term>False</term>
  2920. </item>
  2921. <item>
  2922. <term>key</term>
  2923. <term>bool</term>
  2924. <term>When set to <c>true</c>, the column is used to form the primary key for the table; <c>false</c> specifies that the column is not used to form the primary key.</term>
  2925. <term>False</term>
  2926. </item>
  2927. <item>
  2928. <term>minvalue</term>
  2929. <term>int</term>
  2930. <term>This field applies to columns having numeric value. The field contains the minimum permissible value. This can be the minimum value for an integer or the minimum value for a date or version string.</term>
  2931. <term>False</term>
  2932. </item>
  2933. <item>
  2934. <term>maxvalue</term>
  2935. <term>int</term>
  2936. <term>This field applies to columns having numeric value. The field is the maximum permissible value. This may be the maximum value for an integer or the maximum value for a date or version string. </term>
  2937. <term>False</term>
  2938. </item>
  2939. <item>
  2940. <term>keytable</term>
  2941. <term>string</term>
  2942. <term>This field applies to columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. This can be a list of tables separated by semicolons.</term>
  2943. <term>False</term>
  2944. </item>
  2945. <item>
  2946. <term>keycolumn</term>
  2947. <term>int</term>
  2948. <term>This field applies to table columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. The permissible range of the KeyColumn field is 1-32.</term>
  2949. <term>False</term>
  2950. </item>
  2951. <item>
  2952. <term>set</term>
  2953. <term>string</term>
  2954. <term>This is a list of permissible values for this field separated by semicolons. This field is usually used for enums.</term>
  2955. <term>False</term>
  2956. </item>
  2957. <item>
  2958. <term>description</term>
  2959. <term>string</term>
  2960. <term>A description of the data that is stored in the column. </term>
  2961. <term>False</term>
  2962. </item>
  2963. </list>
  2964. </ul>
  2965. <h4>&lt;/column&gt;</h4>
  2966. </ul>
  2967. <h4>&lt;/columns&gt;</h4>
  2968. <h4>&lt;rows&gt;</h4>
  2969. <ul>
  2970. <h4>&lt;row&gt;</h4>
  2971. <ul>
  2972. Defines the data for a row in the table
  2973. <h4>&lt;columns&gt;</h4>
  2974. <ul>
  2975. <h4>&lt;column&gt;</h4>
  2976. <ul>
  2977. Defines data for a specific cell in the row
  2978. <h3>Parameters</h3>
  2979. <list type="table">
  2980. <listheader>
  2981. <term>Attribute</term>
  2982. <term>Type</term>
  2983. <term>Description</term>
  2984. <term>Required</term>
  2985. </listheader>
  2986. <item>
  2987. <term>name</term>
  2988. <term>string</term>
  2989. <term>Name of the column to populate.</term>
  2990. <term>True</term>
  2991. </item>
  2992. <item>
  2993. <term>value</term>
  2994. <term>string</term>
  2995. <term>Value to populate the cell with.</term>
  2996. <term>True</term>
  2997. </item>
  2998. </list>
  2999. </ul>
  3000. <h4>&lt;/column&gt;</h4>
  3001. </ul>
  3002. <h4>&lt;/columns&gt;</h4>
  3003. </ul>
  3004. <h4>&lt;/row&gt;</h4>
  3005. </ul>
  3006. <h4>&lt;/rows&gt;</h4>
  3007. <h3>Examples</h3>
  3008. <example>
  3009. <para>
  3010. Build the IniFile table. Since the WriteIniValues and RemoveIniValues actions exist in the template, they will use this table.
  3011. </para>
  3012. <code>
  3013. &lt;tables&gt;
  3014. &lt;table name="IniFile"&gt;
  3015. &lt;columns&gt;
  3016. &lt;column name="IniFile" nullable="false" category="Identifier" key="true" description="The key for this table." /&gt;
  3017. &lt;column name="FileName" nullable="false" category="Text" description="The localizable name of the .ini file in which to write the information. " /&gt;
  3018. &lt;column name="DirProperty" nullable="true" category="Identifier" description="Name of a property having a value that resolves to the full path of the folder containing the .ini file. " /&gt;
  3019. &lt;column name="Section" nullable="false" category="Formatted" description="The localizable .ini file section." /&gt;
  3020. &lt;column name="Key" nullable="false" category="Formatted" description="The localizable .ini file key within the section" /&gt;
  3021. &lt;column name="Value" nullable="false" category="Formatted" description="The localizable value to be written. " /&gt;
  3022. &lt;column name="Action" nullable="false" category="Integer" description="The type of modification to be made. " /&gt;
  3023. &lt;column name="Component_" nullable="false" category="Identifier" description="External key into the first column of the Component table referencing the component that controls the installation of the .ini value. " /&gt;
  3024. &lt;/columns&gt;
  3025. &lt;rows&gt;
  3026. &lt;row&gt;
  3027. &lt;columns&gt;
  3028. &lt;column name="IniFile" value="MyInternetShortcut" /&gt;
  3029. &lt;column name="FileName" value="MyInternetAddr.url" /&gt;
  3030. &lt;column name="DirProperty" value="D__MYDIR" /&gt;
  3031. &lt;column name="Section" value="InternetShortcut" /&gt;
  3032. &lt;column name="Key" value="URL" /&gt;
  3033. &lt;column name="Value" value="[TARGETURL]" /&gt;
  3034. &lt;column name="Action" value="0" /&gt;
  3035. &lt;column name="Component_" value="C__Documentation" /&gt;
  3036. &lt;/columns&gt;
  3037. &lt;/row&gt;
  3038. &lt;/rows&gt;
  3039. &lt;/table&gt;
  3040. &lt;/tables&gt;
  3041. </code>
  3042. </example>
  3043. </summary>
  3044. </member>
  3045. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerDirectoriesElement">
  3046. <summary>
  3047. <para>
  3048. Specifies the directory layout for the product.
  3049. </para>
  3050. <h3>Parameters</h3>
  3051. <list type="table">
  3052. <listheader>
  3053. <term>Attribute</term>
  3054. <term>Type</term>
  3055. <term>Description</term>
  3056. <term>Required</term>
  3057. </listheader>
  3058. <item>
  3059. <term>name</term>
  3060. <term>string</term>
  3061. <term>A name used to refer to the directory.</term>
  3062. <term>True</term>
  3063. </item>
  3064. <item>
  3065. <term>foldername</term>
  3066. <term>string</term>
  3067. <term>The directory's name (localizable)under the parent directory.</term>
  3068. <term>True</term>
  3069. </item>
  3070. <item>
  3071. <term>root</term>
  3072. <term>string</term>
  3073. <term>A reference to the directory's parent directory. This can be a property name or one of the predefined directories included with the default template:
  3074. <list type="bullet">
  3075. <item><c>AdminToolsFolder</c></item>
  3076. <item><c>AppDataFolder</c></item>
  3077. <item><c>CommonAppDataFolder</c></item>
  3078. <item><c>CommonFiles64Folder</c></item>
  3079. <item><c>CommonFilesFolder</c></item>
  3080. <item><c>DesktopFolder</c></item>
  3081. <item><c>FavoritesFolder</c></item>
  3082. <item><c>FontsFolder</c></item>
  3083. <item><c>LocalAppDataFolder</c></item>
  3084. <item><c>MyPicturesFolder</c></item>
  3085. <item><c>PersonalFolder</c></item>
  3086. <item><c>ProgramFilesFolder</c></item>
  3087. <item><c>ProgramMenuFolder</c></item>
  3088. <item><c>ProgramFiles64Folder</c></item>
  3089. <item><c>SendToFolder</c></item>
  3090. <item><c>StartMenuFolder</c></item>
  3091. <item><c>StartupFolder</c></item>
  3092. <item><c>System16Folder</c></item>
  3093. <item><c>System64Folder</c></item>
  3094. <item><c>SystemFolder</c></item>
  3095. <item><c>TARGETDIR</c></item>
  3096. <item><c>TempFolder</c></item>
  3097. <item><c>TemplateFolder</c></item>
  3098. <item><c>WindowsFolder</c></item>
  3099. <item><c>WindowsVolume</c></item>
  3100. </list>
  3101. </term>
  3102. <term>True</term>
  3103. </item>
  3104. </list>
  3105. <h3>Nested Elements:</h3>
  3106. <h4>&lt;directory&gt;</h4>
  3107. <ul>
  3108. Sub directories. Note, this element can contain nested &lt;directory/&gt; sub elements.
  3109. <h3>Parameters</h3>
  3110. <list type="table">
  3111. <listheader>
  3112. <term>Attribute</term>
  3113. <term>Type</term>
  3114. <term>Description</term>
  3115. <term>Required</term>
  3116. </listheader>
  3117. <item>
  3118. <term>name</term>
  3119. <term>string</term>
  3120. <term>A name used to refer to the directory.</term>
  3121. <term>True</term>
  3122. </item>
  3123. <item>
  3124. <term>foldername</term>
  3125. <term>string</term>
  3126. <term>The directory's name (localizable)under the parent directory.</term>
  3127. <term>True</term>
  3128. </item>
  3129. </list>
  3130. </ul>
  3131. <h4>&lt;/directory&gt;</h4>
  3132. <h3>Examples</h3>
  3133. <example>
  3134. <para>Define a sample directory structure.</para>
  3135. <code>
  3136. &lt;directories&gt;
  3137. &lt;directory name="D__ACME" foldername="ACME" root="TARGETDIR" &gt;
  3138. &lt;directory name="D__ACME_MyProduct" foldername="My Product" /&gt;
  3139. &lt;/directory&gt;
  3140. &lt;/directories&gt;
  3141. </code>
  3142. </example>
  3143. </summary>
  3144. </member>
  3145. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerEnvironmentElement">
  3146. <summary>
  3147. <para>
  3148. Used to modify the environment variables of the target computer at
  3149. runtime.
  3150. </para>
  3151. <h3>Parameters</h3>
  3152. <list type="table">
  3153. <listheader>
  3154. <term>Attribute</term>
  3155. <term>Type</term>
  3156. <term>Description</term>
  3157. <term>Required</term>
  3158. </listheader>
  3159. <item>
  3160. <term>name</term>
  3161. <term>string</term>
  3162. <term>The localizable name of the environment variable. The key values are written or removed depending upon
  3163. which of the characters in the following table are prefixed to the name. There is no effect in the ordering of
  3164. the symbols used in a prefix.
  3165. <list type="table">
  3166. <listheader>
  3167. <term>Prefix</term>
  3168. <description>Description</description>
  3169. </listheader>
  3170. <item>
  3171. <term>=</term>
  3172. <description>Create the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation.</description>
  3173. </item>
  3174. <item>
  3175. <term>+</term>
  3176. <description>Create the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists.</description>
  3177. </item>
  3178. <item>
  3179. <term>-</term>
  3180. <description>Remove the environment variable when the component is removed. This symbol can be combined with any prefix.</description>
  3181. </item>
  3182. <item>
  3183. <term>!</term>
  3184. <description>Remove the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty.</description>
  3185. </item>
  3186. <item>
  3187. <term>*</term>
  3188. <description>This prefix is used with Microsoft® Windows® NT/Windows® 2000 to indicate that the name refers to a system environment variable. If no asterisk is present, the installer writes the variable to the user's environment. Microsoft Windows 95/98 ignores the asterisk and add the environment variable to autoexec.bat. This symbol can be combined with any prefix. A package that is used for per-machine installations should write environment variables to the machine's environment by including * in the Name column. For more information, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp</a></description>
  3189. </item>
  3190. <item>
  3191. <term>=-</term>
  3192. <description>The environment variable is set on install and removed on uninstall. This is the usual behavior.</description>
  3193. </item>
  3194. <item>
  3195. <term>!-</term>
  3196. <description>Removes an environment variable during an install or uninstall.</description>
  3197. </item>
  3198. </list>
  3199. More information can be found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp</a>
  3200. </term>
  3201. <term>True</term>
  3202. </item>
  3203. <item>
  3204. <term>append</term>
  3205. <term>string</term>
  3206. <term>Localizable value that is to be set as a <a href="http://msdn.microsoft.com/library/en-us/msi/setup/formatted.asp">formatted</a> string</term>
  3207. <term>True</term>
  3208. </item>
  3209. <item>
  3210. <term>component</term>
  3211. <term>string</term>
  3212. <term>Refrence to a component. Allows the variabled to be modified when the component is un/installed.</term>
  3213. <term>True</term>
  3214. </item>
  3215. </list>
  3216. <h3>Examples</h3>
  3217. <example>
  3218. <para>Append the installation path to the user PATH variable.</para>
  3219. <code>
  3220. &lt;environment&gt;
  3221. &lt;variable name="PATH" append="'[TARGETDIR]'" component="C__MainFiles" /&gt;
  3222. &lt;/environment&gt;
  3223. </code>
  3224. </example>
  3225. </summary>
  3226. </member>
  3227. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerComponentsElement">
  3228. <summary>
  3229. <para>
  3230. Groups sets of files into named sets, these can be used to install
  3231. and perform operations on a set of files as one entity.
  3232. </para>
  3233. <h3>Parameters</h3>
  3234. <list type="table">
  3235. <listheader>
  3236. <term>Attribute</term>
  3237. <term>Type</term>
  3238. <term>Description</term>
  3239. <term>Required</term>
  3240. </listheader>
  3241. <item>
  3242. <term>name</term>
  3243. <term>string</term>
  3244. <term>A name used to refer to the component.</term>
  3245. <term>True</term>
  3246. </item>
  3247. <item>
  3248. <term>id</term>
  3249. <term>string</term>
  3250. <term>A string GUID unique to this component, version, and language.<br/>Note that the letters of these GUIDs must be
  3251. uppercase. Utilities such as GUIDGEN can generate GUIDs containing lowercase letters. The lowercase letters must be
  3252. changed to uppercase to make these valid component code GUIDs.
  3253. </term>
  3254. <term>True</term>
  3255. </item>
  3256. <item>
  3257. <term>attr</term>
  3258. <term>int</term>
  3259. <term>This column contains a bit flag that specifies options for remote execution. Add the indicated bit to the total value in the column to include an option.
  3260. <list type="table">
  3261. <listheader>
  3262. <term>Value</term>
  3263. <description>Description</description>
  3264. </listheader>
  3265. <item>
  3266. <term>0</term>
  3267. <description>Component cannot be run from source. <br/>
  3268. Set this bit for all components belonging to a feature to prevent the feature from being run-from-network or
  3269. run-from-source. Note that if a feature has no components, the feature always shows run-from-source and
  3270. run-from-my-computer as valid options.
  3271. </description>
  3272. </item>
  3273. <item>
  3274. <term>1</term>
  3275. <description>Component can only be run from source. <br/>
  3276. Set this bit for all components belonging to a feature to prevent the feature from being run-from-my-computer.
  3277. Note that if a feature has no components, the feature always shows run-from-source and run-from-my-computer as
  3278. valid options.
  3279. </description>
  3280. </item>
  3281. <item>
  3282. <term>2</term>
  3283. <description>Component can run locally or from source.</description>
  3284. </item>
  3285. <item>
  3286. <term>4</term>
  3287. <description>If this bit is set, the value in the key element is used as a key into the Registry table.<br/>
  3288. If the Value field of the corresponding record in the Registry table is null, the Name field in that record must
  3289. not contain "+", "-", or "*". For more information, see the description of the Name field in Registry table.<br/>
  3290. Setting this bit is recommended for registry entries written to the HKCU hive. This ensures the installer writes
  3291. the necessary HKCU registry entries when there are multiple users on the same machine.
  3292. </description>
  3293. </item>
  3294. <item>
  3295. <term>16</term>
  3296. <description>If this bit is set, the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings.
  3297. </description>
  3298. </item>
  3299. <item>
  3300. <term>32</term>
  3301. <description>If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table.</description>
  3302. </item>
  3303. <item>
  3304. <term>64</term>
  3305. <description>If this bit is set, the installer reevaluates the value of the statement in the Condition column
  3306. upon a reinstall. If the value was previously False and has changed to True, the installer installs the component.
  3307. If the value was previously True and has changed to False, the installer removes the component even if the component
  3308. has other products as clients. <br/>This bit should only be set for transitive components. See Using Transitive
  3309. Components.
  3310. </description>
  3311. </item>
  3312. <item>
  3313. <term>128</term>
  3314. <description>If this bit is set, the installer does not install or reinstall the component if a key path file or
  3315. a key path registry entry for the component already exists. The application does register itself as a client of
  3316. the component. <br/>
  3317. Use this flag only for components that are being registered by the Registry table.
  3318. </description>
  3319. </item>
  3320. <item>
  3321. <term>256</term>
  3322. <description>Set this bit to mark this as a 64-bit component. This attribute facilitates the installation of
  3323. packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered
  3324. as a 32-bit component.
  3325. </description>
  3326. </item>
  3327. </list>
  3328. </term>
  3329. <term>True</term>
  3330. </item>
  3331. <item>
  3332. <term>directory</term>
  3333. <term>string</term>
  3334. <term>Refrence to a directory. Defines the directory location for where the files assigned to the component are to be placed.</term>
  3335. <term>True</term>
  3336. </item>
  3337. <item>
  3338. <term>feature</term>
  3339. <term>string</term>
  3340. <term>Refrence to a feature. Maps a feature to the component. Used to determine if the component is to be installed or not.</term>
  3341. <term>True</term>
  3342. </item>
  3343. <item>
  3344. <term>condition</term>
  3345. <term>string</term>
  3346. <term>A conditional statement that can control whether a component is installed. If the condition is null or evaluates to
  3347. true, then the component is enabled. If the condition evaluates to False, then the component is disabled and is not
  3348. installed.</term>
  3349. <term>False</term>
  3350. </item>
  3351. <item>
  3352. <term>fileattr</term>
  3353. <term>int</term>
  3354. <term>Integer containing bit flags representing file attributes.<br/>
  3355. The following table shows the definition of the bit field.
  3356. <list type="table">
  3357. <listheader>
  3358. <term>Value</term>
  3359. <description>Description</description>
  3360. </listheader>
  3361. <item>
  3362. <term>1</term>
  3363. <description>Read-Only</description>
  3364. </item>
  3365. <item>
  3366. <term>2</term>
  3367. <description>Hidden</description>
  3368. </item>
  3369. <item>
  3370. <term>4</term>
  3371. <description>System</description>
  3372. </item>
  3373. <item>
  3374. <term>512</term>
  3375. <description>The file is vital for the proper operation of the component to which it belongs</description>
  3376. </item>
  3377. <item>
  3378. <term>1024</term>
  3379. <description>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</description>
  3380. </item>
  3381. <item>
  3382. <term>4096</term>
  3383. <description>This bit must only be added by a patch and if the file is being added by the patch.</description>
  3384. </item>
  3385. <item>
  3386. <term>8192</term>
  3387. <description>The file's source type is uncompressed. If set, ignore the Word Count Summary Property.
  3388. If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression
  3389. state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed
  3390. and msidbFileAttributesCompressed.</description>
  3391. </item>
  3392. <item>
  3393. <term>16384</term>
  3394. <description>The file's source type is compressed. If set, ignore the Word Count Summary Property.
  3395. If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of
  3396. the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and
  3397. msidbFileAttributesCompressed.</description>
  3398. </item>
  3399. </list>
  3400. </term>
  3401. <term>False</term>
  3402. </item>
  3403. <item>
  3404. <term>checkinterop</term>
  3405. <term>bool</term>
  3406. <term>Used to determine if file(s) in the fileset are interop file(s). If <c>true</c>, extra information will be added in the install
  3407. package to register each interop file. If <c>false</c>, the file(s) will not be not be checked and the extra registration information
  3408. will not be added to the msi. </term>
  3409. <term>False</term>
  3410. </item>
  3411. <item>
  3412. <term>installassembliestogac</term>
  3413. <term>bool</term>
  3414. <term>Used to determine if assemblies should be installed to the Global Assembly Cache.
  3415. If <c>true</c>, all assemblies in the fileset will be added to the GAC. If <c>false</c>, the assemblies will be installed
  3416. to the specified directory (as a normal file would). Note: If an assembly is specified to be installed into the GAC, it will not
  3417. also be installed to the directory specified.</term>
  3418. <term>False</term>
  3419. </item>
  3420. <item>
  3421. <term>keepsubdirs</term>
  3422. <term>bool</term>
  3423. <term>Used to determine if directories in the fileset should be built.
  3424. If <c>true</c>, all subdirectories of the fileset basedir will be built. If <c>false</c> the directories structure will be
  3425. flattened. The default is <c>false</c>.</term>
  3426. <term>False</term>
  3427. </item>
  3428. </list>
  3429. <h3>Nested Elements:</h3>
  3430. <h4>&lt;keyfile&gt;</h4>
  3431. <ul>
  3432. This value points to a file or folder belonging to the component that the installer uses to detect the component. Two components cannot share the same key path value.
  3433. <h3>Parameters</h3>
  3434. <list type="table">
  3435. <listheader>
  3436. <term>Attribute</term>
  3437. <term>Type</term>
  3438. <term>Description</term>
  3439. <term>Required</term>
  3440. </listheader>
  3441. <item>
  3442. <term>file</term>
  3443. <term>string</term>
  3444. <term>Name of the key (file) to use. Also, this could be an id of a registry key value.</term>
  3445. <term>True</term>
  3446. </item>
  3447. </list>
  3448. </ul>
  3449. <h4>&lt;/keyfile&gt;</h4>
  3450. <h4>&lt;fileset&gt;</h4>
  3451. <ul>
  3452. Specifies the files to include with the component
  3453. </ul>
  3454. <h4>&lt;/fileset&gt;</h4>
  3455. <h4>&lt;forceid&gt;</h4>
  3456. <ul>
  3457. Used to force specific attributes on a per file basis
  3458. <h3>Parameters</h3>
  3459. <list type="table">
  3460. <listheader>
  3461. <term>Attribute</term>
  3462. <term>Type</term>
  3463. <term>Description</term>
  3464. <term>Required</term>
  3465. </listheader>
  3466. <item>
  3467. <term>file</term>
  3468. <term>string</term>
  3469. <term>Name of the file, in the fileset, to override.</term>
  3470. <term>True</term>
  3471. </item>
  3472. <item>
  3473. <term>id</term>
  3474. <term>string</term>
  3475. <term>Unique GUID to assign to the file.</term>
  3476. <term>True</term>
  3477. </item>
  3478. <item>
  3479. <term>attr</term>
  3480. <term>int</term>
  3481. <term>Integer containing bit flags representing file attributes.<br/>
  3482. The following table shows the definition of the bit field.
  3483. <list type="table">
  3484. <listheader>
  3485. <term>Value</term>
  3486. <description>Description</description>
  3487. </listheader>
  3488. <item>
  3489. <term>1</term>
  3490. <description>Read-Only</description>
  3491. </item>
  3492. <item>
  3493. <term>2</term>
  3494. <description>Hidden</description>
  3495. </item>
  3496. <item>
  3497. <term>4</term>
  3498. <description>System</description>
  3499. </item>
  3500. <item>
  3501. <term>512</term>
  3502. <description>The file is vital for the proper operation of the component to which it belongs</description>
  3503. </item>
  3504. <item>
  3505. <term>1024</term>
  3506. <description>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</description>
  3507. </item>
  3508. <item>
  3509. <term>4096</term>
  3510. <description>This bit must only be added by a patch and if the file is being added by the patch.</description>
  3511. </item>
  3512. <item>
  3513. <term>8192</term>
  3514. <description>The file's source type is uncompressed. If set, ignore the Word Count Summary Property.
  3515. If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression
  3516. state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed
  3517. and msidbFileAttributesCompressed.</description>
  3518. </item>
  3519. <item>
  3520. <term>16384</term>
  3521. <description>The file's source type is compressed. If set, ignore the Word Count Summary Property.
  3522. If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of
  3523. the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and
  3524. msidbFileAttributesCompressed.</description>
  3525. </item>
  3526. </list>
  3527. </term>
  3528. <term>False</term>
  3529. </item>
  3530. <item>
  3531. <term>version</term>
  3532. <term>string</term>
  3533. <term>This field is the version string for a versioned file. This field is blank for non-versioned files.</term>
  3534. <term>False</term>
  3535. </item>
  3536. <item>
  3537. <term>language</term>
  3538. <term>string</term>
  3539. <term>A list of decimal language IDs separated by commas.</term>
  3540. <term>False</term>
  3541. </item>
  3542. <item>
  3543. <term>checkinterop</term>
  3544. <term>bool</term>
  3545. <term>Used to determine if file is an interop file. If <c>true</c>, extra information will be added in the install
  3546. package to register the interop file. If <c>false</c>, the file will not be not be checked and the extra registration information
  3547. will not be added to the msi.</term>
  3548. <term>False</term>
  3549. </item>
  3550. <item>
  3551. <term>installtogac</term>
  3552. <term>bool</term>
  3553. <term>If <c>true</c>, and if the file is an assembly, it will be installed to the GAC. If <c>false</c>, the file
  3554. will be installed to the directory specified by the component. Note: If an assembly is specified to
  3555. be installed into the GAC, it will not also be installed to the directory specified.</term>
  3556. <term>False</term>
  3557. </item>
  3558. </list>
  3559. </ul>
  3560. <h4>&lt;/forceid&gt;</h4>
  3561. <h3>Examples</h3>
  3562. <example>
  3563. <para>Define a sample component structure.</para>
  3564. <code>
  3565. &lt;components&gt;
  3566. &lt;component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" &gt;
  3567. &lt;key file="default.aspx" /&gt;
  3568. &lt;fileset basedir="${install.dir}"&gt;
  3569. &lt;include name="*.*" /&gt;
  3570. &lt;/fileset&gt;
  3571. &lt;/component&gt;
  3572. &lt;/components&gt;
  3573. </code>
  3574. </example>
  3575. <example>
  3576. <para>Install files to TARGETDIR and assemblies to the GAC (Global Assembly Cache). Do not install MyOtherAssembly.dll to the GAC, but rather install it with the other files (to TARGETDIR)</para>
  3577. <code>
  3578. &lt;components&gt;
  3579. &lt;component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" installassembliestogac="true" &gt;
  3580. &lt;key file="MyAssemblyName.xml" /&gt;
  3581. &lt;fileset basedir="${install.dir}"&gt;
  3582. &lt;include name="*.*" /&gt;
  3583. &lt;/fileset&gt;
  3584. &lt;forceid file="MyOtherAssembly.dll" id="_4EB7CCB23D394958988ED817DA00B9D1" installtogac="false" /&gt;
  3585. &lt;/component&gt;
  3586. &lt;/components&gt;
  3587. </code>
  3588. </example>
  3589. <example>
  3590. <para>Assign a registry entry to a specific component.</para>
  3591. <code>
  3592. &lt;components&gt;
  3593. &lt;component name="C__RegistryEntry" id="{06C654AA-273D-4E39-885C-3E5225D9F336}" attr="4" directory="TARGETDIR" feature="F__DefaultFeature" &gt;
  3594. &lt;key file="R__822EC365A8754FACBF6C713BFE4E57F0" /&gt;
  3595. &lt;/component&gt;
  3596. &lt;/components&gt;
  3597. .
  3598. .
  3599. .
  3600. &lt;registry&gt;
  3601. &lt;key path="SOFTWARE\MyCompany\MyProduct\" root="machine" component="C__RegistryEntry"&gt;
  3602. &lt;value id="R__822EC365A8754FACBF6C713BFE4E57F0" name="MyKeyName" value="MyKeyValue" /&gt;
  3603. &lt;/key&gt;
  3604. &lt;/registry&gt;
  3605. </code>
  3606. </example>
  3607. </summary>
  3608. </member>
  3609. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerDialogsElement">
  3610. <summary>
  3611. <para>
  3612. Creates custom dialogs that can gather information not handled by
  3613. the default installer template.
  3614. </para>
  3615. <h3>Parameters</h3>
  3616. <list type="table">
  3617. <listheader>
  3618. <term>Attribute</term>
  3619. <term>Type</term>
  3620. <term>Description</term>
  3621. <term>Required</term>
  3622. </listheader>
  3623. <item>
  3624. <term>name</term>
  3625. <term>string</term>
  3626. <term>A name used to refer to the dialog.</term>
  3627. <term>True</term>
  3628. </item>
  3629. <item>
  3630. <term>hcenter</term>
  3631. <term>int</term>
  3632. <term>Horizontal position of the dialog box. The range is 0 to 100, with 0 at the left edge of the screen and 100 at the right edge.</term>
  3633. <term>True</term>
  3634. </item>
  3635. <item>
  3636. <term>vcenter</term>
  3637. <term>int</term>
  3638. <term>Vertical position of the dialog box. The range is 0 to 100, with 0 at the top edge of the screen and 100 at the bottom edge.</term>
  3639. <term>True</term>
  3640. </item>
  3641. <item>
  3642. <term>width</term>
  3643. <term>int</term>
  3644. <term>Width of the rectangular boundary of the dialog box. This number must be non-negative.</term>
  3645. <term>True</term>
  3646. </item>
  3647. <item>
  3648. <term>height</term>
  3649. <term>int</term>
  3650. <term>Height of the rectangular boundary of the dialog box. This number must be non-negative.</term>
  3651. <term>True</term>
  3652. </item>
  3653. <item>
  3654. <term>attr</term>
  3655. <term>int</term>
  3656. <term>A 32-bit word that specifies the attribute flags to be applied to this dialog box. This number must be non-negative.
  3657. <list type="table">
  3658. <listheader>
  3659. <term>Value</term>
  3660. <description>Description</description>
  3661. </listheader>
  3662. <item>
  3663. <term>1</term>
  3664. <description>Visible</description>
  3665. </item>
  3666. <item>
  3667. <term>2</term>
  3668. <description>Modal</description>
  3669. </item>
  3670. <item>
  3671. <term>4</term>
  3672. <description>Minimize</description>
  3673. </item>
  3674. <item>
  3675. <term>8</term>
  3676. <description>SysModal</description>
  3677. </item>
  3678. <item>
  3679. <term>16</term>
  3680. <description>KeepModeless</description>
  3681. </item>
  3682. <item>
  3683. <term>32</term>
  3684. <description>TrackDiskSpace</description>
  3685. </item>
  3686. <item>
  3687. <term>64</term>
  3688. <description>UseCustomPalette</description>
  3689. </item>
  3690. <item>
  3691. <term>128</term>
  3692. <description>RTLRO</description>
  3693. </item>
  3694. <item>
  3695. <term>256</term>
  3696. <description>RightAligned</description>
  3697. </item>
  3698. <item>
  3699. <term>512</term>
  3700. <description>LeftScroll</description>
  3701. </item>
  3702. <item>
  3703. <term>896</term>
  3704. <description>BiDi</description>
  3705. </item>
  3706. <item>
  3707. <term>65536</term>
  3708. <description>Error</description>
  3709. </item>
  3710. </list>
  3711. More information here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp">http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp</a>
  3712. </term>
  3713. <term>True</term>
  3714. </item>
  3715. <item>
  3716. <term>title</term>
  3717. <term>string</term>
  3718. <term>A localizable text string specifying the title to be displayed in the title bar of the dialog box.</term>
  3719. <term>True</term>
  3720. </item>
  3721. <item>
  3722. <term>firstcontrol</term>
  3723. <term>string</term>
  3724. <term>An external key to the second column of the Control table. Combining this field with the Dialog field identifies a
  3725. unique control in the Control table. This defines the control that takes the focus when the dialog box is created. This
  3726. column is ignored in an Error dialog box. <br/>
  3727. Because static text cannot take the focus, a Text control that describes an Edit, PathEdit, ListView, ComboBox or
  3728. VolumeSelectCombo control must be made the first control in the dialog box to ensure compatibility with screen readers.
  3729. </term>
  3730. <term>True</term>
  3731. </item>
  3732. <item>
  3733. <term>defaultcontrol</term>
  3734. <term>string</term>
  3735. <term>An external key to the second column of the Control table. Combining this field with the Dialog field results in
  3736. a primary key into the Control table that defines the default control. Hitting the Return key is equivalent to clicking
  3737. on the default control. If this column is left blank, then there is no default control. This column is ignored in the
  3738. Error dialog box.
  3739. </term>
  3740. <term>True</term>
  3741. </item>
  3742. <item>
  3743. <term>cancelcontrol</term>
  3744. <term>string</term>
  3745. <term>An external key to the second column of the Control table. Combining this field with the Dialog field results in
  3746. a primary key of the Control table that defines the cancel control. Hitting the ESC key or clicking the Close button in
  3747. the dialog box is equivalent to clicking on the cancel control. This column is ignored in an Error dialog box. <br />
  3748. The cancel control is hidden during rollback or the removal of backed up files. The protected UI handler hides the control
  3749. upon receiving a INSTALLMESSAGE_COMMONDATA message.
  3750. </term>
  3751. <term>True</term>
  3752. </item>
  3753. </list>
  3754. <h3>Examples</h3>
  3755. <example>
  3756. <para>Add a web folder dialog:</para>
  3757. <code>
  3758. &lt;dialogs&gt;
  3759. &lt;dialog name="WebFolderDlg" hcenter="50" vcenter="50" width="370" height="270" attr="39" title="[ProductName] [Setup]" firstcontrol="Next" defaultcontrol="Next" cancelcontrol="Cancel" /&gt;
  3760. &lt;/dialogs&gt;
  3761. </code>
  3762. </example>
  3763. </summary>
  3764. </member>
  3765. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlsElement">
  3766. <summary>
  3767. <para>
  3768. Creates user interface controls displayed on custom dialogs.
  3769. </para>
  3770. <h3>Parameters</h3>
  3771. <list type="table">
  3772. <listheader>
  3773. <term>Attribute</term>
  3774. <term>Type</term>
  3775. <term>Description</term>
  3776. <term>Required</term>
  3777. </listheader>
  3778. <item>
  3779. <term>name</term>
  3780. <term>string</term>
  3781. <term>Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes.</term>
  3782. <term>True</term>
  3783. </item>
  3784. <item>
  3785. <term>dialog</term>
  3786. <term>string</term>
  3787. <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
  3788. <term>True</term>
  3789. </item>
  3790. <item>
  3791. <term>type</term>
  3792. <term>string</term>
  3793. <term>The type of the control.
  3794. <list type="table">
  3795. <listheader>
  3796. <term>Control name</term>
  3797. <description>Description</description>
  3798. </listheader>
  3799. <item>
  3800. <term>Billboard</term>
  3801. <description>Displays billboards based on progress messages.</description>
  3802. </item>
  3803. <item>
  3804. <term>Bitmap</term>
  3805. <description>Displays a static picture of a bitmap.</description>
  3806. </item>
  3807. <item>
  3808. <term>CheckBox</term>
  3809. <description>A two-state check box.</description>
  3810. </item>
  3811. <item>
  3812. <term>ComboBox</term>
  3813. <description>A drop-down list with an edit field.</description>
  3814. </item>
  3815. <item>
  3816. <term>DirectoryCombo</term>
  3817. <description>Select all except the last segment of the path.</description>
  3818. </item>
  3819. <item>
  3820. <term>DirectoryList</term>
  3821. <description>Displays folders below the main part of path.</description>
  3822. </item>
  3823. <item>
  3824. <term>Edit</term>
  3825. <description>A regular edit field for any string or integer.</description>
  3826. </item>
  3827. <item>
  3828. <term>GroupBox</term>
  3829. <description>Displays a rectangle that groups other controls together.</description>
  3830. </item>
  3831. <item>
  3832. <term>Icon</term>
  3833. <description>Displays a static picture of an icon.</description>
  3834. </item>
  3835. <item>
  3836. <term>Line</term>
  3837. <description>Displays a horizontal line.</description>
  3838. </item>
  3839. <item>
  3840. <term>ListBox</term>
  3841. <description>A drop-down list without an edit field.</description>
  3842. </item>
  3843. <item>
  3844. <term>ListView</term>
  3845. <description>Displays a column of values with icons for selection.</description>
  3846. </item>
  3847. <item>
  3848. <term>MaskedEdit</term>
  3849. <description>An edit field with a mask in the text field.</description>
  3850. </item>
  3851. <item>
  3852. <term>PathEdit</term>
  3853. <description>Displays folder name or entire path in an edit field.</description>
  3854. </item>
  3855. <item>
  3856. <term>ProgressBar</term>
  3857. <description>Bar graph that changes length as it receives progress messages.</description>
  3858. </item>
  3859. <item>
  3860. <term>PushButton</term>
  3861. <description>Displays a basic push button.</description>
  3862. </item>
  3863. <item>
  3864. <term>RadioButtonGroup</term>
  3865. <description>A group of radio buttons.</description>
  3866. </item>
  3867. <item>
  3868. <term>ScrollableText</term>
  3869. <description>Displays a long string of text.</description>
  3870. </item>
  3871. <item>
  3872. <term>SelectionTree</term>
  3873. <description>Displays information from the Feature table and enables the user to change their selection state.</description>
  3874. </item>
  3875. <item>
  3876. <term>Text</term>
  3877. <description>Displays static text.</description>
  3878. </item>
  3879. <item>
  3880. <term>VolumeCostList</term>
  3881. <description>Displays costing information on different volumes.</description>
  3882. </item>
  3883. <item>
  3884. <term>VolumeSelectCombo</term>
  3885. <description>Selects volume from an alphabetical list.</description>
  3886. </item>
  3887. </list>
  3888. More information found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp">http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp</a></term>
  3889. <term>True</term>
  3890. </item>
  3891. <item>
  3892. <term>x</term>
  3893. <term>int</term>
  3894. <term>Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</term>
  3895. <term>True</term>
  3896. </item>
  3897. <item>
  3898. <term>y</term>
  3899. <term>int</term>
  3900. <term>Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</term>
  3901. <term>True</term>
  3902. </item>
  3903. <item>
  3904. <term>width</term>
  3905. <term>int</term>
  3906. <term>Width of the rectangular boundary of the control. This must be a non-negative number.</term>
  3907. <term>True</term>
  3908. </item>
  3909. <item>
  3910. <term>height</term>
  3911. <term>int</term>
  3912. <term>Height of the rectangular boundary of the control. This must be a non-negative number.</term>
  3913. <term>True</term>
  3914. </item>
  3915. <item>
  3916. <term>attr</term>
  3917. <term>int</term>
  3918. <term>A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/control_attributes.asp">Control Attributes</a>.</term>
  3919. <term>True</term>
  3920. </item>
  3921. <item>
  3922. <term>property</term>
  3923. <term>string</term>
  3924. <term>The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls.</term>
  3925. <term>False</term>
  3926. </item>
  3927. <item>
  3928. <term>text</term>
  3929. <term>string</term>
  3930. <term>A localizable string used to set the initial text contained in a control. The string can also contain embedded properties.</term>
  3931. <term>False</term>
  3932. </item>
  3933. <item>
  3934. <term>nextcontrol</term>
  3935. <term>string</term>
  3936. <term>The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. </term>
  3937. <term>False</term>
  3938. </item>
  3939. <item>
  3940. <term>help</term>
  3941. <term>string</term>
  3942. <term>Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present.</term>
  3943. <term>False</term>
  3944. </item>
  3945. <item>
  3946. <term>remove</term>
  3947. <term>bool</term>
  3948. <term>If <c>true</c>, the control is removed. If <c>false</c>, the control is added.</term>
  3949. <term>False</term>
  3950. </item>
  3951. </list>
  3952. <h3>Examples</h3>
  3953. <example>
  3954. <para>Remove the Browse button from the customize dialog and add controls for a web dialog</para>
  3955. <code>
  3956. &lt;controls&gt;
  3957. &lt;!-- Remove the Browse button from customize dialog --&gt;
  3958. &lt;control dialog="CustomizeDlg" name="Browse" type="PushButton"
  3959. x="304" y="200" width="56" height="17" attr="3" remove="true" /&gt;
  3960. &lt;control dialog="CustomizeDlg" name="Tree" type="SelectionTree"
  3961. x="25" y="85" width="175" height="95" attr="7" remove="true" /&gt;
  3962. &lt;!-- Re add the tree control with the proper next control --&gt;
  3963. &lt;control dialog="CustomizeDlg" name="Tree" type="SelectionTree"
  3964. x="25" y="85" width="175" height="95" attr="7"
  3965. property="_BrowseProperty" text="Tree of selections" nextcontrol="Reset" /&gt;
  3966. &lt;!-- Adds the controls associated with the webfolder dialog --&gt;
  3967. &lt;control dialog="WebFolderDlg" name="BannerBitmap" type="Bitmap"
  3968. x="0" y="0" width="374" height="44" attr="1"
  3969. text="[BannerBitmap]" nextcontrol="VDirLabel" /&gt;
  3970. &lt;control dialog="WebFolderDlg" name="Title" type="Text"
  3971. x="15" y="6" width="200" height="15" attr="196611"
  3972. text="[DlgTitleFont]Virtual Directory Information" /&gt;
  3973. &lt;control dialog="WebFolderDlg" name="Description" type="Text"
  3974. x="25" y="23" width="280" height="15" attr="196611"
  3975. text="Please enter your virtual directory and port information." /&gt;
  3976. &lt;control dialog="WebFolderDlg" name="BannerLine" type="Line"
  3977. x="0" y="44" width="374" height="0" attr="1" /&gt;
  3978. &lt;control dialog="WebFolderDlg" name="VDirLabel" type="Text"
  3979. x="18" y="73" width="348" height="15" attr="3"
  3980. text="&amp;Virtual directory:"
  3981. nextcontrol="Edit_VDir" /&gt;
  3982. &lt;control dialog="WebFolderDlg" name="Edit_VDir" type="Edit"
  3983. x="18" y="85" width="252" height="18" attr="7"
  3984. property="TARGETVDIR"
  3985. text="[TARGETVDIR]"
  3986. nextcontrol="PortLabel" /&gt;
  3987. &lt;control dialog="WebFolderDlg" name="PortLabel" type="Text"
  3988. x="18" y="110" width="348" height="15" attr="3"
  3989. text="&amp;Port:"
  3990. nextcontrol="Edit_Port" /&gt;
  3991. &lt;control dialog="WebFolderDlg" name="Edit_Port" type="Edit"
  3992. x="18" y="122" width="48" height="18" attr="7"
  3993. property="TARGETPORT"
  3994. text="[TARGETPORT]"
  3995. nextcontrol="Back" /&gt;
  3996. &lt;control dialog="WebFolderDlg" name="BottomLine" type="Line"
  3997. x="0" y="234" width="374" height="0" attr="1" /&gt;
  3998. &lt;control dialog="WebFolderDlg" name="Back" type="PushButton"
  3999. x="180" y="243" width="56" height="17" attr="3"
  4000. text="[ButtonText_Back]" nextcontrol="Next" /&gt;
  4001. &lt;control dialog="WebFolderDlg" name="Next" type="PushButton"
  4002. x="236" y="243" width="56" height="17" attr="3"
  4003. text="[ButtonText_Next]" nextcontrol="Cancel" /&gt;
  4004. &lt;control dialog="WebFolderDlg" name="Cancel" type="PushButton"
  4005. x="304" y="243" width="56" height="17" attr="3"
  4006. text="[ButtonText_Cancel]" nextcontrol="BannerBitmap" /&gt;
  4007. &lt;/controls&gt;
  4008. </code>
  4009. </example>
  4010. </summary>
  4011. </member>
  4012. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlConditionsElement">
  4013. <summary>
  4014. <para>
  4015. Used to validate and perform operations as the result of information
  4016. entered by the user into controls on custom dialogs.
  4017. </para>
  4018. <h3>Parameters</h3>
  4019. <list type="table">
  4020. <listheader>
  4021. <term>Attribute</term>
  4022. <term>Type</term>
  4023. <term>Description</term>
  4024. <term>Required</term>
  4025. </listheader>
  4026. <item>
  4027. <term>dialog</term>
  4028. <term>string</term>
  4029. <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
  4030. <term>True</term>
  4031. </item>
  4032. <item>
  4033. <term>control</term>
  4034. <term>string</term>
  4035. <term>Refrence to a control. Maps to a control for the specified dialog.</term>
  4036. <term>True</term>
  4037. </item>
  4038. <item>
  4039. <term>action</term>
  4040. <term>string</term>
  4041. <term>The action that is to be taken on the control. The possible actions are shown in the following table.
  4042. <list type="table">
  4043. <listheader>
  4044. <term>Value</term>
  4045. <description>Description</description>
  4046. </listheader>
  4047. <item>
  4048. <term>Default</term>
  4049. <description>Set control as the default.</description>
  4050. </item>
  4051. <item>
  4052. <term>Disable</term>
  4053. <description>Disable the control.</description>
  4054. </item>
  4055. <item>
  4056. <term>Enable</term>
  4057. <description>Enable the control.</description>
  4058. </item>
  4059. <item>
  4060. <term>Hide</term>
  4061. <description>Hide the control.</description>
  4062. </item>
  4063. <item>
  4064. <term>Show</term>
  4065. <description>Display the control.</description>
  4066. </item>
  4067. </list>
  4068. </term>
  4069. <term>True</term>
  4070. </item>
  4071. <item>
  4072. <term>condition</term>
  4073. <term>string</term>
  4074. <term>A conditional statement that specifies under which conditions the action should be triggered. If this statement does not evaluate to TRUE, the action does not take place. If it is set to 1, the action is always applied. </term>
  4075. <term>True</term>
  4076. </item>
  4077. <item>
  4078. <term>remove</term>
  4079. <term>bool</term>
  4080. <term>If <c>true</c>, the control condition is removed. If <c>false</c>, the control condition is added.</term>
  4081. <term>False</term>
  4082. </item>
  4083. </list>
  4084. <h3>Examples</h3>
  4085. <example>
  4086. <para>Remove the control condition for the Browse button from the customize dialog and add control conditions for a web dialog</para>
  4087. <code>
  4088. &lt;controlconditions&gt;
  4089. &lt;!-- Remove control condition for Browse button on customizeDlg --&gt;
  4090. &lt;controlcondition dialog="CustomizeDlg" control="Browse" action="Hide"
  4091. condition="Installed" remove="true" /&gt;
  4092. &lt;!-- Add control conditions for the web folder dialog --&gt;
  4093. &lt;controlcondition dialog="WebFolderDlg" control="Back" action="Disable"
  4094. condition="ShowUserRegistrationDlg=&quot;&quot;" /&gt;
  4095. &lt;controlcondition dialog="WebFolderDlg" control="Back" action="Enable"
  4096. condition="ShowUserRegistrationDlg&lt;&gt;&quot;&quot;" /&gt;
  4097. &lt;/controlconditions&gt;
  4098. </code>
  4099. </example>
  4100. </summary>
  4101. </member>
  4102. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlEventsElement">
  4103. <summary>
  4104. <para>
  4105. Used to route the flow of the installation process as the result of
  4106. events raised by the user interacting with controls on dialogs.
  4107. </para>
  4108. <h3>Parameters</h3>
  4109. <list type="table">
  4110. <listheader>
  4111. <term>Attribute</term>
  4112. <term>Type</term>
  4113. <term>Description</term>
  4114. <term>Required</term>
  4115. </listheader>
  4116. <item>
  4117. <term>dialog</term>
  4118. <term>string</term>
  4119. <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
  4120. <term>True</term>
  4121. </item>
  4122. <item>
  4123. <term>control</term>
  4124. <term>string</term>
  4125. <term>Refrence to a control. Maps to a control for the specified dialog.</term>
  4126. <term>True</term>
  4127. </item>
  4128. <item>
  4129. <term>name</term>
  4130. <term>string</term>
  4131. <term>An identifier that specifies the type of event that should take place when the user interacts with the control
  4132. specified by Dialog_ and Control_. For a list of possible values see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/controlevent_overview.asp">ControlEvent Overview</a>. <br/>
  4133. To set a property with a control, put [Property_Name] in this field and the new value in the argument field. Put { }
  4134. into the argument field to enter the null value.
  4135. </term>
  4136. <term>True</term>
  4137. </item>
  4138. <item>
  4139. <term>argument</term>
  4140. <term>string</term>
  4141. <term>A value used as a modifier when triggering a particular event.</term>
  4142. <term>True</term>
  4143. </item>
  4144. <item>
  4145. <term>condition</term>
  4146. <term>string</term>
  4147. <term>A conditional statement that determines whether the installer activates the event in the Event column. The installer
  4148. triggers the event if the conditional statement in the Condition field evaluates to True. Therefore put a 1 in this column
  4149. to ensure that the installer triggers the event. The installer does not trigger the event if the Condition field contains
  4150. a statement that evaluates to False. The installer does not trigger an event with a blank in the Condition field unless no
  4151. other events of the control evaluate to True. If none of the Condition fields for the control named in the Control_ field
  4152. evaluate to True, the installer triggers the one event having a blank Condition field, and if more than one Condition field
  4153. is blank it triggers the one event of these with the largest value in the Ordering field.</term>
  4154. <term>False</term>
  4155. </item>
  4156. <item>
  4157. <term>order</term>
  4158. <term>int</term>
  4159. <term>An integer used to order several events tied to the same control. This must be a non-negative number.</term>
  4160. <term>False</term>
  4161. </item>
  4162. <item>
  4163. <term>remove</term>
  4164. <term>bool</term>
  4165. <term>If <c>true</c>, the control condition is removed. If <c>false</c>, the control condition is added.</term>
  4166. <term>False</term>
  4167. </item>
  4168. </list>
  4169. <h3>Examples</h3>
  4170. <example>
  4171. <para>Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog</para>
  4172. <code>
  4173. <!-- Make sure the dialog is put into the execute order -->
  4174. &lt;controlevents&gt;
  4175. &lt;!-- Remove the old control events --&gt;
  4176. &lt;controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog"
  4177. argument="SetupTypeDlg" condition="ProductID" remove="true" /&gt;
  4178. &lt;controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog"
  4179. argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg &lt;&gt; 1" remove="true" /&gt;
  4180. &lt;controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog"
  4181. argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg = 1" remove="true" /&gt;
  4182. &lt;!-- Remove control events for Browse button on CustomizeDlg --&gt;
  4183. &lt;controlevent dialog="CustomizeDlg" control="Browse" name="SelectionBrowse"
  4184. argument="BrowseDlg" condition="1" remove="true" /&gt;
  4185. &lt;!-- Add new control events for the web dialog --&gt;
  4186. &lt;controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog"
  4187. argument="WebFolderDlg" condition="ProductID" /&gt;
  4188. &lt;controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog"
  4189. argument="WebFolderDlg" condition="ShowWebFolderDlg &lt;&gt; 1" /&gt;
  4190. &lt;controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog"
  4191. argument="WebFolderDlg" condition="ShowWebFolderDlg = 1" /&gt;
  4192. &lt;controlevent dialog="WebFolderDlg" control="Cancel" name="SpawnDialog"
  4193. argument="CancelDlg" order="0" /&gt;
  4194. &lt;controlevent dialog="WebFolderDlg" control="Back" name="NewDialog"
  4195. argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg&lt;&gt;1"
  4196. order="0" /&gt;
  4197. &lt;controlevent dialog="WebFolderDlg" control="Back" name="NewDialog"
  4198. argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg=1"
  4199. order="0" /&gt;
  4200. &lt;!-- Virtual Directory Control Events --&gt;
  4201. &lt;controlevent dialog="WebFolderDlg" control="Next" name="DoAction"
  4202. argument="WEBCA_CreateURLs" condition="1" order="0" /&gt;
  4203. &lt;controlevent dialog="WebFolderDlg" control="Next" name="DoAction"
  4204. argument="WEBCA_EvaluateURLsMB" condition="1" order="1" /&gt;
  4205. &lt;controlevent dialog="WebFolderDlg" control="Next" name="SetTargetPath"
  4206. argument="TARGETDIR" condition="1" order="2" /&gt;
  4207. &lt;controlevent dialog="WebFolderDlg" control="Next" name="NewDialog"
  4208. argument="SetupTypeDlg" condition="1" order="3" /&gt;
  4209. &lt;/controlevents&gt;
  4210. </code>
  4211. </example>
  4212. </summary>
  4213. </member>
  4214. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerRegistryElement">
  4215. <summary>
  4216. <para>
  4217. Makes modifications to the Windows Registry of the target computer
  4218. at runtime.
  4219. </para>
  4220. <h3>Parameters</h3>
  4221. <list type="table">
  4222. <listheader>
  4223. <term>Attribute</term>
  4224. <term>Type</term>
  4225. <term>Description</term>
  4226. <term>Required</term>
  4227. </listheader>
  4228. <item>
  4229. <term>component</term>
  4230. <term>string</term>
  4231. <term>Refrence to a component. The component that controls the installation of the registry value.</term>
  4232. <term>True</term>
  4233. </item>
  4234. <item>
  4235. <term>root</term>
  4236. <term>msi:MSIRegistryKeyRoot</term>
  4237. <term>Valid input:
  4238. <list type="bullet">
  4239. <item><c>dependent</c> - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1.</item>
  4240. <item><c>machine</c> represents HKEY_LOCAL_MACHINE</item>
  4241. <item><c>classes</c> represents HKEY_CLASSES_ROOT</item>
  4242. <item><c>user</c> represents HKEY_CURRENT_USER</item>
  4243. <item><c>users</c> represents HKEY_USERS</item>
  4244. </list>
  4245. </term>
  4246. <term>True</term>
  4247. </item>
  4248. <item>
  4249. <term>path</term>
  4250. <term>string</term>
  4251. <term>Registry key.</term>
  4252. <term>True</term>
  4253. </item>
  4254. </list>
  4255. <h3>Nested Elements:</h3>
  4256. <h4>&lt;value&gt;</h4>
  4257. <ul>
  4258. Specifies the registry value to add to the target machine.
  4259. <list type="table">
  4260. <listheader>
  4261. <term>Attribute</term>
  4262. <term>Type</term>
  4263. <term>Description</term>
  4264. <term>Required</term>
  4265. </listheader>
  4266. <item>
  4267. <term>name</term>
  4268. <term>string</term>
  4269. <term>The registry value name (localizable). If this is Null, then the data entered into the Value column are
  4270. written to the default registry key. <br/>
  4271. If the Value column is Null, then the strings shown in the following table in the Name column have special
  4272. significance.
  4273. <list type="table">
  4274. <listheader>
  4275. <term>String</term>
  4276. <description>Description</description>
  4277. </listheader>
  4278. <item>
  4279. <term>+</term>
  4280. <description>The key is to be created, if absent, when the component is installed.</description>
  4281. </item>
  4282. <item>
  4283. <term>-</term>
  4284. <description>The key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled.</description>
  4285. </item>
  4286. <item>
  4287. <term>*</term>
  4288. <description>The key is to be created, if absent, when the component is installed. Additionally, the key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled.</description>
  4289. </item>
  4290. </list>
  4291. </term>
  4292. <term>False</term>
  4293. </item>
  4294. <item>
  4295. <term>value</term>
  4296. <term>string</term>
  4297. <term>The localizable registry value. The field is <a href="http://msdn.microsoft.com/library/en-us/msi/setup/formatted.asp">Formatted</a>. If the value is attached to one of the following prefixes (i.e. #%value) then the value is interpreted as described in the table. Note that each prefix begins with a number sign (#). If the value begins with two or more consecutive number signs (#), the first # is ignored and value is interpreted and stored as a string.
  4298. <list type="table">
  4299. <listheader>
  4300. <term>Prefix</term>
  4301. <description>Description</description>
  4302. </listheader>
  4303. <item>
  4304. <term>#x</term>
  4305. <description>The value is interpreted and stored as a hexadecimal value (REG_BINARY).</description>
  4306. </item>
  4307. <item>
  4308. <term>#%</term>
  4309. <description>The value is interpreted and stored as an expandable string (REG_EXPAND_SZ).</description>
  4310. </item>
  4311. <item>
  4312. <term>#</term>
  4313. <description>The value is interpreted and stored as an integer (REG_DWORD).</description>
  4314. </item>
  4315. </list>
  4316. <list type="bullet">
  4317. <item>If the value contains the sequence tilde [~], then the value is interpreted as a Null-delimited list of strings (REG_MULTI_SZ). For example, to specify a list containing the three strings a, b and c, use "a[~]b[~]c." </item>
  4318. <item>The sequence [~] within the value separates the individual strings and is interpreted and stored as a Null character.</item>
  4319. <item>If a [~] precedes the string list, the strings are to be appended to any existing registry value strings. If an appending string already occurs in the registry value, the original occurrence of the string is removed.</item>
  4320. <item>If a [~] follows the end of the string list, the strings are to be prepended to any existing registry value strings. If a prepending string already occurs in the registry value, the original occurrence of the string is removed.</item>
  4321. <item>If a [~] is at both the beginning and the end or at neither the beginning nor the end of the string list, the strings are to replace any existing registry value strings.</item>
  4322. <item>Otherwise, the value is interpreted and stored as a string (REG_SZ). </item>
  4323. </list>
  4324. </term>
  4325. <term>False</term>
  4326. </item>
  4327. <item>
  4328. <term>dword</term>
  4329. <term>string</term>
  4330. <term>A dword value to input, if the value attribute is null. This removes the requirement of adding "#" before the value.</term>
  4331. <term>False</term>
  4332. </item>
  4333. <item>
  4334. <term>id</term>
  4335. <term>string</term>
  4336. <term>Primary key used to identify a registry record.</term>
  4337. <term>False</term>
  4338. </item>
  4339. </list>
  4340. </ul>
  4341. <h4>&lt;/value&gt;</h4>
  4342. <h3>Examples</h3>
  4343. <example>
  4344. <para>Add the a couple registry entries on the target machine.</para>
  4345. <code>
  4346. &lt;registry&gt;
  4347. &lt;key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" &gt;
  4348. &lt;value name="ProductVersion" value="1.0.0" /&gt;
  4349. &lt;value name="ProductDir" value="[TARGETDIR]" /&gt;
  4350. &lt;value name="VirtualDir" value="[TARGETVDIR]" /&gt;
  4351. &lt;/key&gt;
  4352. &lt;/registry&gt;
  4353. </code>
  4354. </example>
  4355. <example>
  4356. <para>Add a default key value to the specified registry key path</para>
  4357. <code>
  4358. &lt;registry&gt;
  4359. &lt;key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" &gt;
  4360. &lt;value value="1.0.0" /&gt;
  4361. &lt;/key&gt;
  4362. &lt;/registry&gt;
  4363. </code>
  4364. </example>
  4365. <example>
  4366. <para>Another way to add a default key value to the specified registry key path</para>
  4367. <code>
  4368. &lt;registry&gt;
  4369. &lt;key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" &gt;
  4370. &lt;value name="" value="1.0.0" /&gt;
  4371. &lt;/key&gt;
  4372. &lt;/registry&gt;
  4373. </code>
  4374. </example>
  4375. <example>
  4376. <para>Specify hexadecimal value (REG_BINARY) for the default key</para>
  4377. <code>
  4378. &lt;registry&gt;
  4379. &lt;key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" &gt;
  4380. &lt;value&gt;
  4381. 1a,81,0a,03,01,00,06,00,00,00,d3,15,fd,00,01,00,00,00,00,00,01,
  4382. 00,00,00,00,00,00,00,00,00,00,00,b0,90,ce,09,01,00,00,00,00,00,ff,ff,ff,00,
  4383. 00,00,00,00,00,00,00,00,6d,7a,0a,03,01,00,00,00,00,00,00,00,38,40,00,00,00,
  4384. 00,00,00,00,00,00,00,00,00,90,01,00,00,00,00,00,01,00,00,00,00,0f,00,00,00,
  4385. f0,ff,ff,ff,54,69,6d,65,73,20,4e,65,77,20,52,6f,6d,61,6e,f4,6f,d4,08,02,00
  4386. &lt;/value&gt;
  4387. &lt;/key&gt;
  4388. &lt;/registry&gt;
  4389. </code>
  4390. </example>
  4391. </summary>
  4392. </member>
  4393. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerIconsElement">
  4394. <summary>
  4395. <para>
  4396. Stores icons to be used with shortcuts, file extensions, CLSIDs or
  4397. similar uses.
  4398. </para>
  4399. <h3>Parameters</h3>
  4400. <list type="table">
  4401. <listheader>
  4402. <term>Attribute</term>
  4403. <term>Type</term>
  4404. <term>Description</term>
  4405. <term>Required</term>
  4406. </listheader>
  4407. <item>
  4408. <term>name</term>
  4409. <term>string</term>
  4410. <term>Name of the icon file.</term>
  4411. <term>True</term>
  4412. </item>
  4413. <item>
  4414. <term>value</term>
  4415. <term>string</term>
  4416. <term>The binary icon data in PE (.dll or .exe) or icon (.ico) format.</term>
  4417. <term>True</term>
  4418. </item>
  4419. </list>
  4420. <h3>Examples</h3>
  4421. <example>
  4422. <para>Add a compiled help icon to the msi database; To be used with a shortcut.</para>
  4423. <code>
  4424. &lt;icons&gt;
  4425. &lt;icon name="CHMICON" value="${resource.dir}\chm.ico" /&gt;
  4426. &lt;/icons&gt;
  4427. </code>
  4428. </example>
  4429. </summary>
  4430. </member>
  4431. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerShortcutsElement">
  4432. <summary>
  4433. <para>
  4434. Creates shortcuts on the target computer.
  4435. </para>
  4436. <h3>Parameters</h3>
  4437. <list type="table">
  4438. <listheader>
  4439. <term>Attribute</term>
  4440. <term>Type</term>
  4441. <term>Description</term>
  4442. <term>Required</term>
  4443. </listheader>
  4444. <item>
  4445. <term>name</term>
  4446. <term>string</term>
  4447. <term>Unique name identifying the shortcut.</term>
  4448. <term>True</term>
  4449. </item>
  4450. <item>
  4451. <term>directory</term>
  4452. <term>string</term>
  4453. <term>Reference to a directory. The location of where the shortcut should be created.</term>
  4454. <term>True</term>
  4455. </item>
  4456. <item>
  4457. <term>filename</term>
  4458. <term>string</term>
  4459. <term>The localizable name of the shortcut to be created.</term>
  4460. <term>True</term>
  4461. </item>
  4462. <item>
  4463. <term>component</term>
  4464. <term>string</term>
  4465. <term>Reference to a component. The installer uses the installation state of this specified component to determine whether the shortcut is created or deleted. This component must have a valid key path for the shortcut to be installed. If the Target column contains the name of a feature, the file launched by the shortcut is the key file of the component listed in this column. </term>
  4466. <term>True</term>
  4467. </item>
  4468. <item>
  4469. <term>target</term>
  4470. <term>string</term>
  4471. <term>The shortcut target. The installer evaluates this field as a Formatted string. The field should contains a property identifier enclosed by square brackets ([ ]), that is expanded into the file or a folder pointed to by the shortcut.</term>
  4472. <term>True</term>
  4473. </item>
  4474. <item>
  4475. <term>arguments</term>
  4476. <term>string</term>
  4477. <term>The command-line arguments for the shortcut. <br/>Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved if the property already has the intended value when the component owning the shortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the file MyDoc.doc and the component that owns the shortcut.
  4478. </term>
  4479. <term>False</term>
  4480. </item>
  4481. <item>
  4482. <term>hotkey</term>
  4483. <term>string</term>
  4484. <term>The hotkey for the shortcut. The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags. This must be a non-negative number. Authors of installation packages are generally recommend not to set this option, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for users using hotkeys for accessibility.</term>
  4485. <term>False</term>
  4486. </item>
  4487. <item>
  4488. <term>icon</term>
  4489. <term>string</term>
  4490. <term>Reference to an icon. </term>
  4491. <term>False</term>
  4492. </item>
  4493. <item>
  4494. <term>iconindex</term>
  4495. <term>int</term>
  4496. <term>The icon index for the shortcut. This must be a non-negative number.</term>
  4497. <term>False</term>
  4498. </item>
  4499. <item>
  4500. <term>showcmd</term>
  4501. <term>int</term>
  4502. <term>The Show command for the application window. <br/>The following values may be used. The values are as defined for the Windows API function ShowWindow.
  4503. <list type="table">
  4504. <listheader>
  4505. <term>Value</term>
  4506. <description>Description</description>
  4507. </listheader>
  4508. <item>
  4509. <term>1</term>
  4510. <description>SW_SHOWNORMAL</description>
  4511. </item>
  4512. <item>
  4513. <term>3</term>
  4514. <description>SW_SHOWMAXIMIZED</description>
  4515. </item>
  4516. <item>
  4517. <term>7</term>
  4518. <description>SW_SHOWMINNOACTIVE</description>
  4519. </item>
  4520. </list>
  4521. </term>
  4522. <term>False</term>
  4523. </item>
  4524. <item>
  4525. <term>wkdir</term>
  4526. <term>string</term>
  4527. <term>The name of the property that has the path of the working directory for the shortcut.</term>
  4528. <term>False</term>
  4529. </item>
  4530. </list>
  4531. <h3>Nested Elements:</h3>
  4532. <h4>&lt;description&gt;</h4>
  4533. <ul>
  4534. The localizable description of the shortcut.
  4535. </ul>
  4536. <h4>&lt;/description&gt;</h4>
  4537. <h3>Examples</h3>
  4538. <example>
  4539. <para>Add a compiled help icon to the msi database; To be used with a shortcut.</para>
  4540. <code>
  4541. &lt;shortcuts&gt;
  4542. &lt;shortcut name="HelpFiles" directory="D__PROGRAMMENU_ACME_MYPRODUCT" filename="Help File" component="C__MainFiles" target="[$C__MainFiles]\Help.chm" icon="CHMICON" iconindex="0" showcmd="3" &gt;
  4543. &lt;description&gt;My Product help documentation&lt;/description&gt;
  4544. &lt;/shortcut&gt;
  4545. &lt;/shortcuts&gt;
  4546. </code>
  4547. </example>
  4548. </summary>
  4549. </member>
  4550. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerBinariesElement">
  4551. <summary>
  4552. <para>
  4553. Stores the binary data for items such as bitmaps, animations, and
  4554. icons. The binary table is also used to store data for custom
  4555. actions.
  4556. </para>
  4557. <h3>Parameters</h3>
  4558. <list type="table">
  4559. <listheader>
  4560. <term>Attribute</term>
  4561. <term>Type</term>
  4562. <term>Description</term>
  4563. <term>Required</term>
  4564. </listheader>
  4565. <item>
  4566. <term>name</term>
  4567. <term>string</term>
  4568. <term>A unique key that identifies the particular binary data. If the binary data is for a control, the key appears in the Text column of the associated control in the Control table. This key must be unique among all controls requiring binary data.</term>
  4569. <term>True</term>
  4570. </item>
  4571. <item>
  4572. <term>value</term>
  4573. <term>string</term>
  4574. <term>The binary file to add.</term>
  4575. <term>True</term>
  4576. </item>
  4577. </list>
  4578. <h3>Examples</h3>
  4579. <example>
  4580. <para>Add the custom action dll to create/modify virtual directories</para>
  4581. <code>
  4582. &lt;binaries&gt;
  4583. &lt;binary name="MSVBDPCADLL" value="${resource.dir}\MSVBDPCA.DLL" /&gt;
  4584. &lt;/binaries&gt;
  4585. </code>
  4586. </example>
  4587. </summary>
  4588. </member>
  4589. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerCustomActionsElement">
  4590. <summary>
  4591. <para>
  4592. Used to configure executables that may be run during steps in the
  4593. installation process to do things outside the bounds of MSI
  4594. technology's feature set. This is the main spot you can extend MSI
  4595. technology to perform custom processes via compiled code.
  4596. </para>
  4597. <h3>Parameters</h3>
  4598. <list type="table">
  4599. <listheader>
  4600. <term>Attribute</term>
  4601. <term>Type</term>
  4602. <term>Description</term>
  4603. <term>Required</term>
  4604. </listheader>
  4605. <item>
  4606. <term>action</term>
  4607. <term>string</term>
  4608. <term>Name of the action. The action normally appears in a sequence table unless it is called by another custom action. If the name matches any built-in action, then the custom action is never called. </term>
  4609. <term>True</term>
  4610. </item>
  4611. <item>
  4612. <term>type</term>
  4613. <term>string</term>
  4614. <term>A field of flag bits specifying the basic type of custom action and options. See <a href="http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp">Summary List of All Custom Action Types</a> for a list of the basic types. See <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_return_processing_options.asp">Custom Action Return Processing Options</a>, <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_execution_scheduling_options.asp">Custom Action Execution Scheduling Options</a>, <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_hidden_target_option.asp">Custom Action Hidden Target Option</a>, and <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_in_script_execution_options.asp">Custom Action In-Script Execution Options</a>. </term>
  4615. <term>True</term>
  4616. </item>
  4617. <item>
  4618. <term>source</term>
  4619. <term>string</term>
  4620. <term>A property name or external key into another table. For a discussion of the possible custom action sources, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_sources.asp">Custom Action Sources</a> and the <a href="http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp">Summary List of All Custom Action Types</a>. For example, the Source column may contain an external key into the first column of one of the following tables containing the source of the custom action code. <br/>
  4621. Directory table for calling existing executables.<br/>
  4622. File table for calling executables and DLLs that have just been installed.<br/>
  4623. Binary table for calling executables, DLLs, and data stored in the database.<br/>
  4624. Property table for calling executables whose paths are held by a property.
  4625. </term>
  4626. <term>True</term>
  4627. </item>
  4628. <item>
  4629. <term>target</term>
  4630. <term>string</term>
  4631. <term>An execution parameter that depends on the basic type of custom action. See the Summary List of All Custom Action Types for a description of what should be entered in this field for each type of custom action. For example, this field may contain the following depending on the custom action.
  4632. <list type="table">
  4633. <listheader>
  4634. <term>Target</term>
  4635. <term>Custom Action</term>
  4636. </listheader>
  4637. <item>
  4638. <term>Entry point (required)</term>
  4639. <term>Calling a DLL.</term>
  4640. </item>
  4641. <item>
  4642. <term>Executable name with arguments (required)</term>
  4643. <term>Calling an existing executable.</term>
  4644. </item>
  4645. <item>
  4646. <term>Command line arguments (optional)</term>
  4647. <term>Calling an executable just installed.</term>
  4648. </item>
  4649. <item>
  4650. <term>Target file name (required)</term>
  4651. <term>Creating a file from custom data.</term>
  4652. </item>
  4653. <item>
  4654. <term>Null</term>
  4655. <term>Executing script code.</term>
  4656. </item>
  4657. </list>
  4658. </term>
  4659. <term>True</term>
  4660. </item>
  4661. </list>
  4662. <h3>Examples</h3>
  4663. <example>
  4664. <para>Add some custom actions related to the virtual directory dialog and custom action.</para>
  4665. <code>
  4666. &lt;customactions&gt;
  4667. &lt;!-- Custom actions creating entry points into the custom action dll specified in the binary table --&gt;
  4668. &lt;customaction action="WEBCA_GatherWebFolderProperties" type="1" source="MSVBDPCADLL" target="GatherWebFolderProperties" /&gt;
  4669. &lt;customaction action="WEBCA_ApplyWebFolderProperties" type="1537" source="MSVBDPCADLL" target="ApplyWebFolderProperties" /&gt;
  4670. &lt;customaction action="WEBCA_RollbackApplyWebFolderProperties" type="1281" source="MSVBDPCADLL" target="RollbackApplyWebFolderProperties" /&gt;
  4671. &lt;customaction action="WEBCA_CreateURLs" type="1" source="MSVBDPCADLL" target="CreateURLs" /&gt;
  4672. &lt;customaction action="WEBCA_EvaluateURLs" type="1" source="MSVBDPCADLL" target="EvaluateURLs" /&gt;
  4673. &lt;customaction action="WEBCA_EvaluateURLsNoFail" type="1" source="MSVBDPCADLL" target="EvaluateURLsNoFail" /&gt;
  4674. &lt;customaction action="WEBCA_EvaluateURLsMB" type="1" source="MSVBDPCADLL" target="EvaluateURLsMB" /&gt;
  4675. &lt;customaction action="WEBCA_CreateAppRoots" type="1" source="MSVBDPCADLL" target="CreateAppRoots" /&gt;
  4676. &lt;!-- Custom actions to set default control values in the webfolder dialog --&gt;
  4677. &lt;customaction action="WEBCA_TARGETVDIR" type="307" source="TARGETVDIR" target="Default VDir" /&gt;
  4678. &lt;customaction action="WEBCA_TARGETPORT" type="307" source="TARGETPORT" target="80" /&gt;
  4679. &lt;/customactions&gt;
  4680. </code>
  4681. </example>
  4682. </summary>
  4683. </member>
  4684. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSequencesElement">
  4685. <summary>
  4686. <para>
  4687. Used to modify the sequence of tasks/events that execute during the
  4688. overall installation process.
  4689. </para>
  4690. <h3>Parameters</h3>
  4691. <list type="table">
  4692. <listheader>
  4693. <term>Attribute</term>
  4694. <term>Type</term>
  4695. <term>Description</term>
  4696. <term>Required</term>
  4697. </listheader>
  4698. <item>
  4699. <term>type</term>
  4700. <term>msi:MSISequenceTable</term>
  4701. <term>Valid inputs:
  4702. <list type="bullet">
  4703. <item><c>installexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/installexecutesequence_table.asp">InstallExecuteSequence Table</a>.</item>
  4704. <item><c>installui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/installuisequence_table.asp">InstallUISequence Table</a></item>
  4705. <item><c>adminexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/adminexecutesequence_table.asp">AdminExecuteSequence Table</a></item>
  4706. <item><c>adminui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/adminuisequence_table.asp">AdminUISequence Table</a></item>
  4707. <item><c>advtexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/advtuisequence_table.asp">AdvtUISequence Table</a></item>
  4708. </list>
  4709. </term>
  4710. <term>True</term>
  4711. </item>
  4712. <item>
  4713. <term>action</term>
  4714. <term>string</term>
  4715. <term>Name of the action to execute. This is either a built-in action or a custom action.</term>
  4716. <term>True</term>
  4717. </item>
  4718. <item>
  4719. <term>value</term>
  4720. <term>int</term>
  4721. <term>Number that determines the sequence position in which this action is to be executed. <br/>
  4722. A positive value represents the sequence position. A Null value indicates that the action is not executed. The following
  4723. negative values indicate that this action is to be executed if the installer returns the associated termination flag. No
  4724. more than one action may have a negative value entered in the Sequence field.
  4725. <list type="table">
  4726. <listheader>
  4727. <term>Value</term>
  4728. <description>Description</description>
  4729. </listheader>
  4730. <item>
  4731. <term>-1</term>
  4732. <description>Successful completion.</description>
  4733. </item>
  4734. <item>
  4735. <term>-2</term>
  4736. <description>User terminates install.</description>
  4737. </item>
  4738. <item>
  4739. <term>-3</term>
  4740. <description>Fatal exit terminates.</description>
  4741. </item>
  4742. <item>
  4743. <term>-4</term>
  4744. <description>Install is suspended.</description>
  4745. </item>
  4746. </list>
  4747. </term>
  4748. <term>True</term>
  4749. </item>
  4750. <item>
  4751. <term>condition</term>
  4752. <term>string</term>
  4753. <term>This field contains a conditional expression. If the expression evaluates to False, then the action is skipped. If the expression syntax is invalid, then the sequence terminates, returning iesBadActionData. </term>
  4754. <term>False</term>
  4755. </item>
  4756. </list>
  4757. <h3>Examples</h3>
  4758. <example>
  4759. <para>Add the sequences to support virtual directories</para>
  4760. <code>
  4761. &lt;sequences&gt;
  4762. &lt;sequence type="installexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&amp;quot;&amp;quot;" /&gt;
  4763. &lt;sequence type="installexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&amp;quot;&amp;quot;" /&gt;
  4764. &lt;sequence type="installexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /&gt;
  4765. &lt;sequence type="installexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /&gt;
  4766. &lt;sequence type="installexecute" action="WEBCA_GatherWebFolderProperties" value="3701" condition="NOT Installed" /&gt;
  4767. &lt;sequence type="installexecute" action="WEBCA_ApplyWebFolderProperties" value="3701" condition="NOT Installed" /&gt;
  4768. &lt;sequence type="installexecute" action="WEBCA_RollbackApplyWebFolderProperties" value="3701" condition="NOT Installed" /&gt;
  4769. &lt;sequence type="installexecute" action="WEBCA_CreateAppRoots" value="3701" condition="NOT Installed" /&gt;
  4770. &lt;sequence type="installui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&amp;quot;&amp;quot;" /&gt;
  4771. &lt;sequence type="installui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&amp;quot;&amp;quot;" /&gt;
  4772. &lt;sequence type="installui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /&gt;
  4773. &lt;sequence type="installui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /&gt;
  4774. &lt;sequence type="adminexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&amp;quot;&amp;quot;" /&gt;
  4775. &lt;sequence type="adminexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&amp;quot;&amp;quot;" /&gt;
  4776. &lt;sequence type="adminexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /&gt;
  4777. &lt;sequence type="adminexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /&gt;
  4778. &lt;sequence type="adminui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&amp;quot;&amp;quot;" /&gt;
  4779. &lt;sequence type="adminui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&amp;quot;&amp;quot;" /&gt;
  4780. &lt;sequence type="adminui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /&gt;
  4781. &lt;sequence type="adminui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /&gt;
  4782. &lt;/sequences&gt;
  4783. </code>
  4784. </example>
  4785. </summary>
  4786. </member>
  4787. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerActionTextElement">
  4788. <summary>
  4789. <para>
  4790. Creates text to be displayed in a progress dialog box and written
  4791. to the log for actions that take a long time to execute. The text
  4792. displayed consists of the action description and optionally formatted
  4793. data from the action. The entries in the ActionText table typically
  4794. refer to actions in sequence tables.
  4795. </para>
  4796. <h3>Parameters</h3>
  4797. <list type="table">
  4798. <listheader>
  4799. <term>Attribute</term>
  4800. <term>Type</term>
  4801. <term>Description</term>
  4802. <term>Required</term>
  4803. </listheader>
  4804. <item>
  4805. <term>name</term>
  4806. <term>string</term>
  4807. <term>Unique name identifying the action.</term>
  4808. <term>True</term>
  4809. </item>
  4810. <item>
  4811. <term>template</term>
  4812. <term>string</term>
  4813. <term>A localized format template is used to format action data records for display during action execution. If no template is supplied, then the action data will not be displayed.</term>
  4814. <term>False</term>
  4815. </item>
  4816. </list>
  4817. <h3>Nested Elements:</h3>
  4818. <h4>&lt;description&gt;</h4>
  4819. <ul>
  4820. Localized description displayed in the progress dialog box or written to the log when the action is executing.
  4821. </ul>
  4822. <h4>&lt;/description&gt;</h4>
  4823. <h3>Examples</h3>
  4824. <example>
  4825. <para>Add the related action text for the web folder actions.</para>
  4826. <code>
  4827. &lt;actiontext&gt;
  4828. &lt;action name="WEBCA_GatherWebFolderProperties" &gt;
  4829. &lt;description&gt;Gathering web folder properties&lt;/description&gt;
  4830. &lt;/action&gt;
  4831. &lt;action name="WEBCA_ApplyWebFolderProperties" &gt;
  4832. &lt;description&gt;Applying web folder properties&lt;/description&gt;
  4833. &lt;/action&gt;
  4834. &lt;action name="WEBCA_RollbackApplyWebFolderProperties" &gt;
  4835. &lt;description&gt;Removing web folder properties&lt;/description&gt;
  4836. &lt;/action&gt;
  4837. &lt;action name="WEBCA_CreateURLs" &gt;
  4838. &lt;description&gt;Creating URLs&lt;/description&gt;
  4839. &lt;/action&gt;
  4840. &lt;action name="WEBCA_EvaluateURLs" &gt;
  4841. &lt;description&gt;Evaluating URLs&lt;/description&gt;
  4842. &lt;/action&gt;
  4843. &lt;action name="WEBCA_EvaluateURLsNoFail" &gt;
  4844. &lt;description&gt;Evaluating URLs and do not fail if URL is invalid&lt;/description&gt;
  4845. &lt;/action&gt;
  4846. &lt;action name="WEBCA_EvaluateURLsMB" &gt;
  4847. &lt;description&gt;Evaluating URLs&lt;/description&gt;
  4848. &lt;/action&gt;
  4849. &lt;action name="WEBCA_CreateAppRoots" &gt;
  4850. &lt;description&gt;Creating application roots&lt;/description&gt;
  4851. &lt;/action&gt;
  4852. &lt;action name="WEBCA_TARGETVDIR" &gt;
  4853. &lt;description&gt;Set TARGETVDIR property to the specified virtual dir&lt;/description&gt;
  4854. &lt;/action&gt;
  4855. &lt;action name="WEBCA_TARGETPORT" &gt;
  4856. &lt;description&gt;Set TARGETPORT property to the specified virtual dir port&lt;/description&gt;
  4857. &lt;/action&gt;
  4858. &lt;/actiontext&gt;
  4859. </code>
  4860. </example>
  4861. </summary>
  4862. </member>
  4863. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerAppMappingsElement">
  4864. <summary>
  4865. <para>
  4866. Adds Verbs and a handler for the specified file type.
  4867. </para>
  4868. <note>This not an officially Microsoft supported table.</note>
  4869. <h3>Parameters</h3>
  4870. <list type="table">
  4871. <listheader>
  4872. <term>Attribute</term>
  4873. <term>Type</term>
  4874. <term>Description</term>
  4875. <term>Required</term>
  4876. </listheader>
  4877. <item>
  4878. <term>directory</term>
  4879. <term>string</term>
  4880. <term>Refrence to a directory. The directory to add the specific verb/handler to IIS for the specified file type.</term>
  4881. <term>True</term>
  4882. </item>
  4883. <item>
  4884. <term>extension</term>
  4885. <term>string</term>
  4886. <term>File name extension to specifically handle</term>
  4887. <term>False</term>
  4888. </item>
  4889. <item>
  4890. <term>exepath</term>
  4891. <term>string</term>
  4892. <term>Path to the Internet Server API (ISAPI) or Common Gateway Interface (CGI) program to run to process a request.</term>
  4893. <term>False</term>
  4894. </item>
  4895. <item>
  4896. <term>verbs</term>
  4897. <term>string</term>
  4898. <term>Internet Information Services verbs that are allowed for the executable file. Only verbs entered in this field will be allowed.</term>
  4899. <term>False</term>
  4900. </item>
  4901. </list>
  4902. <h3>Examples</h3>
  4903. <example>
  4904. <para>Add the aspx app mapping</para>
  4905. <code>
  4906. &lt;appmappings&gt;
  4907. &lt;appmapping directory="D__ACME_MyProduct" extension=".aspx" exepath="[DOTNETFOLDER]aspnet_isapi.dll" verbs="GET,HEAD,POST,DEBUG" /&gt;
  4908. &lt;/appmappings&gt;
  4909. </code>
  4910. </example>
  4911. </summary>
  4912. </member>
  4913. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerUrlPropertiesElement">
  4914. <summary>
  4915. <para>
  4916. Determines the local path equivalent for a url and stores this
  4917. information in a property.
  4918. </para>
  4919. <note>This not an officially Microsoft supported table.</note>
  4920. <h3>Parameters</h3>
  4921. <list type="table">
  4922. <listheader>
  4923. <term>Attribute</term>
  4924. <term>Type</term>
  4925. <term>Description</term>
  4926. <term>Required</term>
  4927. </listheader>
  4928. <item>
  4929. <term>name</term>
  4930. <term>string</term>
  4931. <term>The name of the URLProperty to convert</term>
  4932. <term>True</term>
  4933. </item>
  4934. <item>
  4935. <term>property</term>
  4936. <term>string</term>
  4937. <term>The name of the property to store the directory information.</term>
  4938. <term>True</term>
  4939. </item>
  4940. </list>
  4941. <h3>Examples</h3>
  4942. <example>
  4943. <para>Convert the TARGETURL property to a directory and store that information in TARGETDIR</para>
  4944. <code>
  4945. &lt;urlproperties&gt;
  4946. &lt;urlproperty name="TARGETURL" property="TARGETDIR" /&gt;
  4947. &lt;/urlproperties&gt;
  4948. </code>
  4949. </example>
  4950. </summary>
  4951. </member>
  4952. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerVDirPropertiesElement">
  4953. <summary>
  4954. <para>
  4955. Creates a URLProperty representing the virtual directory and port.
  4956. </para>
  4957. <note>This not an officially Microsoft supported table.</note>
  4958. <h3>Parameters</h3>
  4959. <list type="table">
  4960. <listheader>
  4961. <term>Attribute</term>
  4962. <term>Type</term>
  4963. <term>Description</term>
  4964. <term>Required</term>
  4965. </listheader>
  4966. <item>
  4967. <term>name</term>
  4968. <term>string</term>
  4969. <term>Property containing the virtual directory</term>
  4970. <term>True</term>
  4971. </item>
  4972. <item>
  4973. <term>portproperty</term>
  4974. <term>string</term>
  4975. <term>Property containing the network port number to use.</term>
  4976. <term>True</term>
  4977. </item>
  4978. <item>
  4979. <term>urlproperty</term>
  4980. <term>string</term>
  4981. <term>URLProperty to store the url in</term>
  4982. <term>True</term>
  4983. </item>
  4984. </list>
  4985. <h3>Examples</h3>
  4986. <example>
  4987. <para>Convert the virtual directory and port to a url and store the value in a property.</para>
  4988. <code>
  4989. &lt;vdirproperties&gt;
  4990. &lt;vdirproperty name="TARGETVDIR" portproperty="TARGETPORT" urlproperty="TARGETURL" /&gt;
  4991. &lt;/vdirproperties&gt;
  4992. </code>
  4993. </example>
  4994. </summary>
  4995. </member>
  4996. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerAppRootsElement">
  4997. <summary>
  4998. <para>
  4999. Create a Web application definition and marks it as running in-process
  5000. or out-of-process. If an application already exists at the specified
  5001. path, you can use this method to reconfigure the application from
  5002. in-process to out-of-process, or the reverse.
  5003. </para>
  5004. <note>This not an officially Microsoft supported table.</note>
  5005. <h3>Parameters</h3>
  5006. <list type="table">
  5007. <listheader>
  5008. <term>Attribute</term>
  5009. <term>Type</term>
  5010. <term>Description</term>
  5011. <term>Required</term>
  5012. </listheader>
  5013. <item>
  5014. <term>component</term>
  5015. <term>string</term>
  5016. <term>Reference to a component. Determines when the approot will be created.</term>
  5017. <term>True</term>
  5018. </item>
  5019. <item>
  5020. <term>urlproperty</term>
  5021. <term>string</term>
  5022. <term>URLProperty with stored url</term>
  5023. <term>True</term>
  5024. </item>
  5025. <item>
  5026. <term>inprocflag</term>
  5027. <term>int</term>
  5028. <term>Specifies whether the application being created is to run in-process (0), out-of-process (1), or in a pooled process (2). If the application already exists and is running, changing the value of this flag will cause the application definition to be deleted and a new application created to run in the specified process space.</term>
  5029. <term>True</term>
  5030. </item>
  5031. </list>
  5032. <h3>Examples</h3>
  5033. <example>
  5034. <para>Convert the virtual directory and port to a url and store the value in a property.</para>
  5035. <code>
  5036. &lt;approots&gt;
  5037. &lt;approot component="C__MainFiles" urlproperty="TARGETURL" inprocflag="2" /&gt;
  5038. &lt;/approots&gt;
  5039. </code>
  5040. </example>
  5041. </summary>
  5042. </member>
  5043. <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerIISPropertiesElement">
  5044. <summary>
  5045. <para>
  5046. Specifies directory security in IIS. Can also configure the default
  5047. documents supported by each directory.
  5048. </para>
  5049. <note>This not an officially Microsoft supported table.</note>
  5050. <h3>Parameters</h3>
  5051. <list type="table">
  5052. <listheader>
  5053. <term>Attribute</term>
  5054. <term>Type</term>
  5055. <term>Description</term>
  5056. <term>Required</term>
  5057. </listheader>
  5058. <item>
  5059. <term>directory</term>
  5060. <term>string</term>
  5061. <term>Reference to a directory. This is the directory that gets modified with the specific attributes.</term>
  5062. <term>True</term>
  5063. </item>
  5064. <item>
  5065. <term>attr</term>
  5066. <term>int</term>
  5067. <term>Attributes to set for the directory.
  5068. <list type="table">
  5069. <listheader>
  5070. <term>Value</term>
  5071. <term>Flag Name</term>
  5072. <description>Description</description>
  5073. </listheader>
  5074. <item>
  5075. <term>1</term>
  5076. <term>AccessRead</term>
  5077. <description>The file or the contents of the folder may be read through Microsoft Internet Explorer.</description>
  5078. </item>
  5079. <item>
  5080. <term>2</term>
  5081. <term>AccessWrite</term>
  5082. <description>Users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. Write can be implemented only with a browser that supports the PUT feature of the HTTP 1.1 protocol standard.</description>
  5083. </item>
  5084. <item>
  5085. <term>4</term>
  5086. <term>AccessExecute</term>
  5087. <description>The file or the contents of the folder may be executed, regardless of file type.</description>
  5088. </item>
  5089. <item>
  5090. <term>8</term>
  5091. <term>AccessSSL</term>
  5092. <description>File access requires SSL file permission processing, with or without a client certificate.</description>
  5093. </item>
  5094. <item>
  5095. <term>16</term>
  5096. <term>AccessSource</term>
  5097. <description>Users are allowed to access source code if either Read or Write permissions are set. Source code includes scripts in Microsoft ® Active Server Pages (ASP) applications.</description>
  5098. </item>
  5099. <item>
  5100. <term>32</term>
  5101. <term>AccessSSLNegotiateCert</term>
  5102. <description>SSL file access processing requests a certificate from the client. A value of false indicates that access continues if the client does not have a certificate. Some versions of Internet Explorer will close the connection if the server requests a certificate and a certificate is not available (even if AccessSSLRequireCert is also set to true).</description>
  5103. </item>
  5104. <item>
  5105. <term>64</term>
  5106. <term>AccessSSLRequireCert</term>
  5107. <description>SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. AccessSSLNegotiateCert must also be set to true when using AccessSSLRequireCert.</description>
  5108. </item>
  5109. <item>
  5110. <term>128</term>
  5111. <term>AccessSSLMapCert</term>
  5112. <description>SSL file permission processing maps a client certificate to a Microsoft Windows ® operating system user-account. The AccessSSLNegotiateCert property must also be set to true for the mapping to occur.</description>
  5113. </item>
  5114. <item>
  5115. <term>256</term>
  5116. <term>AccessSSL128</term>
  5117. <description>File access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate.</description>
  5118. </item>
  5119. <item>
  5120. <term>512</term>
  5121. <term>AccessScript</term>
  5122. <description>The file or the contents of the folder may be executed if they are script files or static content. A value of false only allows static files, such as HTML files, to be served.</description>
  5123. </item>
  5124. <item>
  5125. <term>1024</term>
  5126. <term>AccessNoRemoteWrite</term>
  5127. <description>Remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests.</description>
  5128. </item>
  5129. <item>
  5130. <term>4096</term>
  5131. <term>AccessNoRemoteRead</term>
  5132. <description>Remote requests to view files are denied; only requests from the same computer as the IIS server succeed if the AccessRead property is set to true. You cannot set AccessNoRemoteRead to false to enable remote requests, and set AccessRead to false to disable local requests.</description>
  5133. </item>
  5134. <item>
  5135. <term>8192</term>
  5136. <term>AccessNoRemoteExecute</term>
  5137. <description>Remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if the AccessExecute property is set to true. You cannot set AccessNoRemoteExecute to false to enable remote requests, and set AccessExecute to false to disable local requests.</description>
  5138. </item>
  5139. <item>
  5140. <term>16384</term>
  5141. <term>AccessNoRemoteScript</term>
  5142. <description>Requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests.</description>
  5143. </item>
  5144. <item>
  5145. <term>32768</term>
  5146. <term>AccessNoPhysicalDir</term>
  5147. <description>Access to the physical path is not allowed.</description>
  5148. </item>
  5149. </list>
  5150. </term>
  5151. <term>True</term>
  5152. </item>
  5153. <item>
  5154. <term>defaultdoc</term>
  5155. <term>string</term>
  5156. <term>Adds a filename to the <a href="http://msdn.microsoft.com/library/en-us/iissdk/iis/ref_mb_defaultdoc.asp">Default Documents</a> to process. Add multiple separated with a comma (Eg. "Default.aspx,Default.htm")</term>
  5157. <term>False</term>
  5158. </item>
  5159. </list>
  5160. <h3>Examples</h3>
  5161. <example>
  5162. <para>Specify permissions for the directory structure.</para>
  5163. <code>
  5164. &lt;iisproperties&gt;
  5165. &lt;iisproperty directory="TARGETDIR" attr="626" defaultdoc="Default.aspx" /&gt;
  5166. &lt;iisproperty directory="D__BIN" attr="112" /&gt;
  5167. &lt;iisproperty directory="D__SomeSubDir" attr="114" /&gt;
  5168. &lt;/iisproperties&gt;
  5169. </code>
  5170. </example>
  5171. </summary>
  5172. </member>
  5173. <member name="T:NAnt.Contrib.Tasks.Msi.MsiCreationCommand">
  5174. <summary>
  5175. Summary description for MsiTaskInfo.
  5176. </summary>
  5177. </member>
  5178. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadBannerImage(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5179. <summary>
  5180. Loads the banner image.
  5181. </summary>
  5182. <param name="database">The MSI database.</param>
  5183. </member>
  5184. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadBackgroundImage(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5185. <summary>
  5186. Loads the background image.
  5187. </summary>
  5188. <param name="database">The MSI database.</param>
  5189. </member>
  5190. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadLicense(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5191. <summary>
  5192. Loads the license file.
  5193. </summary>
  5194. <param name="database">The MSI database.</param>
  5195. </member>
  5196. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadMedia(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32)">
  5197. <summary>
  5198. Loads records for the Media table.
  5199. </summary>
  5200. <param name="database">The MSI database.</param>
  5201. <param name="LastSequence">The sequence number of the last file in the .cab.</param>
  5202. </member>
  5203. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadFeatures(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5204. <summary>
  5205. Loads records for the Features table.
  5206. </summary>
  5207. <param name="database">The MSI database.</param>
  5208. </member>
  5209. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.AddFeature(NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Schemas.Msi.MSIFeature,System.Int32,System.Int32)">
  5210. <summary>
  5211. Adds a feature record to the Features table.
  5212. </summary>
  5213. <param name="featureTable">The MSI database Feature table.</param>
  5214. <param name="conditionTable">The MSI database Condition table.</param>
  5215. <param name="ParentFeature">The name of this feature's parent.</param>
  5216. <param name="database">The MSI database.</param>
  5217. <param name="Feature">This Feature's Schema element.</param>
  5218. <param name="Depth">The tree depth of this feature.</param>
  5219. <param name="Order">The tree order of this feature.</param>
  5220. </member>
  5221. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadLaunchCondition(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5222. <summary>
  5223. Loads records for the LaunchCondition table
  5224. </summary>
  5225. <param name="database">The MSI database.</param>
  5226. </member>
  5227. <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadMergeModules(System.String,System.String)">
  5228. <summary>
  5229. Merges Merge Modules into the MSI Database.
  5230. </summary>
  5231. <param name="Database">The MSI Database.</param>
  5232. <param name="TempPath">The path to temporary files.</param>
  5233. </member>
  5234. <member name="T:NAnt.Contrib.Tasks.Msi.MsiTask">
  5235. <summary>
  5236. Creates a Windows Installer (also known as Microsoft Installer, or MSI) setup database for installing software on the Windows Platform.
  5237. </summary>
  5238. <remarks>
  5239. <para>
  5240. Requires <c>cabarc.exe</c> in the path. This tool is part of the
  5241. <see href="http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">Microsoft Cabinet SDK</see>.
  5242. </para>
  5243. <para>
  5244. Requires <c>mergemod.dll</c> version 2.0 or greater. This dll is part of the
  5245. <see href="http://www.microsoft.com/msdownload/platformsdk/instmsi.htm">Microsoft Platform SDK</see>.
  5246. </para>
  5247. <para>
  5248. See the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/roadmap_to_windows_installer_documentation.asp?frame=true" >Roadmap to Windows Installer Documentation</see>
  5249. at Microsoft's MSDN website for more information.
  5250. </para>
  5251. </remarks>
  5252. </member>
  5253. <member name="M:NAnt.Contrib.Tasks.Msi.MsiTask.InitializeTask(System.Xml.XmlNode)">
  5254. <summary>
  5255. Initializes task and verifies parameters.
  5256. </summary>
  5257. <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
  5258. </member>
  5259. <member name="M:NAnt.Contrib.Tasks.Msi.MsiTask.ExecuteTask">
  5260. <summary>
  5261. Executes the task.
  5262. </summary>
  5263. </member>
  5264. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiLicense">
  5265. <summary>
  5266. An .rtf (rich text format) file containing the license agreement
  5267. for your software. The contents of this file will be displayed to
  5268. the user when setup runs and must be accepted to continue.
  5269. </summary>
  5270. </member>
  5271. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiBanner">
  5272. <summary>
  5273. A .bmp (bitmap) file 495x60 pixels in size that will be displayed
  5274. as the banner (top) image of the installation user interface.
  5275. </summary>
  5276. </member>
  5277. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiBackground">
  5278. <summary>
  5279. A .bmp (bitmap) file 495x315 pixels in size that will be displayed
  5280. as the background image of the installation user interface.
  5281. </summary>
  5282. </member>
  5283. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiFeaturesElement">
  5284. <summary>
  5285. <para>
  5286. Groups sets of components into named sets, these can be used to
  5287. layout the tree control that allows users to select and deselect
  5288. features of your software product when a custom installation is
  5289. selected at runtime.
  5290. </para>
  5291. <h3>Parameters</h3>
  5292. <list type="table">
  5293. <listheader>
  5294. <term>Attribute</term>
  5295. <term>Type</term>
  5296. <term>Description</term>
  5297. <term>Required</term>
  5298. </listheader>
  5299. <item>
  5300. <term>name</term>
  5301. <term>string</term>
  5302. <term>A name used to refer to the feature.</term>
  5303. <term>True</term>
  5304. </item>
  5305. <item>
  5306. <term>display</term>
  5307. <term>int</term>
  5308. <term>The number in this field specifies the order in which the feature is to be displayed in the user interface.
  5309. The value also determines if the feature is initially displayed expanded or collapsed.<br/>
  5310. If the value is null or zero, the record is not displayed. If the value is odd, the feature node is expanded initially.
  5311. If the value is even, the feature node is collapsed initially.
  5312. </term>
  5313. <term>True</term>
  5314. </item>
  5315. <item>
  5316. <term>title</term>
  5317. <term>string</term>
  5318. <term>Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog.</term>
  5319. <term>False</term>
  5320. </item>
  5321. <item>
  5322. <term>typical</term>
  5323. <term>bool</term>
  5324. <term>Determines if the feature should be included in a "typical" install. This is useful for when the user selects to just install the typical features.</term>
  5325. <term>False</term>
  5326. </item>
  5327. <item>
  5328. <term>directory</term>
  5329. <term>string</term>
  5330. <term>Refrence to a directory. Specify a corresponding directory to go with the feature.</term>
  5331. <term>False</term>
  5332. </item>
  5333. <item>
  5334. <term>attr</term>
  5335. <term>int</term>
  5336. <term>Any combination of the following:
  5337. <list type="table">
  5338. <listheader>
  5339. <term>Value</term>
  5340. <description>Description</description>
  5341. </listheader>
  5342. <item>
  5343. <term>0</term>
  5344. <description>Components of this feature that are not marked for installation from source are installed locally.</description>
  5345. </item>
  5346. <item>
  5347. <term>1</term>
  5348. <description>Components of this feature not marked for local installation are installed to run from the source CD-ROM or server.</description>
  5349. </item>
  5350. <item>
  5351. <term>2</term>
  5352. <description>Set this attribute and the state of the feature is the same as the state of the feature's parent.</description>
  5353. </item>
  5354. <item>
  5355. <term>4</term>
  5356. <description>Set this attribute and the feature state is Advertise.</description>
  5357. </item>
  5358. <item>
  5359. <term>8</term>
  5360. <description>Note that this bit works only with features that are listed by the ADVERTISE property. <br/>Set this attribute to prevent the feature from being advertised.</description>
  5361. </item>
  5362. <item>
  5363. <term>16</term>
  5364. <description>Set this attribute and the user interface does not display an option to change the feature state to Absent. Setting this attribute forces the feature to the installation state, whether or not the feature is visible in the UI.</description>
  5365. </item>
  5366. <item>
  5367. <term>32</term>
  5368. <description>Set this attribute and advertising is disabled for the feature if the operating system shell does not support Windows Installer descriptors.</description>
  5369. </item>
  5370. </list>
  5371. More information found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp</a>
  5372. </term>
  5373. <term>False</term>
  5374. </item>
  5375. </list>
  5376. <h3>Nested Elements:</h3>
  5377. <h4>&lt;feature&gt;</h4>
  5378. <ul>
  5379. Nested feature elements are supported.
  5380. </ul>
  5381. <h4>&lt;/feature&gt;</h4>
  5382. <h4>&lt;description&gt;</h4>
  5383. <ul>
  5384. Longer string of text describing the feature. This localizable string is displayed by the Text control of the Selection Dialog.
  5385. </ul>
  5386. <h4>&lt;/description&gt;</h4>
  5387. <h4>&lt;conditions&gt;</h4>
  5388. <ul>
  5389. <h4>&lt;condition&gt;</h4>
  5390. <ul>
  5391. <list type="table">
  5392. <listheader>
  5393. <term>Attribute</term>
  5394. <term>Type</term>
  5395. <term>Description</term>
  5396. <term>Required</term>
  5397. </listheader>
  5398. <item>
  5399. <term>expression</term>
  5400. <term>string</term>
  5401. <term>If this conditional expression evaluates to TRUE, then the Level column in the Feature table is set to the
  5402. conditional install level. <br/>
  5403. The expression in the Condition column should not contain reference to the installed state of any feature or component.
  5404. This is because the expressions in the Condition column are evaluated before the installer evaluates the installed
  5405. states of features and components. Any expression in the Condition table that attempts to check the installed state
  5406. of a feature or component always evaluates to false.<br/>
  5407. For information on the syntax of conditional statements, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/conditional_statement_syntax.asp">Conditional Statement Syntax</a>.
  5408. </term>
  5409. <term>True</term>
  5410. </item>
  5411. <item>
  5412. <term>level</term>
  5413. <term>int</term>
  5414. <term>The installer sets the install level of this feature to the level specified in this column if the expression in
  5415. the Condition column evaluates to TRUE. Set this value to 0 to have the component not install if the condition is not met.<br/>
  5416. For any installation, there is a defined install level, which is an integral value from 1 to 32,767. The initial value
  5417. is determined by the InstallLevel property, which is set in the Property table.<br/>
  5418. A feature is installed only if the feature level value is less than or equal to the current install level. The user
  5419. interface can be authored such that once the installation is initialized, the installer allows the user to modify the
  5420. install level of any feature in the Feature table. For example, an author can define install level values that represent
  5421. specific installation options, such as Complete, Typical, or Minimum, and then create a dialog box that uses
  5422. SetInstallLevel ControlEvents to enable the user to select one of these states. Depending on the state the user selects,
  5423. the dialog box sets the install level property to the corresponding value. If the author assigns Typical a level of 100
  5424. and the user selects Typical, only those features with a level of 100 or less are installed. In addition, the Custom
  5425. option could lead to another dialog box containing a Selection Tree control. The Selection Tree would then allow the user
  5426. to individually change whether each feature is installed.</term>
  5427. <term>True</term>
  5428. </item>
  5429. </list>
  5430. </ul>
  5431. <h4>&lt;/condition&gt;</h4>
  5432. </ul>
  5433. <h4>&lt;/conditions&gt;</h4>
  5434. <h3>Examples</h3>
  5435. <example>
  5436. <para>Define a sample features structure.</para>
  5437. <code>
  5438. &lt;features&gt;
  5439. &lt;feature name="F__Default" title="My Product" display="1" typical="true" directory="TARGETDIR"&gt;
  5440. &lt;description&gt;My Product from ACME, Inc. &lt;/description&gt;
  5441. &lt;feature name="F__MainFiles" display="0" typical="true" /&gt;
  5442. &lt;/feature&gt;
  5443. &lt;feature name="F__Help" title="My Product Help Files" display="1" typical="false" directory="D__ACME_MyProduct_Help" /&gt;
  5444. &lt;/features&gt;
  5445. </code>
  5446. </example>
  5447. </summary>
  5448. </member>
  5449. <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiMergeModulesElement">
  5450. <summary>
  5451. <para>
  5452. Includes pre-packaged installation components (.msm files) as part
  5453. of the msi database. This feature allows reuse of installation
  5454. components that use MSI technology from other setup vendors or as
  5455. created by the <see cref="T:NAnt.Contrib.Tasks.Msi.MsmTask"/>.
  5456. </para>
  5457. <h3>Parameters</h3>
  5458. <list type="table">
  5459. <listheader>
  5460. <term>Attribute</term>
  5461. <term>Type</term>
  5462. <term>Description</term>
  5463. <term>Required</term>
  5464. </listheader>
  5465. <item>
  5466. <term>feature</term>
  5467. <term>string</term>
  5468. <term>Refrence to a feature. Used to associate the merge module with the feature (and the feature's directory) for when to install the components in the merge module.</term>
  5469. <term>True</term>
  5470. </item>
  5471. </list>
  5472. <h3>Nested Elements:</h3>
  5473. <h4>&lt;modules&gt;</h4>
  5474. <ul>
  5475. Specifies the merge module(s) to include with the specified feature.
  5476. </ul>
  5477. <h4>&lt;/modules&gt;</h4>
  5478. <h4>&lt;configurationitems&gt;</h4>
  5479. <ul>
  5480. <h4>&lt;configurationitem&gt;</h4>
  5481. <ul>
  5482. Specifies the value for a configurable item
  5483. <h3>Parameters</h3>
  5484. <list type="table">
  5485. <listheader>
  5486. <term>Attribute</term>
  5487. <term>Type</term>
  5488. <term>Description</term>
  5489. <term>Required</term>
  5490. </listheader>
  5491. <item>
  5492. <term>module</term>
  5493. <term>string</term>
  5494. <term>Merge module filename to limit the configuration item to. If this is not set, the configuration item will be applied to all merge modules in the fileset.</term>
  5495. <term>True</term>
  5496. </item>
  5497. <item>
  5498. <term>name</term>
  5499. <term>string</term>
  5500. <term>Name of item for which data is to be set</term>
  5501. <term>True</term>
  5502. </item>
  5503. <item>
  5504. <term>value</term>
  5505. <term>string</term>
  5506. <term>Value of the configurable item</term>
  5507. <term>True</term>
  5508. </item>
  5509. </list>
  5510. </ul>
  5511. <h4>&lt;/configurationitem&gt;</h4>
  5512. </ul>
  5513. <h4>&lt;/configurationitems&gt;</h4>
  5514. <h3>Examples</h3>
  5515. <example>
  5516. <para>Add the NAnt merge module to the install.</para>
  5517. <code>
  5518. &lt;mergemodules&gt;
  5519. &lt;merge feature="F__NAntMSM"&gt;
  5520. &lt;modules&gt;
  5521. &lt;include name="${nant.dir}\Install\NAnt.msm" /&gt;
  5522. &lt;/modules&gt;
  5523. &lt;/merge&gt;
  5524. &lt;/mergemodules&gt;
  5525. </code>
  5526. </example>
  5527. <example>
  5528. <para>Add a Visual Studio .wid package (merge module) and specify some configurable items.</para>
  5529. <code>
  5530. &lt;mergemodules&gt;
  5531. &lt;merge feature="F__DefaultFeature"&gt;
  5532. &lt;modules&gt;
  5533. &lt;include name="VsdReadmeDlg.wid" /&gt;
  5534. &lt;/modules&gt;
  5535. &lt;configurationitems&gt;
  5536. &lt;configurationitem name="BannerBitmap" value="CONFIGURED_BANNERBITMAP" /&gt;
  5537. &lt;configurationitem module="VsdReadmeDlg.wid" name="ReadmeText" value="CONFIGURED_READMETEXT" /&gt;
  5538. &lt;/configurationitems&gt;
  5539. &lt;/merge&gt;
  5540. &lt;/mergemodules&gt;
  5541. </code>
  5542. </example>
  5543. </summary>
  5544. </member>
  5545. <member name="T:NAnt.Contrib.Tasks.Msi.MsmCreationCommand">
  5546. <summary>
  5547. Summary description for MsmTaskInfo.
  5548. </summary>
  5549. </member>
  5550. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSignature(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5551. <summary>
  5552. Loads records for the ModuleSignature table.
  5553. </summary>
  5554. <param name="database">The MSM database.</param>
  5555. </member>
  5556. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleDependency(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5557. <summary>
  5558. Loads records for the ModuleDependency table.
  5559. </summary>
  5560. <param name="database">The MSM database.</param>
  5561. </member>
  5562. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleExclusion(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5563. <summary>
  5564. Loads records for the ModuleExclusion table.
  5565. </summary>
  5566. <param name="database">The MSM database.</param>
  5567. </member>
  5568. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSequence(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5569. <summary>
  5570. Loads records for the ModuleInstallUISequence, ModuleInstallExecuteSequence,
  5571. ModuleAdminUISequence, ModuleAdminExecute, and ModuleAdvtExecuteSequence tables.
  5572. </summary>
  5573. <param name="database">The MSM database.</param>
  5574. </member>
  5575. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleIgnoreTable(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5576. <summary>
  5577. Loads records for the ModuleIgnoreTable table.
  5578. </summary>
  5579. <param name="database">The MSM database.</param>
  5580. </member>
  5581. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSubstitution(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5582. <summary>
  5583. Loads records for the ModuleSubstitution table.
  5584. </summary>
  5585. <param name="database">The MSM database.</param>
  5586. </member>
  5587. <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleConfiguration(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
  5588. <summary>
  5589. Loads records for the ModuleConfiguration table.
  5590. </summary>
  5591. <param name="database">The MSM database.</param>
  5592. </member>
  5593. <member name="T:NAnt.Contrib.Tasks.Msi.MsmTask">
  5594. <summary>
  5595. Builds a Windows Installer Merge Module (MSM) database.
  5596. </summary>
  5597. <para>
  5598. Requires <c>cabarc.exe</c> in the path. This tool is part of the
  5599. <see href="http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">Microsoft Cabinet SDK</see>.
  5600. </para>
  5601. </member>
  5602. <member name="M:NAnt.Contrib.Tasks.Msi.MsmTask.InitializeTask(System.Xml.XmlNode)">
  5603. <summary>
  5604. Initializes task and verifies parameters.
  5605. </summary>
  5606. <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
  5607. </member>
  5608. <member name="M:NAnt.Contrib.Tasks.Msi.MsmTask.ExecuteTask">
  5609. <summary>
  5610. Executes the task.
  5611. </summary>
  5612. </member>
  5613. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmId">
  5614. <summary>
  5615. Stores a unique identifier for a merge module. To be used as the merge module's ModuleSignature
  5616. </summary>
  5617. </member>
  5618. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmLanguage">
  5619. <summary>
  5620. Specifies the numeric language ID or IDs for a merge module.
  5621. </summary>
  5622. </member>
  5623. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmVersion">
  5624. <summary>
  5625. Stores the version number of a merge module.
  5626. </summary>
  5627. </member>
  5628. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleDependenciesElement">
  5629. <summary>
  5630. <para>
  5631. Lists other merge modules that are required for this merge module
  5632. to operate properly.
  5633. </para>
  5634. <para>
  5635. Contains any number of dependency elements.
  5636. </para>
  5637. <para>
  5638. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduledependency_table.asp">here</see>.
  5639. </para>
  5640. <h3>Parameters</h3>
  5641. <list type="table">
  5642. <listheader>
  5643. <term>Attribute</term>
  5644. <term>Type</term>
  5645. <term>Description</term>
  5646. <term>Required</term>
  5647. </listheader>
  5648. <item>
  5649. <term>id</term>
  5650. <term>string</term>
  5651. <term>Identifier of the merge module required</term>
  5652. <term>True</term>
  5653. </item>
  5654. <item>
  5655. <term>language</term>
  5656. <term>string</term>
  5657. <term>Numeric language ID of the dependent merge module. Can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. If the field contains a group language ID, any merge module with having a language code in that group satisfies the dependency. If the RequiredLanguage is set to 0, any merge module filling the other requirements satisfies the dependency.</term>
  5658. <term>True</term>
  5659. </item>
  5660. <item>
  5661. <term>version</term>
  5662. <term>string</term>
  5663. <term>Version of the dependent merge module. If ommited, any version fills the dependency.</term>
  5664. <term>False</term>
  5665. </item>
  5666. </list>
  5667. <h3>Examples</h3>
  5668. <example>
  5669. <para>Make sure that the NAnt merge module is included</para>
  5670. <code>
  5671. &lt;moduledependencies&gt;
  5672. &lt;dependency id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" /&gt;
  5673. &lt;/moduledependencies&gt;
  5674. </code>
  5675. </example>
  5676. </summary>
  5677. </member>
  5678. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleExclusionsElement">
  5679. <summary>
  5680. <para>
  5681. Lists other merge modules that are incompatible in the same
  5682. installer database.
  5683. </para>
  5684. <para>
  5685. Contains any number of exclusion elements.
  5686. </para>
  5687. <para>
  5688. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleexclusion_table.asp">here</see>.
  5689. </para>
  5690. <h3>Parameters</h3>
  5691. <list type="table">
  5692. <listheader>
  5693. <term>Attribute</term>
  5694. <term>Type</term>
  5695. <term>Description</term>
  5696. <term>Required</term>
  5697. </listheader>
  5698. <item>
  5699. <term>id</term>
  5700. <term>string</term>
  5701. <term>Identifier of the merge module required</term>
  5702. <term>True</term>
  5703. </item>
  5704. <item>
  5705. <term>language</term>
  5706. <term>string</term>
  5707. <term>Numeric language ID of the merge module in ExcludedID. The ExcludedLanguage column can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. The ExcludedLanguage column can accept negative language IDs. The meaning of the value in the ExcludedLanguage column is as follows.
  5708. <list type="table">
  5709. <listheader>
  5710. <term>ExcludedLanguage</term>
  5711. <description>Description</description>
  5712. </listheader>
  5713. <item>
  5714. <term>&gt; 0</term>
  5715. <description>Exclude the language IDs specified by ExcludedLanguage.</description>
  5716. </item>
  5717. <item>
  5718. <term>= 0</term>
  5719. <description>Exclude no language IDs.</description>
  5720. </item>
  5721. <item>
  5722. <term>&lt; 0</term>
  5723. <description>Exclude all language IDs except those specified by ExcludedLanguage.</description>
  5724. </item>
  5725. </list>
  5726. </term>
  5727. <term>True</term>
  5728. </item>
  5729. <item>
  5730. <term>minversion</term>
  5731. <term>string</term>
  5732. <term>Minimum version excluded from a range. If ommitted, all versions before maxversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version.</term>
  5733. <term>False</term>
  5734. </item>
  5735. <item>
  5736. <term>maxversion</term>
  5737. <term>string</term>
  5738. <term>Maximum version excluded from a range. If ommitted, all versions after minversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version.</term>
  5739. <term>False</term>
  5740. </item>
  5741. </list>
  5742. <h3>Examples</h3>
  5743. <example>
  5744. <para>Exclude the all NAnt merge modules created before version 0.85.0</para>
  5745. <code>
  5746. &lt;moduleexclusions&gt;
  5747. &lt;exclusion id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" maxversion="0.85.0" /&gt;
  5748. &lt;/moduleexclusions&gt;
  5749. </code>
  5750. </example>
  5751. </summary>
  5752. </member>
  5753. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleSequencesElement">
  5754. <summary>
  5755. <para>
  5756. Used to modify the sequence of tasks/events that execute during the
  5757. overall installation process.
  5758. </para>
  5759. <h3>Parameters</h3>
  5760. <list type="table">
  5761. <listheader>
  5762. <term>Attribute</term>
  5763. <term>Type</term>
  5764. <term>Description</term>
  5765. <term>Required</term>
  5766. </listheader>
  5767. <item>
  5768. <term>type</term>
  5769. <term>msi:MSISequenceTable</term>
  5770. <term>Valid inputs:
  5771. <list type="bullet">
  5772. <item><c>installexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleinstallexecutesequence_table.asp">ModuleInstallExecuteSequence Table</a>.</item>
  5773. <item><c>installui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleinstalluisequence_table.asp">ModuleInstallUISequence Table</a></item>
  5774. <item><c>adminexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadminexecutesequence_table.asp">ModuleAdminExecuteSequence Table</a></item>
  5775. <item><c>adminui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadminuisequence_table.asp">ModuleAdminUISequence Table</a></item>
  5776. <item><c>advtexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadvtuisequence_table.asp">ModuleAdvtUISequence Table</a></item>
  5777. </list>
  5778. </term>
  5779. <term>True</term>
  5780. </item>
  5781. <item>
  5782. <term>action</term>
  5783. <term>string</term>
  5784. <term>Action to insert into sequence. Refers to one of the installer standard actions, or an entry in the merge module's CustomAction table or Dialog table.<br/>If a standard action is used in the Action column of a merge module sequence table, the BaseAction and After attributes must be ommitted.</term>
  5785. <term>True</term>
  5786. </item>
  5787. <item>
  5788. <term>sequence</term>
  5789. <term>int</term>
  5790. <term>The sequence number of a standard action. If a custom action or dialog is entered into the Action column of this row, this attribute must be ommitted <br/>When using standard actions in merge module sequence tables, the value in the Sequence column should be the recommended action sequence number. If the sequence number in the merge module differs from that for the same action in the .msi file sequence table, the merge tool uses the sequence number from the .msi file. See the suggested sequences in Using a Sequence Table for the recommended sequence numbers of standard actions.</term>
  5791. <term>False</term>
  5792. </item>
  5793. <item>
  5794. <term>baseaction</term>
  5795. <term>string</term>
  5796. <term>Can contain a standard action, a custom action specified in the merge module's custom action table, or a dialog specified in the module's dialog table. Is a key into the Action column of this table. It cannot be a foreign key into another merge table or table in the .msi file. This means that every standard action, custom action, or dialog listed in the BaseAction column must also be listed in the Action column of another record in this table.</term>
  5797. <term>False</term>
  5798. </item>
  5799. <item>
  5800. <term>after</term>
  5801. <term>bool</term>
  5802. <term>Boolean for whether Action comes before or after BaseAction
  5803. <list type="table">
  5804. <listheader>
  5805. <term>Value</term>
  5806. <description>Description</description>
  5807. </listheader>
  5808. <item>
  5809. <term>True</term>
  5810. <description>Action to come after BaseAction</description>
  5811. </item>
  5812. <item>
  5813. <term>False</term>
  5814. <description>Action to come before BaseAction</description>
  5815. </item>
  5816. </list>
  5817. </term>
  5818. <term>False</term>
  5819. </item>
  5820. <item>
  5821. <term>condition</term>
  5822. <term>string</term>
  5823. <term>A conditional statement that indicates if the action is be executed.</term>
  5824. <term>False</term>
  5825. </item>
  5826. </list>
  5827. </summary>
  5828. </member>
  5829. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleIgnoreTablesElement">
  5830. <summary>
  5831. <para>
  5832. If a table in the merge module is listed in the ModuleIgnoreTable
  5833. table, it is not merged into the .msi file. If the table already
  5834. exists in the .msi file, it is not modified by the merge. The tables
  5835. in the ModuleIgnoreTable can therefore contain data that is unneeded
  5836. after the merge.
  5837. </para>
  5838. <para>
  5839. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleignoretable_table.asp?frame=true">here</see>.
  5840. </para>
  5841. <h3>Parameters</h3>
  5842. <list type="table">
  5843. <listheader>
  5844. <term>Attribute</term>
  5845. <term>Type</term>
  5846. <term>Description</term>
  5847. <term>Required</term>
  5848. </listheader>
  5849. <item>
  5850. <term>table</term>
  5851. <term>string</term>
  5852. <term>Name of the table in the merge module that is not to be merged into the .msi file.</term>
  5853. <term>True</term>
  5854. </item>
  5855. </list>
  5856. <h3>Examples</h3>
  5857. <example>
  5858. <para>Ensure the module is compatible for users who have versions of Mergemod.dll earlier than 2.0</para>
  5859. <code>
  5860. &lt;moduleignoretables&gt;
  5861. &lt;table name="ModuleConfiguration" /&gt;
  5862. &lt;table name="ModuleSubstitution" /&gt;
  5863. &lt;table name="_ModuleConfigurationGroup" /&gt;
  5864. &lt;/moduleignoretables&gt;
  5865. </code>
  5866. </example>
  5867. </summary>
  5868. </member>
  5869. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleSubstitutionsElement">
  5870. <summary>
  5871. <para>
  5872. The ModuleSubstitution table specifies the configurable fields of a
  5873. module database and provides a template for the configuration of each
  5874. field. The user or merge tool may query this table to determine what
  5875. configuration operations are to take place. This table is not merged
  5876. into the target database.
  5877. </para>
  5878. <para>
  5879. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/modulesubstitution_table.asp">here</see>.
  5880. </para>
  5881. <h3>Parameters</h3>
  5882. <list type="table">
  5883. <listheader>
  5884. <term>Attribute</term>
  5885. <term>Type</term>
  5886. <term>Description</term>
  5887. <term>Required</term>
  5888. </listheader>
  5889. <item>
  5890. <term>table</term>
  5891. <term>string</term>
  5892. <term>Name of the table being modified in the module database.</term>
  5893. <term>True</term>
  5894. </item>
  5895. <item>
  5896. <term>row</term>
  5897. <term>string</term>
  5898. <term>Specifies the primary keys of the target row in the table named in the Table column. Multiple primary keys are separated by semicolons. Target rows are selected for modification before any changes are made to the target table. If one record in the ModuleSubstitution table changes the primary key field of a target row, other records in the ModuleSubstitution table are applied based on the original primary key data, not the resulting of primary key substitutions. The order of row substitution is undefined.<br/>Values in this column are always in CMSM special format. A literal semicolon (';') or equal sign ('=') can be added by prefixing the character with a backslash. '\'. A null value for a key is signified by a null, a leading semicolon, two consecutive semicolons, or a trailing semicolon, depending on whether the null value is a sole, first, middle, or final key column value.</term>
  5899. <term>True</term>
  5900. </item>
  5901. <item>
  5902. <term>column</term>
  5903. <term>string</term>
  5904. <term>Specifies the target column in the row named in the Row column. If multiple rows in the ModuleSubstitution table change different columns of the same target row, all the column substitutions are performed before the modified row is inserted into the database. The order of column substitution is undefined.</term>
  5905. <term>True</term>
  5906. </item>
  5907. <item>
  5908. <term>value</term>
  5909. <term>string</term>
  5910. <term>Contains a string that provides a formatting template for the data being substituted into the target field specified by Table, Row, and Column. When a substitution string of the form [=ItemA] is encountered, the string, including the bracket characters, is replaced by the value for the configurable "ItemA." The configurable item "ItemA" is specified in the Name column of the ModuleConfiguration table and its value is provided by the merge tool. If the merge tool declines to provide a value for any item in a replacement string, the default value specified in the DefaultValue column of the ModuleConfiguration Table is substituted. If a string references an item not in the ModuleConfiguration table, the merge fails.
  5911. <list type="bullet">
  5912. <item>
  5913. This column uses CMSM special format. A literal semicolon (';') or equals sign ('=') can be added to the table by prefixing the character with a backslash. '\'.
  5914. </item>
  5915. <item>
  5916. The Value field may contain multiple substitution strings. For example, the configuration of items "Food1" and "Food2" in the string: "[=Food1] is good, but [=Food2] is better because [=Food2] is more nutritious."
  5917. </item>
  5918. <item>
  5919. Replacement strings must not be nested. The template "[=AB[=CDE]]" is invalid.
  5920. </item>
  5921. <item>
  5922. If the Value field evaluates to null, and the target field is not nullable, the merge fails and an error object of type msmErrorBadNullSubstitution is created and added to the error list. For details, see the error types described in get_Type Function.
  5923. </item>
  5924. <item>
  5925. If the Value field evaluates to the null GUID: {00000000-0000-0000-0000-000000000000}, the null GUID is replaced by the name of the feature before the row is merged into the module. For details, see Referencing Features in Merge Modules.
  5926. </item>
  5927. <item>
  5928. The template in the Value field is evaluated before being inserted into the target field. Substitution into a row is done before replacing any features.
  5929. </item>
  5930. <item>
  5931. If the Value column evaluates to a string of only integer characters (with an optional + or -), the string is converted into an integer before being substituted into an target field of the Integer Format Type. If the template evaluates to a string that does not consist only of integer characters (and an optional + or -) the result cannot be substituted into an integer target field. Attempting to insert a non-integer into an integer field causes the merge to fail and adds a msmErrorBadSubstitutionType error object to the error list.
  5932. </item>
  5933. <item>
  5934. If the target column specified in the Table and Column fields is a Text Format Type, and evaluation of the Value field results in an Integer Format Type, a decimal representation of the number is inserted into the target text field.
  5935. </item>
  5936. <item>
  5937. If the target field is an Integer Format Type, and the Value field consists of a non-delimited list of items in Bitfield Format, the value in the target field is combined using the bitwise AND operator with the inverse of the bitwise OR of all of the mask values from the items, then combined using the bitwise OR operator with each of the integer or bitfield items when masked by their corresponding mask values. Essentially, this explicitly sets the bits from the properties to the provided values but leaves all other bits in the cell alone.
  5938. </item>
  5939. <item>
  5940. If the Value field evaluates to a Key Format Type, and is a key into a table that uses multiple primary keys, the item name may be followed by a semicolon and an integer value that indicates the 1-based index into the set of values that together make a primary key. If no integer is specified, the value 1 is used. For example, the Control table has two primary key columns, Dialog_ and Control. The value of an item "Item1" that is a key into the Control table will be of the form "DialogName;ControlName", where DialogName is the value in the Dialog_ table and ControlName is the value in the Control column. To substitute just ControlName, the substitution string [=Item1;2] should be used.
  5941. </item>
  5942. </list>
  5943. </term>
  5944. <term>False</term>
  5945. </item>
  5946. </list>
  5947. </summary>
  5948. </member>
  5949. <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleConfigurationsElement">
  5950. <summary>
  5951. <para>
  5952. Identifies the configurable attributes of the module. This table is
  5953. not merged into the database.
  5954. </para>
  5955. <para>
  5956. More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleconfiguration_table.asp">here</see>.
  5957. </para>
  5958. <h3>Parameters</h3>
  5959. <list type="table">
  5960. <listheader>
  5961. <term>Attribute</term>
  5962. <term>Type</term>
  5963. <term>Description</term>
  5964. <term>Required</term>
  5965. </listheader>
  5966. <item>
  5967. <term>name</term>
  5968. <term>string</term>
  5969. <term>Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table.</term>
  5970. <term>True</term>
  5971. </item>
  5972. <item>
  5973. <term>format</term>
  5974. <term>msi:MSMModuleConfigurationFormat</term>
  5975. <term>Specifies the format of the data being changed
  5976. <list type="bullet">
  5977. <item>text</item>
  5978. <item>key</item>
  5979. <item>integer</item>
  5980. <item>bitfield</item>
  5981. </list>
  5982. </term>
  5983. <term>True</term>
  5984. </item>
  5985. <item>
  5986. <term>type</term>
  5987. <term>string</term>
  5988. <term>Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute.</term>
  5989. <term>False</term>
  5990. </item>
  5991. <item>
  5992. <term>contextdata</term>
  5993. <term>string</term>
  5994. <term>Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes.</term>
  5995. <term>False</term>
  5996. </item>
  5997. <item>
  5998. <term>defaultvalue</term>
  5999. <term>string</term>
  6000. <term>Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally.<br/>Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state.</term>
  6001. <term>False</term>
  6002. </item>
  6003. <item>
  6004. <term>attr</term>
  6005. <term>int</term>
  6006. <term>Bit field containing attributes for this configurable item. Null is equivalent to 0.
  6007. <list type="table">
  6008. <listheader>
  6009. <term>Value</term>
  6010. <description>Description</description>
  6011. </listheader>
  6012. <item>
  6013. <term>1</term>
  6014. <description>This attribute only applies to records that list a foreign key to a module table in their DefaultValue field.</description>
  6015. </item>
  6016. <item>
  6017. <term>2</term>
  6018. <description>When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types.</description>
  6019. </item>
  6020. </list>
  6021. </term>
  6022. <term>False</term>
  6023. </item>
  6024. <item>
  6025. <term>displayname</term>
  6026. <term>string</term>
  6027. <term>Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI.</term>
  6028. <term>False</term>
  6029. </item>
  6030. <item>
  6031. <term>description</term>
  6032. <term>string</term>
  6033. <term>Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform.</term>
  6034. <term>False</term>
  6035. </item>
  6036. <item>
  6037. <term>helplocation</term>
  6038. <term>string</term>
  6039. <term>Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available.</term>
  6040. <term>False</term>
  6041. </item>
  6042. <item>
  6043. <term>helpkeyword</term>
  6044. <term>string</term>
  6045. <term>Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute.</term>
  6046. <term>False</term>
  6047. </item>
  6048. </list>
  6049. </summary>
  6050. </member>
  6051. <member name="T:NAnt.Contrib.Tasks.Msi.TypeLibRecord">
  6052. <summary>
  6053. Maintains a forward reference to a .tlb file
  6054. in the same directory as an assembly .dll
  6055. that has been registered for COM interop.
  6056. </summary>
  6057. </member>
  6058. <member name="M:NAnt.Contrib.Tasks.Msi.TypeLibRecord.#ctor(System.String,System.String,System.Reflection.AssemblyName,System.String,System.String)">
  6059. <summary>
  6060. Creates a new <see cref="T:NAnt.Contrib.Tasks.Msi.TypeLibRecord"/>.
  6061. </summary>
  6062. <param name="LibId">The typelibrary id.</param>
  6063. <param name="TypeLibFileName">The typelibrary filename.</param>
  6064. <param name="AssemblyName">The name of the assembly.</param>
  6065. <param name="FeatureName">The feature containing the typelibrary's file.</param>
  6066. <param name="AssemblyComponent">The name of the Assembly's component.</param>
  6067. </member>
  6068. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.AssemblyComponent">
  6069. <summary>
  6070. Retrieves the name of the Assembly's component.
  6071. </summary>
  6072. <value>The Assembly's component Name.</value>
  6073. </member>
  6074. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.TypeLibFileName">
  6075. <summary>
  6076. Retrieves the typelibrary filename.
  6077. </summary>
  6078. <value>The typelibrary filename.</value>
  6079. </member>
  6080. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.LibId">
  6081. <summary>
  6082. Retrieves the typelibrary id.
  6083. </summary>
  6084. <value>The typelibrary id.</value>
  6085. </member>
  6086. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.AssemblyName">
  6087. <summary>
  6088. Retrieves the name of the assembly.
  6089. </summary>
  6090. <value>The name of the assembly.</value>
  6091. </member>
  6092. <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.FeatureName">
  6093. <summary>
  6094. Retrieves the feature containing the typelibrary's file.
  6095. </summary>
  6096. <value>The feature containing the typelibrary's file.</value>
  6097. </member>
  6098. <member name="T:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask">
  6099. <summary>
  6100. A task that generates a summary HTML
  6101. from a set of NUnit xml report files.
  6102. </summary>
  6103. <remarks>
  6104. <para>
  6105. This task can generate a combined HTML report out of a set of NUnit
  6106. result files generated using the XML Result Formatter.
  6107. </para>
  6108. <para>
  6109. All the properties defined in the current project will be passed
  6110. down to the XSLT file as template parameters, so you can access
  6111. properties such as nant.project.name, nant.version, etc.
  6112. </para>
  6113. </remarks>
  6114. <example>
  6115. <code>
  6116. <![CDATA[
  6117. <nunit2report todir="${outputdir}">
  6118. <fileset>
  6119. <includes name="${outputdir}\results.xml" />
  6120. </fileset>
  6121. </nunit2report>
  6122. ]]>
  6123. </code>
  6124. </example>
  6125. </member>
  6126. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.InitializeTask(System.Xml.XmlNode)">
  6127. <summary>
  6128. Initializes task and ensures the supplied attributes are valid.
  6129. </summary>
  6130. <param name="taskNode">Xml node used to define this task instance.</param>
  6131. </member>
  6132. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.ExecuteTask">
  6133. <summary>
  6134. This is where the work is done
  6135. </summary>
  6136. </member>
  6137. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LoadStyleSheet(System.String)">
  6138. <summary>
  6139. Load a stylesheet from the assemblies resource stream.
  6140. </summary>
  6141. <param name="xslFileName">File name of the file to extract.</param>
  6142. </member>
  6143. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LoadStyleSheet(System.IO.FileInfo)">
  6144. <summary>
  6145. Load a stylesheet from the file system.
  6146. </summary>
  6147. <param name="xslFile">The XSLT file to load.</param>
  6148. </member>
  6149. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.CreateSummaryXmlDoc">
  6150. <summary>
  6151. Initializes the XmlDocument instance
  6152. used to summarize the test results
  6153. </summary>
  6154. <returns></returns>
  6155. </member>
  6156. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.GetPropertyList">
  6157. <summary>
  6158. Builds an XsltArgumentList with all
  6159. the properties defined in the
  6160. current project as XSLT parameters.
  6161. </summary>
  6162. <returns></returns>
  6163. </member>
  6164. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Write(System.IO.StringReader,System.String)">
  6165. <summary>
  6166. Run the transform and output to filename
  6167. </summary>
  6168. <param name="stream"></param>
  6169. <param name="fileName"></param>
  6170. </member>
  6171. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Format">
  6172. <summary>
  6173. The format of the generated report. The default is
  6174. <see cref="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.NoFrames"/>.
  6175. </summary>
  6176. </member>
  6177. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Language">
  6178. <summary>
  6179. The output language.
  6180. </summary>
  6181. </member>
  6182. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.OpenDescription">
  6183. <summary>
  6184. Open all description method. Default to "false".
  6185. </summary>
  6186. </member>
  6187. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.ToDir">
  6188. <summary>
  6189. The directory where the files resulting from the transformation
  6190. should be written to. The default is the project's base directory.
  6191. </summary>
  6192. </member>
  6193. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XmlFileSet">
  6194. <summary>
  6195. Set of XML files to use as input
  6196. </summary>
  6197. </member>
  6198. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XmlSummaries">
  6199. <summary>
  6200. Set of summary XML files to use as input.
  6201. </summary>
  6202. </member>
  6203. <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XslFile">
  6204. <summary>
  6205. XSLT file used to generate the report if <see cref="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Format"/> is
  6206. <see cref="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.NoFrames"/>.
  6207. </summary>
  6208. </member>
  6209. <member name="T:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LocalResXmlResolver">
  6210. <summary>
  6211. Custom XmlResolver used to load the
  6212. XSLT files out of this assembly resources.
  6213. </summary>
  6214. </member>
  6215. <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LocalResXmlResolver.GetEntity(System.Uri,System.String,System.Type)">
  6216. <summary>
  6217. Loads the specified file from our internal resources if its there
  6218. </summary>
  6219. <param name="absoluteUri"></param>
  6220. <param name="role"></param>
  6221. <param name="objToReturn"></param>
  6222. <returns></returns>
  6223. </member>
  6224. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask">
  6225. <summary>
  6226. Adds files to a PVCS repository.
  6227. </summary>
  6228. <remarks>
  6229. <para>
  6230. This task uses the <c>addfiles</c> PCLI command to add files to a PVCS repository.
  6231. </para>
  6232. </remarks>
  6233. <example>
  6234. <para>
  6235. Adds <c>File1.txt</c> and <c>File2.txt</c> to the root level of the
  6236. project database specified by the <c>project-database</c> property.
  6237. </para>
  6238. <code>
  6239. <![CDATA[
  6240. <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control.">
  6241. <entities>
  6242. <entity name="C:\Data\File1.txt"/>
  6243. <entity name="C:\Data\Folder\File2.txt"/>
  6244. </entities>
  6245. </pvcsaddfiles>
  6246. ]]>
  6247. </code>
  6248. </example>
  6249. <example>
  6250. <para>
  6251. Adds <c>File1.txt</c> and <c>File2.txt</c> to the <c>folder</c> project
  6252. of the project database specified by the <c>project-database</c>
  6253. property.
  6254. </para>
  6255. <code>
  6256. <![CDATA[
  6257. <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." projectpath="/folder">
  6258. <entities>
  6259. <entity name="C:\Data\File1.txt"/>
  6260. <entity name="C:\Data\Folder\File2.txt"/>
  6261. </entities>
  6262. </pvcsaddfiles>
  6263. ]]>
  6264. </code>
  6265. </example>
  6266. <example>
  6267. <para>
  6268. Adds <c>another_file.txt</c> and all files and folders at and below
  6269. <c>C:\Data</c> to the project database specified by the <c>project-database</c>
  6270. property.
  6271. </para>
  6272. <code>
  6273. <![CDATA[
  6274. <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." includesubprojects="true">
  6275. <entities>
  6276. <entity name="C:\Data\"/>
  6277. <entity name="C:\Temp\another_file.txt"/>
  6278. </entities>
  6279. </pvcsaddfiles>
  6280. ]]>
  6281. </code>
  6282. </example>
  6283. <example>
  6284. <para>
  6285. Adds all files at and below <c>C:\Data\</c> to the project database specified by the <c>project-database</c>
  6286. property. Workfiles will be copied to the workfile location and will overwrite any existing files (as
  6287. dictated by the <c>copymode</c> attribute). The relevant revisions will be locked in PVCS. Added files
  6288. will be assigned the <c>SYSTEST</c> promotion group.
  6289. </para>
  6290. <code>
  6291. <![CDATA[
  6292. <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Files." copymode="CopyWorkfileWithOverwrite" lock="true" promotiongroup="SYSTEST" includesubprojects="true">
  6293. <entities>
  6294. <entity name="C:\Data\"/>
  6295. </entities>
  6296. </pvcsaddfiles>
  6297. ]]>
  6298. </code>
  6299. </example>
  6300. </member>
  6301. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask">
  6302. <summary>
  6303. Base class for all PVCS project database tasks that operate against one or more entities.
  6304. </summary>
  6305. </member>
  6306. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask">
  6307. <summary>
  6308. A base class for PVCS tasks that deal with project databases.
  6309. </summary>
  6310. <remarks>
  6311. <para>
  6312. This class can be used as a base class for PVCS tasks that operate against a project database. It provides
  6313. common attributes and functionality for such tasks.
  6314. </para>
  6315. </remarks>
  6316. </member>
  6317. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSTask">
  6318. <summary>
  6319. Base class functionality for all PVCS tasks.
  6320. </summary>
  6321. </member>
  6322. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSTask._pvcsBin">
  6323. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PVCSBin"/>
  6324. </member>
  6325. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSTask._process">
  6326. <summary>
  6327. This is the PCLI process that is run by this task.
  6328. </summary>
  6329. </member>
  6330. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.StartProcess">
  6331. <summary>
  6332. Starts the process that is wrapped by this PVCS task.
  6333. </summary>
  6334. <remarks>
  6335. Provided only to seal the implementation of <c>StartProcess()</c>.
  6336. </remarks>
  6337. <returns>The process that was started.</returns>
  6338. </member>
  6339. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.ExecuteTask">
  6340. <summary>
  6341. Executes the task.
  6342. </summary>
  6343. <remarks>
  6344. Provided only to seal the implementation of <c>ExecuteTask()</c>.
  6345. </remarks>
  6346. </member>
  6347. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.PrepareProcess(System.Diagnostics.Process)">
  6348. <summary>
  6349. Prepares the process wrapped by this task for execution.
  6350. </summary>
  6351. <param name="process">The process to prepare for execution.</param>
  6352. </member>
  6353. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6354. <summary>
  6355. Allows tasks to add their task-specific arguments to the collection of arguments to be passed to the
  6356. PVCS command-line tool.
  6357. </summary>
  6358. <param name="arguments">The collection of arguments.</param>
  6359. </member>
  6360. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.GetProgramArguments">
  6361. <summary>
  6362. Constructs the program arguments that should be used when executing the wrapped PVCS process.
  6363. </summary>
  6364. <returns>A <c>string</c> containing the program arguments.</returns>
  6365. </member>
  6366. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PVCSBin">
  6367. <summary>
  6368. Gets or sets the location of the PVCS binary command-line tools.
  6369. </summary>
  6370. <remarks>
  6371. <para>
  6372. Generally, the PVCS command-line tools will be available on the current path. However, if this is not
  6373. the case then this property allows an exact location to be specified. If this property is not set, the
  6374. task will assume that the PVCS binaries are available on the current path.
  6375. </para>
  6376. </remarks>
  6377. </member>
  6378. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.Process">
  6379. <summary>
  6380. Gets or sets the process that is run as a result of running this task.
  6381. </summary>
  6382. </member>
  6383. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.ProgramArguments">
  6384. <summary>
  6385. Gets the program arguments with which to run the wrapped PVCS process.
  6386. </summary>
  6387. </member>
  6388. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.ExeName">
  6389. <summary>
  6390. Gets the executable name for the command-line tool to run for the PVCS task.
  6391. </summary>
  6392. </member>
  6393. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PCLICommandName">
  6394. <summary>
  6395. Gets the PCLI command name that corresponds to the operation the task performs.
  6396. </summary>
  6397. <remarks>
  6398. <para>
  6399. By default, this property will return the name of the task minus the starting "pvcs". Subclasses need
  6400. only override this property if there is a mismatch between the task name and the PCLI command name.
  6401. </para>
  6402. </remarks>
  6403. </member>
  6404. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._includeSubprojects">
  6405. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects"/>
  6406. </member>
  6407. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._password">
  6408. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Password"/>
  6409. </member>
  6410. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._projectDatabase">
  6411. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectDatabase"/>
  6412. </member>
  6413. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._projectPath">
  6414. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectPath"/>
  6415. </member>
  6416. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._userId">
  6417. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.UserId"/>
  6418. </member>
  6419. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._workspace">
  6420. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Workspace"/>
  6421. </member>
  6422. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._includeSubProjectsUsed">
  6423. <summary>
  6424. Set to <c>true</c> if the <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects"/> property is manipulated. Some tasks don't
  6425. support this property and so an exception will be thrown if the property is used.
  6426. </summary>
  6427. </member>
  6428. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6429. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6430. </member>
  6431. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects">
  6432. <summary>
  6433. Gets or sets a value indicating whether the operation should include subprojects.
  6434. </summary>
  6435. <remarks>
  6436. <para>
  6437. This is equivalent to the <c>-z</c> command-line option.
  6438. </para>
  6439. </remarks>
  6440. </member>
  6441. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects">
  6442. <summary>
  6443. Gets a value indicating whether the specific task implementation supports the <c>includesubprojects</c>
  6444. task attribute. If not, an exception will be thrown if an attempt is made to set the attribute.
  6445. </summary>
  6446. </member>
  6447. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Password">
  6448. <summary>
  6449. Gets or sets the password to use when connecting to the project database.
  6450. </summary>
  6451. <remarks>
  6452. <para>
  6453. This is equivalent to the password part of the <c>-id</c> command-line option.
  6454. </para>
  6455. </remarks>
  6456. </member>
  6457. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.UserId">
  6458. <summary>
  6459. Gets or sets the user ID to use when connecting to the project database.
  6460. </summary>
  6461. <remarks>
  6462. <para>
  6463. This is equivalent to the user ID part of the <c>-id</c> command-line option.
  6464. </para>
  6465. </remarks>
  6466. </member>
  6467. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Workspace">
  6468. <summary>
  6469. Gets or sets the workspace to use when connecting to the project database.
  6470. </summary>
  6471. <remarks>
  6472. <para>
  6473. This is equivalent to the <c>-sp</c> command-line option.
  6474. </para>
  6475. </remarks>
  6476. </member>
  6477. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectDatabase">
  6478. <summary>
  6479. Gets or sets the project database to utilize during the operation.
  6480. </summary>
  6481. <remarks>
  6482. <para>
  6483. This is equivalent to the <c>-pr</c> command-line option.
  6484. </para>
  6485. </remarks>
  6486. </member>
  6487. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectPath">
  6488. <summary>
  6489. Gets or sets the project path to utilize during the operation.
  6490. </summary>
  6491. <remarks>
  6492. <para>
  6493. This is equivalent to the <c>-pp</c> command-line option.
  6494. </para>
  6495. </remarks>
  6496. </member>
  6497. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask._entities">
  6498. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.Entities"/>
  6499. </member>
  6500. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.#ctor">
  6501. <summary>
  6502. Constructs and initializes an instance of <c>PVCSMultipleEntityTask</c>.
  6503. </summary>
  6504. </member>
  6505. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6506. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6507. </member>
  6508. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.Entities">
  6509. <summary>
  6510. Gets or sets the entities involved in the operation.
  6511. </summary>
  6512. </member>
  6513. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._archiveDescription">
  6514. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.ArchiveDescription"/>
  6515. </member>
  6516. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._copyMode">
  6517. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.CopyMode"/>
  6518. </member>
  6519. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._deleteWorkfiles">
  6520. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.DeleteWorkfiles"/>
  6521. </member>
  6522. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._description">
  6523. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Description"/>
  6524. </member>
  6525. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._lock">
  6526. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Lock"/>
  6527. </member>
  6528. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._promotionGroup">
  6529. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PromotionGroup"/>
  6530. </member>
  6531. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._suppressAddIfExists">
  6532. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.SuppressAddIfExists"/>
  6533. </member>
  6534. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._versionLabel">
  6535. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.VersionLabel"/>
  6536. </member>
  6537. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.#ctor">
  6538. <summary>
  6539. Constructs and initializes an instance of <c>PVCSAddFilesTask</c>.
  6540. </summary>
  6541. </member>
  6542. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6543. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6544. </member>
  6545. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.ArchiveDescription">
  6546. <summary>
  6547. Gets or sets the archive description for versioned files.
  6548. </summary>
  6549. <remarks>
  6550. <para>
  6551. This is equivalent to the <c>-t</c> parameter to the <c>pcli addfiles</c> command.
  6552. </para>
  6553. </remarks>
  6554. </member>
  6555. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.CopyMode">
  6556. <summary>
  6557. Gets or sets the copy mode for the operation.
  6558. </summary>
  6559. </member>
  6560. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.DeleteWorkfiles">
  6561. <summary>
  6562. Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS.
  6563. </summary>
  6564. <remarks>
  6565. <para>
  6566. This is equivalent to the <c>-d</c> parameter to the <c>pcli addfiles</c> command.
  6567. </para>
  6568. </remarks>
  6569. </member>
  6570. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Description">
  6571. <summary>
  6572. Gets or sets the description for versioned files.
  6573. </summary>
  6574. <remarks>
  6575. <para>
  6576. This is equivalent to the <c>-m</c> parameter to the <c>pcli addfiles</c> command.
  6577. </para>
  6578. </remarks>
  6579. </member>
  6580. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Lock">
  6581. <summary>
  6582. Gets or sets a value indicating whether versioned files should be locked after being added to PVCS.
  6583. </summary>
  6584. <remarks>
  6585. <para>
  6586. This is equivalent to the <c>-l</c> parameter to the <c>pcli addfiles</c> command.
  6587. </para>
  6588. </remarks>
  6589. </member>
  6590. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PromotionGroup">
  6591. <summary>
  6592. Gets or sets the promotion group to which added files will be assigned. Setting this attribute to an
  6593. empty string indicates the versioned files will not be assigned to any promotion group.
  6594. </summary>
  6595. <remarks>
  6596. <para>
  6597. This is equivalent to the <c>-g</c> parameter to the <c>pcli addfiles</c> command.
  6598. </para>
  6599. </remarks>
  6600. </member>
  6601. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.SuppressAddIfExists">
  6602. <summary>
  6603. Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS
  6604. repository.
  6605. </summary>
  6606. <remarks>
  6607. <para>
  6608. This is equivalent to the <c>-qw</c> parameter to the <c>pcli addfiles</c> command.
  6609. </para>
  6610. </remarks>
  6611. </member>
  6612. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.VersionLabel">
  6613. <summary>
  6614. Gets or sets the version label to assign to the added versioned files.
  6615. </summary>
  6616. <remarks>
  6617. <para>
  6618. This is equivalent to the <c>-v</c> parameter to the <c>pcli addfiles</c> command.
  6619. </para>
  6620. </remarks>
  6621. </member>
  6622. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode">
  6623. <summary>
  6624. Specifies possible copy modes for the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask"/> task.
  6625. </summary>
  6626. </member>
  6627. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.Default">
  6628. <summary>
  6629. Indicates the default copy mode should be used.
  6630. </summary>
  6631. </member>
  6632. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.CopyWorkfileIfRequired">
  6633. <summary>
  6634. Indicates that workfiles should be copied to the project workfile location is it doesn't already exist.
  6635. </summary>
  6636. </member>
  6637. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.CopyWorkfileWithOverwrite">
  6638. <summary>
  6639. Indicates that workfiles should be copied to the project workfile location and overwrite any existing
  6640. workfile.
  6641. </summary>
  6642. </member>
  6643. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask">
  6644. <summary>
  6645. Adds a user to a PVCS project or project database.
  6646. </summary>
  6647. <remarks>
  6648. <para>
  6649. This task uses the <c>adduser</c> PCLI command to add the user to the PVCS project or database.
  6650. </para>
  6651. </remarks>
  6652. <example>
  6653. <para>
  6654. Adds a user with name <c>kb</c> and password <c>*Muse*</c> to the project database specified by the
  6655. <c>project-database</c> property.
  6656. </para>
  6657. <code>
  6658. <![CDATA[
  6659. <pvcsadduser projectdatabase="${project-database}" username="kb" password="*Muse*"/>
  6660. ]]>
  6661. </code>
  6662. </example>
  6663. <example>
  6664. <para>
  6665. Adds a user with name <c>kb</c> and password <c>*Muse*</c> to the project database specified by the
  6666. <c>project-database</c> property. The user's logon will expire on the 26th of October, 2005.
  6667. </para>
  6668. <code>
  6669. <![CDATA[
  6670. <pvcsadduser projectdatabase="${project-database}" username="kb" password="*Muse*" expirydate="10/26/2005"/>
  6671. ]]>
  6672. </code>
  6673. </example>
  6674. </member>
  6675. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._expiryDate">
  6676. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.ExpiryDate"/>
  6677. </member>
  6678. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._userPassword">
  6679. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserPassword"/>
  6680. </member>
  6681. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._userName">
  6682. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserName"/>
  6683. </member>
  6684. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.#ctor">
  6685. <summary>
  6686. Constructs and initializes an instance of <c>PVCSAddUserTask</c>.
  6687. </summary>
  6688. </member>
  6689. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6690. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6691. </member>
  6692. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.ExpiryDate">
  6693. <summary>
  6694. Gets or sets the expiration date for the new user.
  6695. </summary>
  6696. <remarks>
  6697. <para>
  6698. This is equivalent to the <c>-e</c> parameter to the <c>pcli adduser</c> command.
  6699. </para>
  6700. </remarks>
  6701. </member>
  6702. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserPassword">
  6703. <summary>
  6704. Gets or sets the password for the new user.
  6705. </summary>
  6706. </member>
  6707. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserName">
  6708. <summary>
  6709. Gets or sets the user name for the new user.
  6710. </summary>
  6711. </member>
  6712. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.SupportsIncludeSubprojects">
  6713. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
  6714. </member>
  6715. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask">
  6716. <summary>
  6717. Assigns a promotion group to versioned files.
  6718. </summary>
  6719. <remarks>
  6720. <para>
  6721. This task uses the <c>assigngroup</c> PCLI command to assign the group to versioned files.
  6722. </para>
  6723. </remarks>
  6724. <example>
  6725. <para>
  6726. Assigns the <c>SYSTEST</c> promotion group to all entities with the <c>DEV</c> promotion group in the
  6727. <c>folder</c> project.
  6728. </para>
  6729. <code>
  6730. <![CDATA[
  6731. <pvcsassigngroup projectdatabase="${project-database}" entity="/folder" assignpromotiongroup="SYSTEST" promotiongroup="DEV"/>
  6732. ]]>
  6733. </code>
  6734. </example>
  6735. <example>
  6736. <para>
  6737. Assigns the <c>SYSTEST</c> promotion group to revision <c>1.2</c> of all entities.
  6738. </para>
  6739. <code>
  6740. <![CDATA[
  6741. <pvcsassigngroup projectdatabase="${project-database}" entity="/" includesubprojects="true" assignpromotiongroup="SYSTEST" revision="1.2"/>
  6742. ]]>
  6743. </code>
  6744. </example>
  6745. </member>
  6746. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask">
  6747. <summary>
  6748. Base class for all PVCS project database tasks that operate against a single entity.
  6749. </summary>
  6750. </member>
  6751. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask._entity">
  6752. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.Entity"/>
  6753. </member>
  6754. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6755. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6756. </member>
  6757. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.Entity">
  6758. <summary>
  6759. Gets or sets the entity involved in the operation.
  6760. </summary>
  6761. </member>
  6762. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._assignPromotionGroup">
  6763. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AssignPromotionGroup"/>
  6764. </member>
  6765. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._promotionGroup">
  6766. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.PromotionGroup"/>
  6767. </member>
  6768. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._revision">
  6769. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.Revision"/>
  6770. </member>
  6771. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._versionLabel">
  6772. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.VersionLabel"/>
  6773. </member>
  6774. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.#ctor">
  6775. <summary>
  6776. Constructs and initializes an instance of <c>PVCSAssignGroupTask</c>.
  6777. </summary>
  6778. </member>
  6779. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6780. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6781. </member>
  6782. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AssignPromotionGroup">
  6783. <summary>
  6784. Gets or sets the promotion group to assign to the versioned files.
  6785. </summary>
  6786. <remarks>
  6787. <para>
  6788. This is equivalent to the <c>-g</c> parameter to the <c>pcli assigngroup</c> command.
  6789. </para>
  6790. </remarks>
  6791. </member>
  6792. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.PromotionGroup">
  6793. <summary>
  6794. Gets or sets the promotion group for the versioned files to be assigned the promotion group.
  6795. </summary>
  6796. <remarks>
  6797. <para>
  6798. This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
  6799. </para>
  6800. </remarks>
  6801. </member>
  6802. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.Revision">
  6803. <summary>
  6804. Gets or sets the revision for the versioned files to be assigned the promotion group.
  6805. </summary>
  6806. <remarks>
  6807. <para>
  6808. This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
  6809. </para>
  6810. <para>
  6811. If this property has not yet been set, it will return <c>Double.MaxValue</c>.
  6812. </para>
  6813. </remarks>
  6814. </member>
  6815. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.VersionLabel">
  6816. <summary>
  6817. Gets or sets the version label for the versioned files to be assigned the promotion group.
  6818. </summary>
  6819. <remarks>
  6820. <para>
  6821. This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
  6822. </para>
  6823. </remarks>
  6824. </member>
  6825. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask">
  6826. <summary>
  6827. Changes the promotion group for specified versioned files.
  6828. </summary>
  6829. <remarks>
  6830. <para>
  6831. This task uses the <c>changegroup</c> PCLI command to change the group for versioned files.
  6832. </para>
  6833. </remarks>
  6834. <example>
  6835. <para>
  6836. Changes the promotion group for <c>file.txt</c> from <c>SYSTEST</c> to <c>DEV</c>.
  6837. </para>
  6838. <code>
  6839. <![CDATA[
  6840. <pvcschangegroup projectdatabase="${project-database}" from="SYSTEST" to="DEV" entity="/file.txt"/>
  6841. ]]>
  6842. </code>
  6843. </example>
  6844. <example>
  6845. <para>
  6846. Changes the promotion group for all files from <c>DEV</c> to <c>PROD</c>.
  6847. </para>
  6848. <code>
  6849. <![CDATA[
  6850. <pvcschangegroup projectdatabase="${project-database}" from="DEV" to="PROD" entity="/" includesubprojects="true"/>
  6851. ]]>
  6852. </code>
  6853. </example>
  6854. </member>
  6855. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask._from">
  6856. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.From"/>
  6857. </member>
  6858. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask._to">
  6859. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.To"/>
  6860. </member>
  6861. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  6862. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  6863. </member>
  6864. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.From">
  6865. <summary>
  6866. Gets or sets the promotion group to change from.
  6867. </summary>
  6868. <remarks>
  6869. <para>
  6870. This is equivalent to the <c>-gf</c> parameter to the <c>pcli changegroup</c> command.
  6871. </para>
  6872. </remarks>
  6873. </member>
  6874. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.To">
  6875. <summary>
  6876. Gets or sets the promotion group to change to.
  6877. </summary>
  6878. <remarks>
  6879. <para>
  6880. This is equivalent to the <c>-gt</c> parameter to the <c>pcli changegroup</c> command.
  6881. </para>
  6882. </remarks>
  6883. </member>
  6884. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument">
  6885. <summary>
  6886. Encapsulates the details of a PVCS command argument.
  6887. </summary>
  6888. <remarks>
  6889. <para>
  6890. PVCS tasks must "fill in" a collection of arguments to be passed to the PVCS command line interface (PCLI).
  6891. This class represents one such argument.
  6892. </para>
  6893. <para>
  6894. Each argument consists of a command and an optional command value. The command is always passed to the PVCS
  6895. command line utility and is therefore required. An example of a command is "-g" which is passed to many
  6896. PVCS command line utilities to specify a promotion group.
  6897. </para>
  6898. <para>
  6899. The command value is used to specify extra information to the command. For example, if the command is "-g"
  6900. then the command value would be the name of the promotion group.
  6901. </para>
  6902. <para>
  6903. The command can be assigned a position (see the <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position"/> property). This position defines
  6904. where the command appears relative to other commands. For example, some commands must appear after other
  6905. commands. Therefore, they should be assigned a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>.
  6906. </para>
  6907. </remarks>
  6908. </member>
  6909. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._command">
  6910. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command"/>
  6911. </member>
  6912. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._commandValue">
  6913. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CommandValue"/>
  6914. </member>
  6915. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._position">
  6916. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position"/>
  6917. </member>
  6918. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String)">
  6919. <summary>
  6920. Constructs an instance of <c>PVCSCommandArgument</c> with the specified information. No value is
  6921. applied and the argument has a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>.
  6922. </summary>
  6923. <param name="command">The command string.</param>
  6924. </member>
  6925. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String,System.Object)">
  6926. <summary>
  6927. Constructs an instance of <c>PVCSCommandArgument</c> with the specified information. The argument has
  6928. a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>.
  6929. </summary>
  6930. <param name="command">The command string.</param>
  6931. <param name="commandValue">The value for the command, or <c>null</c> if no value applies.</param>
  6932. </member>
  6933. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String,System.Object,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition)">
  6934. <summary>
  6935. Constructs an instance of <c>PVCSCommandArgument</c> with the specified information.
  6936. </summary>
  6937. <param name="command">The command string.</param>
  6938. <param name="commandValue">The value for the command, or <c>null</c> if no value applies.</param>
  6939. <param name="position">The position for the command.</param>
  6940. </member>
  6941. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CompareTo(System.Object)">
  6942. <summary>
  6943. Compares two PVCS command arguments based on their position.
  6944. </summary>
  6945. <param name="o">The PVCS command argument to compare to <c>this</c>.</param>
  6946. <returns>
  6947. Less than zero if this instance is less than <paramref name="o"/>.
  6948. Zero if this instance is equal to <paramref name="o"/>.
  6949. Greater than zero if this instance is greater than <paramref name="o"/>.
  6950. </returns>
  6951. </member>
  6952. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.ToString">
  6953. <summary>
  6954. Converts this command argument to its <c>string</c> representation.
  6955. </summary>
  6956. <returns>The <c>string</c> representation of this command argument.</returns>
  6957. </member>
  6958. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.EscapeStringCommandArgument(System.String)">
  6959. <summary>
  6960. Escapes a <c>string</c> command line argument.
  6961. </summary>
  6962. <remarks>
  6963. <para>
  6964. This method attempts to deal with the mess of keeping both PCLI and the shell happy with string
  6965. arguments. It's not perfect yet (try an argument with several backslashes before a double quote). It
  6966. would be nice to have a regex to handle this but I wouldn't even bother until this logic is spot on.
  6967. </para>
  6968. </remarks>
  6969. <param name="argument">The string argument to escape.</param>
  6970. <returns>The escaped string argument.</returns>
  6971. </member>
  6972. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command">
  6973. <summary>
  6974. Gets a <c>string</c> that contains the command to pass to PVCS.
  6975. </summary>
  6976. </member>
  6977. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CommandValue">
  6978. <summary>
  6979. Gets the value to append to <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command"/>.
  6980. </summary>
  6981. <remarks>
  6982. <para>
  6983. If this property is <c>null</c>, no value will be appended to the command.
  6984. </para>
  6985. </remarks>
  6986. </member>
  6987. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position">
  6988. <summary>
  6989. Gets the position for the command.
  6990. </summary>
  6991. </member>
  6992. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection">
  6993. <summary>
  6994. Implements a type-safe collection of <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/>s.
  6995. </summary>
  6996. </member>
  6997. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  6998. <see cref="M:System.Collections.IList.Add(System.Object)"/>
  6999. </member>
  7000. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String)">
  7001. <summary>
  7002. Adds a new command argument to this collection with the specified information.
  7003. </summary>
  7004. <param name="command">The command string for the new command.</param>
  7005. </member>
  7006. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String,System.Object)">
  7007. <summary>
  7008. Adds a new command argument to this collection with the specified information.
  7009. </summary>
  7010. <param name="command">The command string for the new command.</param>
  7011. <param name="commandValue">
  7012. The command value for the new command, or <c>null</c> if no value applies.
  7013. </param>
  7014. </member>
  7015. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String,System.Object,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition)">
  7016. <summary>
  7017. Adds a new command argument to this collection with the specified information.
  7018. </summary>
  7019. <param name="command">The command string for the new command.</param>
  7020. <param name="commandValue">
  7021. The command value for the new command, or <c>null</c> if no value applies.
  7022. </param>
  7023. <param name="position">The position for the new command.</param>
  7024. </member>
  7025. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.AddRange(System.Collections.ICollection)">
  7026. <summary>
  7027. Adds all specified command arguments to this collection.
  7028. </summary>
  7029. <param name="commandArguments">The collection of command arguments to add.</param>
  7030. </member>
  7031. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.IndexOf(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  7032. <see cref="M:System.Collections.IList.IndexOf(System.Object)"/>
  7033. </member>
  7034. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Insert(System.Int32,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  7035. <see cref="M:System.Collections.IList.Insert(System.Int32,System.Object)"/>
  7036. </member>
  7037. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Remove(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  7038. <see cref="M:System.Collections.IList.Remove(System.Object)"/>
  7039. </member>
  7040. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Contains(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
  7041. <see cref="M:System.Collections.IList.Contains(System.Object)"/>
  7042. </member>
  7043. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.ToArray">
  7044. <summary>
  7045. Retrieves an array of <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/> objects in this collection.
  7046. </summary>
  7047. <returns>An array of command arguments in this collection.</returns>
  7048. </member>
  7049. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnInsert(System.Int32,System.Object)">
  7050. <see cref="M:System.Collections.CollectionBase.OnInsert(System.Int32,System.Object)"/>
  7051. </member>
  7052. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnSet(System.Int32,System.Object,System.Object)">
  7053. <see cref="M:System.Collections.CollectionBase.OnSet(System.Int32,System.Object,System.Object)"/>
  7054. </member>
  7055. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnValidate(System.Object)">
  7056. <see cref="M:System.Collections.CollectionBase.OnValidate(System.Object)"/>
  7057. </member>
  7058. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Item(System.Int32)">
  7059. <summary>
  7060. Allows the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/> objects in the collection to be manipulated.
  7061. </summary>
  7062. </member>
  7063. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition">
  7064. <summary>
  7065. Defines possible values for specifying positions for PCLI command arguments and arguments to PCLI itself.
  7066. </summary>
  7067. <remarks>
  7068. <para>
  7069. Members of this enumeration are used to specify relative positions of PCLI command arguments. All arguments
  7070. given a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/> will appear after arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>
  7071. or <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>. Similarly, arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/> will appear after
  7072. those with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/> but before those with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/>.
  7073. </para>
  7074. <para>
  7075. No order is guaranteed for arguments with the same position. That is, if two arguments have a position of
  7076. <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>, it is not possible to specify which one is output to the command line first.
  7077. </para>
  7078. <para>
  7079. The <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.BeforePCLICommand"/> member is special in that it ensures the argument will appear before
  7080. the PCLI command name. This is useful when the argument is to PCLI itself, not the PCLI command.
  7081. </para>
  7082. </remarks>
  7083. </member>
  7084. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.BeforePCLICommand">
  7085. <summary>
  7086. Arguments that should appear before the PCLI command argument. This is useful for arguments to PCLI
  7087. itself (as opposed to the PCLI command).
  7088. </summary>
  7089. </member>
  7090. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start">
  7091. <summary>
  7092. PCLI command arguments that should appear before other PCLI command arguments.
  7093. </summary>
  7094. </member>
  7095. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle">
  7096. <summary>
  7097. PCLI command arguments that should appear before other arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/>
  7098. but after other arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>.
  7099. </summary>
  7100. </member>
  7101. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End">
  7102. <summary>
  7103. PCLI command arguments that should appear after other PCLI command arguments.
  7104. </summary>
  7105. </member>
  7106. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask">
  7107. <summary>
  7108. Creates a project in a PVCS repository.
  7109. </summary>
  7110. <remarks>
  7111. <para>
  7112. This task uses the <c>createproject</c> PCLI command to create the project in the PVCS repository.
  7113. </para>
  7114. </remarks>
  7115. <example>
  7116. <para>
  7117. Creates a project called <c>Songs</c> in the project database specified by the <c>project-database</c>
  7118. property. The workfile location for the project is set to <c>C:\Work\Songs</c>.
  7119. </para>
  7120. <code>
  7121. <![CDATA[
  7122. <pvcscreateproject projectdatabase="${project-database}" workfilelocation="C:\Work\Songs" entity="/Songs"/>
  7123. ]]>
  7124. </code>
  7125. </example>
  7126. </member>
  7127. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask._workfileLocation">
  7128. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.WorkfileLocation"/>
  7129. </member>
  7130. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7131. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7132. </member>
  7133. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.WorkfileLocation">
  7134. <summary>
  7135. Gets or sets the workfile location for the created project.
  7136. </summary>
  7137. <remarks>
  7138. <para>
  7139. This is equivalent to the <c>-w</c> parameter to the <c>pcli createproject</c> command.
  7140. </para>
  7141. </remarks>
  7142. </member>
  7143. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.SupportsIncludeSubprojects">
  7144. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
  7145. </member>
  7146. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask">
  7147. <summary>
  7148. Removes a specified promotion group from versioned files.
  7149. </summary>
  7150. <remarks>
  7151. <para>
  7152. This task uses the <c>deletegroup</c> PCLI command to remove the promotion group from the versioned files.
  7153. </para>
  7154. </remarks>
  7155. <example>
  7156. <para>
  7157. Removes the <c>DEV</c> promotion group from <c>App.ico</c> in the project database specified by the
  7158. <c>project-database</c> property.
  7159. </para>
  7160. <code>
  7161. <![CDATA[
  7162. <pvcsdeletegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/App.ico"/>
  7163. ]]>
  7164. </code>
  7165. </example>
  7166. <example>
  7167. <para>
  7168. Removes the <c>DEV</c> promotion group all files in the project database specified by the
  7169. <c>project-database</c> property.
  7170. </para>
  7171. <code>
  7172. <![CDATA[
  7173. <pvcsdeletegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/" includesubprojects="true"/>
  7174. ]]>
  7175. </code>
  7176. </example>
  7177. </member>
  7178. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask._promotionGroup">
  7179. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.PromotionGroup"/>
  7180. </member>
  7181. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7182. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7183. </member>
  7184. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.PromotionGroup">
  7185. <summary>
  7186. Gets or sets the promotion group to delete.
  7187. </summary>
  7188. <remarks>
  7189. <para>
  7190. This is equivalent to the <c>-g</c> parameter to the <c>pcli deletegroup</c> command.
  7191. </para>
  7192. </remarks>
  7193. </member>
  7194. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask">
  7195. <summary>
  7196. Removes a label from specified versioned files or projects.
  7197. </summary>
  7198. <remarks>
  7199. <para>
  7200. This task uses the <c>deletelabel</c> PCLI command to remove the version label from the versioned files.
  7201. </para>
  7202. </remarks>
  7203. <example>
  7204. <para>
  7205. Removes the label called <c>My Label</c> from the versioned file called <c>App.ico</c> from the project
  7206. database specified by the <c>project-database</c> property.
  7207. </para>
  7208. <code>
  7209. <![CDATA[
  7210. <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label">
  7211. <entities>
  7212. <entity name="/App.ico"/>
  7213. </entities>
  7214. </pvcsdeletelabel>
  7215. ]]>
  7216. </code>
  7217. </example>
  7218. <example>
  7219. <para>
  7220. Removes the label called <c>My Label</c> from all files at and below both <c>folder1</c> and <c>folder2</c>
  7221. in the project database specified by the <c>project-database</c> property.
  7222. </para>
  7223. <code>
  7224. <![CDATA[
  7225. <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label" includesubprojects="true">
  7226. <entities>
  7227. <entity name="/folder1"/>
  7228. <entity name="/folder2"/>
  7229. </entities>
  7230. </pvcsdeletelabel>
  7231. ]]>
  7232. </code>
  7233. </example>
  7234. </member>
  7235. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask._versionLabel">
  7236. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.VersionLabel"/>
  7237. </member>
  7238. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7239. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7240. </member>
  7241. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.VersionLabel">
  7242. <summary>
  7243. Gets or sets the version label to remove.
  7244. </summary>
  7245. <remarks>
  7246. <para>
  7247. This is equivalent to the <c>-v</c> parameter to the <c>pcli deletelabel</c> command.
  7248. </para>
  7249. </remarks>
  7250. </member>
  7251. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteTask">
  7252. <summary>
  7253. Deletes folder, projects, versioned items and workspaces in a PVCS repository.
  7254. </summary>
  7255. <remarks>
  7256. <para>
  7257. This task uses the <c>delete</c> PCLI command to delete the items.
  7258. </para>
  7259. </remarks>
  7260. <example>
  7261. <para>
  7262. Deletes the versioned file called <c>App.ico</c> from the project database specified by the
  7263. <c>project-database</c> property.
  7264. </para>
  7265. <code>
  7266. <![CDATA[
  7267. <pvcsdelete projectdatabase="${project-database}">
  7268. <entities>
  7269. <entity name="/App.ico"/>
  7270. </entities>
  7271. </pvcsdelete>
  7272. ]]>
  7273. </code>
  7274. </example>
  7275. <example>
  7276. <para>
  7277. Deletes the files called <c>file1.txt</c> and <c>file2.txt</c> from the project called <c>folder</c> in the
  7278. project database specified by the <c>project-database</c> property.
  7279. </para>
  7280. <code>
  7281. <![CDATA[
  7282. <pvcsdelete projectdatabase="${project-database}" projectpath="/folder">
  7283. <entities>
  7284. <entity name="file1.txt"/>
  7285. <entity name="file2.txt"/>
  7286. </entities>
  7287. </pvcsdelete>
  7288. ]]>
  7289. </code>
  7290. </example>
  7291. </member>
  7292. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteTask.SupportsIncludeSubprojects">
  7293. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
  7294. </member>
  7295. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask">
  7296. <summary>
  7297. Deletes the specified users from the PVCS access control database.
  7298. </summary>
  7299. <remarks>
  7300. <para>
  7301. This task uses the <c>deleteuser</c> PCLI command to delete the users.
  7302. </para>
  7303. </remarks>
  7304. <example>
  7305. <para>
  7306. Deletes the users called <c>kb</c>, <c>kv</c> and <c>tb</c> from the project database specified by the
  7307. <c>project-database</c> property.
  7308. </para>
  7309. <code>
  7310. <![CDATA[
  7311. <pvcsdeleteusers projectdatabase="${project-database}">
  7312. <entities>
  7313. <entity name="kb"/>
  7314. <entity name="kv"/>
  7315. <entity name="tb"/>
  7316. </entities>
  7317. </pvcsdeleteusers>
  7318. ]]>
  7319. </code>
  7320. </example>
  7321. </member>
  7322. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask.SupportsIncludeSubprojects">
  7323. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
  7324. </member>
  7325. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask.PCLICommandName">
  7326. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PCLICommandName"/>
  7327. </member>
  7328. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSGetTask">
  7329. <summary>
  7330. Gets files from a PVCS repository.
  7331. </summary>
  7332. <remarks>
  7333. <para>
  7334. This task uses the <c>get</c> PCLI command to get the versioned files from PVCS.
  7335. </para>
  7336. </remarks>
  7337. <example>
  7338. <para>
  7339. Gets the versioned file called <c>App.ico</c> from the project database specified by the
  7340. <c>project-database</c> property.
  7341. </para>
  7342. <code>
  7343. <![CDATA[
  7344. <pvcsget projectdatabase="${project-database}">
  7345. <entities>
  7346. <entity name="/App.ico"/>
  7347. </entities>
  7348. </pvcsget>
  7349. ]]>
  7350. </code>
  7351. </example>
  7352. <example>
  7353. <para>
  7354. Gets the versioned file called <c>App.ico</c> from the project database specified by the
  7355. <c>project-database</c> property. The file is also locked.
  7356. </para>
  7357. <code>
  7358. <![CDATA[
  7359. <pvcsget projectdatabase="${project-database}" lock="true">
  7360. <entities>
  7361. <entity name="/App.ico"/>
  7362. </entities>
  7363. </pvcsget>
  7364. ]]>
  7365. </code>
  7366. </example>
  7367. <example>
  7368. <para>
  7369. Gets all revisions assigned the <c>SYSTEST</c> promotion group from the project database specified by the
  7370. <c>project-database</c> property. The workfiles are touched after the get operation.
  7371. </para>
  7372. <code>
  7373. <![CDATA[
  7374. <pvcsget projectdatabase="${project-database}" includesubprojects="true" promotiongroup="SYSTEST" touch="true">
  7375. <entities>
  7376. <entity name="/"/>
  7377. </entities>
  7378. </pvcsget>
  7379. ]]>
  7380. </code>
  7381. </example>
  7382. </member>
  7383. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._baseProjectPath">
  7384. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.BaseProjectPath"/>
  7385. </member>
  7386. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._location">
  7387. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Location"/>
  7388. </member>
  7389. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._lock">
  7390. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Lock"/>
  7391. </member>
  7392. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._makeWritable">
  7393. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MakeWritable"/>
  7394. </member>
  7395. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._maxDateTime">
  7396. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MaxDateTime"/>
  7397. </member>
  7398. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._overrideWorkfileLocation">
  7399. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.OverrideWorkfileLocation"/>
  7400. </member>
  7401. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._promotionGroup">
  7402. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.PromotionGroup"/>
  7403. </member>
  7404. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._revision">
  7405. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Revision"/>
  7406. </member>
  7407. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._touch">
  7408. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Touch"/>
  7409. </member>
  7410. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._updateOnly">
  7411. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.UpdateOnly"/>
  7412. </member>
  7413. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._versionLabel">
  7414. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.VersionLabel"/>
  7415. </member>
  7416. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.#ctor">
  7417. <summary>
  7418. Constructs and initializes an instance of <c>PVCSGetTask</c>.
  7419. </summary>
  7420. </member>
  7421. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7422. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7423. </member>
  7424. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.BaseProjectPath">
  7425. <summary>
  7426. Gets or sets the base project path.
  7427. </summary>
  7428. <remarks>
  7429. <para>
  7430. This is equivalent to the <c>-bp</c> parameter to the <c>pcli get</c> command.
  7431. </para>
  7432. </remarks>
  7433. </member>
  7434. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Location">
  7435. <summary>
  7436. Gets or sets an alternative location for workfiles.
  7437. </summary>
  7438. <remarks>
  7439. <para>
  7440. This is equivalent to the <c>-a</c> parameter to the <c>pcli get</c> command.
  7441. </para>
  7442. </remarks>
  7443. </member>
  7444. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Lock">
  7445. <summary>
  7446. Gets or sets a value indicating whether revisions involved in the get operation should be locked.
  7447. </summary>
  7448. <remarks>
  7449. <para>
  7450. This is equivalent to the <c>-l</c> parameter to the <c>pcli get</c> command.
  7451. </para>
  7452. </remarks>
  7453. </member>
  7454. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MakeWritable">
  7455. <summary>
  7456. Gets or sets whether the workfiles should be made writable.
  7457. </summary>
  7458. <remarks>
  7459. <para>
  7460. This is equivalent to the <c>-w</c> parameter to the <c>pcli get</c> command.
  7461. </para>
  7462. </remarks>
  7463. </member>
  7464. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MaxDateTime">
  7465. <summary>
  7466. Gets or sets the maximum date and time of workfiles to retrieve.
  7467. </summary>
  7468. <remarks>
  7469. <para>
  7470. This is equivalent to the <c>-d</c> parameter to the <c>pcli get</c> command.
  7471. </para>
  7472. <para>
  7473. If this property has not yet been set, it will return <c>DateTime.MaxValue</c>.
  7474. </para>
  7475. </remarks>
  7476. </member>
  7477. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.OverrideWorkfileLocation">
  7478. <summary>
  7479. Gets or sets a value indicating whether the workfile location for files should be overridden.
  7480. </summary>
  7481. <remarks>
  7482. <para>
  7483. This is equivalent to the <c>-o</c> parameter to the <c>pcli get</c> command.
  7484. </para>
  7485. </remarks>
  7486. </member>
  7487. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.PromotionGroup">
  7488. <summary>
  7489. Gets or sets the promotion group to get.
  7490. </summary>
  7491. <remarks>
  7492. <para>
  7493. This is equivalent to the <c>-g</c> parameter to the <c>pcli get</c> command.
  7494. </para>
  7495. </remarks>
  7496. </member>
  7497. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Revision">
  7498. <summary>
  7499. Gets or sets the revision to get against.
  7500. </summary>
  7501. <remarks>
  7502. <para>
  7503. This is equivalent to the <c>-r</c> parameter to the <c>pcli get</c> command.
  7504. </para>
  7505. <para>
  7506. If this property has not yet been set, it will return <c>Double.MaxValue</c>.
  7507. </para>
  7508. </remarks>
  7509. </member>
  7510. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Touch">
  7511. <summary>
  7512. Gets or sets a value indicating whether workfiles should be touched after the get.
  7513. </summary>
  7514. <remarks>
  7515. <para>
  7516. This is equivalent to the <c>-t</c> parameter to the <c>pcli get</c> command.
  7517. </para>
  7518. </remarks>
  7519. </member>
  7520. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.UpdateOnly">
  7521. <summary>
  7522. Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the
  7523. current workfile.
  7524. </summary>
  7525. <remarks>
  7526. <para>
  7527. This is equivalent to the <c>-u</c> parameter to the <c>pcli get</c> command (without specifying a
  7528. date or time).
  7529. </para>
  7530. </remarks>
  7531. </member>
  7532. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.VersionLabel">
  7533. <summary>
  7534. Gets or sets the version label to get against.
  7535. </summary>
  7536. <remarks>
  7537. <para>
  7538. This is equivalent to the <c>-v</c> parameter to the <c>pcli get</c> command.
  7539. </para>
  7540. </remarks>
  7541. </member>
  7542. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask">
  7543. <summary>
  7544. Assigns a version label to a revision of the specified versioned files.
  7545. </summary>
  7546. <remarks>
  7547. <para>
  7548. This task uses the <c>label</c> PCLI command to label the items.
  7549. </para>
  7550. </remarks>
  7551. <example>
  7552. <para>
  7553. Labels all files in the project database specified by the <c>project-database</c> property. The label
  7554. applied is <c>Beta</c>.
  7555. </para>
  7556. <code>
  7557. <![CDATA[
  7558. <pvcslabel projectdatabase="${project-database}" versionlabel="Beta" includesubprojects="true">
  7559. <entities>
  7560. <entity name="/"/>
  7561. </entities>
  7562. </pvcslabel>
  7563. ]]>
  7564. </code>
  7565. </example>
  7566. <example>
  7567. <para>
  7568. Labels revision <c>1.8</c> of <c>App.ico</c> as <c>Dodgy</c> in the project database specified by the
  7569. <c>project-database</c> property.
  7570. </para>
  7571. <code>
  7572. <![CDATA[
  7573. <pvcslabel projectdatabase="${project-database}" versionlabel="Dodgy" revision="1.8">
  7574. <entities>
  7575. <entity name="App.ico"/>
  7576. </entities>
  7577. </pvcslabel>
  7578. ]]>
  7579. </code>
  7580. </example>
  7581. </member>
  7582. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._floating">
  7583. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Floating"/>
  7584. </member>
  7585. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._revision">
  7586. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Revision"/>
  7587. </member>
  7588. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._versionLabel">
  7589. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.VersionLabel"/>
  7590. </member>
  7591. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.#ctor">
  7592. <summary>
  7593. Constructs and initializes an instance of <c>PVCSLabel</c>.
  7594. </summary>
  7595. </member>
  7596. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7597. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7598. </member>
  7599. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Floating">
  7600. <summary>
  7601. Gets or sets a value indicating whether the label should "float" to the newest revision.
  7602. </summary>
  7603. <remarks>
  7604. <para>
  7605. This is equivalent to the <c>-f</c> parameter to the <c>pcli label</c> command.
  7606. </para>
  7607. </remarks>
  7608. </member>
  7609. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Revision">
  7610. <summary>
  7611. Gets or sets the revision to label.
  7612. </summary>
  7613. <remarks>
  7614. <para>
  7615. This is equivalent to the <c>-r</c> parameter to the <c>pcli label</c> command.
  7616. </para>
  7617. <para>
  7618. If this property has not yet been set, it will return <c>Double.MaxValue</c>.
  7619. </para>
  7620. </remarks>
  7621. </member>
  7622. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.VersionLabel">
  7623. <summary>
  7624. Gets or sets the version label to assign.
  7625. </summary>
  7626. <remarks>
  7627. <para>
  7628. This is equivalent to the <c>-v</c> parameter to the <c>pcli label</c> command.
  7629. </para>
  7630. </remarks>
  7631. </member>
  7632. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSLockTask">
  7633. <summary>
  7634. Locks a revision of the specified versioned files.
  7635. </summary>
  7636. <remarks>
  7637. <para>
  7638. This task uses the <c>lock</c> PCLI command to lock the versioned files.
  7639. </para>
  7640. </remarks>
  7641. <example>
  7642. <para>
  7643. Locks <c>App.ico</c> in the project database specified by the <c>project-database</c> property.
  7644. </para>
  7645. <code>
  7646. <![CDATA[
  7647. <pvcslock projectdatabase="${project-database}">
  7648. <entities>
  7649. <entity name="/App.ico"/>
  7650. </entities>
  7651. </pvcslock>
  7652. ]]>
  7653. </code>
  7654. </example>
  7655. <example>
  7656. <para>
  7657. Locks all files at and below <c>folder</c> in the project database specified by the <c>project-database</c>
  7658. property.
  7659. </para>
  7660. <code>
  7661. <![CDATA[
  7662. <pvcslock projectdatabase="${project-database}" includesubprojects="true">
  7663. <entities>
  7664. <entity name="/folder"/>
  7665. </entities>
  7666. </pvcslock>
  7667. ]]>
  7668. </code>
  7669. </example>
  7670. </member>
  7671. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._noBranching">
  7672. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoBranching"/>
  7673. </member>
  7674. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._noMultilock">
  7675. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoMultilock"/>
  7676. </member>
  7677. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._promotionGroup">
  7678. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.PromotionGroup"/>
  7679. </member>
  7680. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._revision">
  7681. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.Revision"/>
  7682. </member>
  7683. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._yesToBranching">
  7684. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToBranching"/>
  7685. </member>
  7686. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._yesToMultilock">
  7687. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToMultilock"/>
  7688. </member>
  7689. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.#ctor">
  7690. <summary>
  7691. Constructs and initializes an instance of <c>PVCSLock</c>.
  7692. </summary>
  7693. </member>
  7694. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7695. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7696. </member>
  7697. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoBranching">
  7698. <summary>
  7699. Gets or sets a value indicating whether locking files will take place if checking in those files would
  7700. result in a branch.
  7701. </summary>
  7702. <remarks>
  7703. <para>
  7704. This is equivalent to the <c>-nb</c> parameter to the <c>pcli lock</c> command.
  7705. </para>
  7706. </remarks>
  7707. </member>
  7708. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoMultilock">
  7709. <summary>
  7710. Gets or sets a value indicating whether already locked revisions will be locked.
  7711. </summary>
  7712. <remarks>
  7713. <para>
  7714. This is equivalent to the <c>-nm</c> parameter to the <c>pcli lock</c> command.
  7715. </para>
  7716. </remarks>
  7717. </member>
  7718. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.PromotionGroup">
  7719. <summary>
  7720. Gets or sets the promotion group to assign the locked revision.
  7721. </summary>
  7722. <remarks>
  7723. <para>
  7724. This is equivalent to the <c>-g</c> parameter to the <c>pcli lock</c> command.
  7725. </para>
  7726. </remarks>
  7727. </member>
  7728. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.Revision">
  7729. <summary>
  7730. Gets or sets the revision to lock.
  7731. </summary>
  7732. <remarks>
  7733. <para>
  7734. This is equivalent to the <c>-r</c> parameter to the <c>pcli lock</c> command.
  7735. </para>
  7736. <para>
  7737. If this property has not yet been set, it will return <c>Double.MaxValue</c>.
  7738. </para>
  7739. </remarks>
  7740. </member>
  7741. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToBranching">
  7742. <summary>
  7743. Gets or sets a value indicating whether revisions will be locked even if that will result in a branch
  7744. upon check in.
  7745. </summary>
  7746. <remarks>
  7747. <para>
  7748. This is equivalent to the <c>-yb</c> parameter to the <c>pcli lock</c> command.
  7749. </para>
  7750. </remarks>
  7751. </member>
  7752. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToMultilock">
  7753. <summary>
  7754. Gets or sets a value indicating whether revisions will be locked even if that will result in multiple
  7755. locks against the same revision.
  7756. </summary>
  7757. <remarks>
  7758. <para>
  7759. This is equivalent to the <c>-ym</c> parameter to the <c>pcli lock</c> command.
  7760. </para>
  7761. </remarks>
  7762. </member>
  7763. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask">
  7764. <summary>
  7765. Promotes versioned files to the next promotion group.
  7766. </summary>
  7767. <remarks>
  7768. <para>
  7769. This task uses the <c>promotegroup</c> PCLI command to promote versioned files.
  7770. </para>
  7771. </remarks>
  7772. <example>
  7773. <para>
  7774. Promotes all files in the root of the project database specified by the <c>project-database</c> property.
  7775. The files are promoted from the <c>DEV</c> promotion group to the next. Promotion will not take place across
  7776. branches.
  7777. </para>
  7778. <code>
  7779. <![CDATA[
  7780. <pvcspromotegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/" acrossbranches="false"/>
  7781. ]]>
  7782. </code>
  7783. </example>
  7784. <example>
  7785. <para>
  7786. Promotes all files in the project database specified by the <c>project-database</c> property. The files are
  7787. promoted from the <c>SYSTEST</c> promotion group to the next. Promotion will take place across branches.
  7788. </para>
  7789. <code>
  7790. <![CDATA[
  7791. <pvcspromotegroup projectdatabase="${project-database}" promotiongroup="SYSTEST" entity="/" includesubprojects="true" acrossbranches="true"/>
  7792. ]]>
  7793. </code>
  7794. </example>
  7795. </member>
  7796. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask._acrossBrances">
  7797. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AcrossBranches"/>
  7798. </member>
  7799. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask._promotionGroup">
  7800. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.PromotionGroup"/>
  7801. </member>
  7802. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7803. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7804. </member>
  7805. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AcrossBranches">
  7806. <summary>
  7807. Gets or sets a value indicating whether the promotion may occur across branches.
  7808. </summary>
  7809. <remarks>
  7810. <para>
  7811. This is equivalent to the <c>-nb</c> and <c>-yb</c> parameters to the <c>pcli promotegroup</c> command.
  7812. </para>
  7813. </remarks>
  7814. </member>
  7815. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.PromotionGroup">
  7816. <summary>
  7817. Gets or sets the promotion group to be promoted.
  7818. </summary>
  7819. <remarks>
  7820. <para>
  7821. This is equivalent to the <c>-g</c> parameter to the <c>pcli promotegroup</c> command.
  7822. </para>
  7823. </remarks>
  7824. </member>
  7825. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSPutTask">
  7826. <summary>
  7827. Puts files into a PVCS repository.
  7828. </summary>
  7829. <remarks>
  7830. <para>
  7831. This task uses the <c>put</c> PCLI command to put the files into PVCS.
  7832. </para>
  7833. </remarks>
  7834. <example>
  7835. <para>
  7836. Puts the file called <c>App.ico</c> into the project database specified by the <c>project-database</c>
  7837. property. The description for the change is <c>Added more colour</c>.
  7838. </para>
  7839. <code>
  7840. <![CDATA[
  7841. <pvcsput projectdatabase="${project-database}" description="Added more colour">
  7842. <entities>
  7843. <entity name="/App.ico"/>
  7844. </entities>
  7845. </pvcsput>
  7846. ]]>
  7847. </code>
  7848. </example>
  7849. <example>
  7850. <para>
  7851. Puts all files into the project database specified by the <c>project-database</c> property. The description
  7852. for the changes is <c>Major changes</c>. Even if the workfiles have not been changed, they will result in a
  7853. new revision in PVCS.
  7854. </para>
  7855. <code>
  7856. <![CDATA[
  7857. <pvcsput projectdatabase="${project-database}" description="Major changes" checkinunchanged="true" includesubprojects="true">
  7858. <entities>
  7859. <entity name="/"/>
  7860. </entities>
  7861. </pvcsput>
  7862. ]]>
  7863. </code>
  7864. </example>
  7865. <example>
  7866. <para>
  7867. Puts <c>file.txt</c> and all files in <c>folder</c> into the project database specified by the
  7868. <c>project-database</c> property. The description for the changes is <c>Some changes</c>. A new branch is
  7869. forcibly created via the <c>forcebranch</c> attribute. Leading and trailing whitespace is ignored when
  7870. determining whether the workfile has been altered.
  7871. </para>
  7872. <code>
  7873. <![CDATA[
  7874. <pvcsput projectdatabase="${project-database}" description="Some changes" forcebranch="true" ignorespaces="true">
  7875. <entities>
  7876. <entity name="/folder"/>
  7877. <entity name="/file.txt"/>
  7878. </entities>
  7879. </pvcsput>
  7880. ]]>
  7881. </code>
  7882. </example>
  7883. </member>
  7884. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._baseProjectPath">
  7885. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.BaseProjectPath"/>
  7886. </member>
  7887. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._checkInUnchanged">
  7888. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.CheckInUnchanged"/>
  7889. </member>
  7890. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._description">
  7891. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Description"/>
  7892. </member>
  7893. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._floatLabel">
  7894. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.FloatLabel"/>
  7895. </member>
  7896. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._forceBranch">
  7897. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ForceBranch"/>
  7898. </member>
  7899. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._ignoreSpaces">
  7900. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.IgnoreSpaces"/>
  7901. </member>
  7902. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._keepWorkfile">
  7903. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.KeepWorkfile"/>
  7904. </member>
  7905. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._location">
  7906. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Location"/>
  7907. </member>
  7908. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._lock">
  7909. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Lock"/>
  7910. </member>
  7911. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._overrideWorkfileLocation">
  7912. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.OverrideWorkfileLocation"/>
  7913. </member>
  7914. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._promotionGroup">
  7915. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.PromotionGroup"/>
  7916. </member>
  7917. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._reassignLabelIfExists">
  7918. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ReassignLabelIfExists"/>
  7919. </member>
  7920. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._revision">
  7921. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Revision"/>
  7922. </member>
  7923. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._useSameDescription">
  7924. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.UseSameDescription"/>
  7925. </member>
  7926. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._versionLabel">
  7927. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
  7928. </member>
  7929. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.#ctor">
  7930. <summary>
  7931. Constructs and initializes an instance of <c>PVCSPut</c>.
  7932. </summary>
  7933. </member>
  7934. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  7935. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  7936. </member>
  7937. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.BaseProjectPath">
  7938. <summary>
  7939. Gets or sets the base project path.
  7940. </summary>
  7941. <remarks>
  7942. <para>
  7943. This is equivalent to the <c>-bp</c> parameter to the <c>pcli put</c> command.
  7944. </para>
  7945. </remarks>
  7946. </member>
  7947. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.CheckInUnchanged">
  7948. <summary>
  7949. Gets or sets a value indicating whether unchanged workfiles should be checked in.
  7950. </summary>
  7951. <remarks>
  7952. <para>
  7953. This is equivalent to the <c>-yf</c> parameter to the <c>pcli put</c> command.
  7954. </para>
  7955. </remarks>
  7956. </member>
  7957. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Description">
  7958. <summary>
  7959. Gets or sets the description to be applied to the checked in revisions.
  7960. </summary>
  7961. <remarks>
  7962. <para>
  7963. This is equivalent to the <c>-m</c> parameter to the <c>pcli put</c> command.
  7964. </para>
  7965. </remarks>
  7966. </member>
  7967. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.FloatLabel">
  7968. <summary>
  7969. Gets or sets a value indicating whether the version label specified by <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
  7970. should float.
  7971. </summary>
  7972. <remarks>
  7973. <para>
  7974. This is equivalent to the <c>-fv</c> parameter to the <c>pcli put</c> command.
  7975. </para>
  7976. </remarks>
  7977. </member>
  7978. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ForceBranch">
  7979. <summary>
  7980. Gets or sets a value indicating whether a new branch will be created.
  7981. </summary>
  7982. <remarks>
  7983. <para>
  7984. This is equivalent to the <c>-fb</c> parameter to the <c>pcli put</c> command.
  7985. </para>
  7986. </remarks>
  7987. </member>
  7988. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.IgnoreSpaces">
  7989. <summary>
  7990. Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining
  7991. whether the revision has changed.
  7992. </summary>
  7993. <remarks>
  7994. <para>
  7995. This is equivalent to the <c>-b</c> parameter to the <c>pcli put</c> command.
  7996. </para>
  7997. </remarks>
  7998. </member>
  7999. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.KeepWorkfile">
  8000. <summary>
  8001. Gets or sets a value indicating whether the workfile should kept in its original state.
  8002. </summary>
  8003. <remarks>
  8004. <para>
  8005. This is equivalent to the <c>-k</c> parameter to the <c>pcli put</c> command.
  8006. </para>
  8007. </remarks>
  8008. </member>
  8009. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Location">
  8010. <summary>
  8011. Gets or sets an alternative location for workfiles.
  8012. </summary>
  8013. <remarks>
  8014. <para>
  8015. This is equivalent to the <c>-a</c> parameter to the <c>pcli put</c> command.
  8016. </para>
  8017. </remarks>
  8018. </member>
  8019. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Lock">
  8020. <summary>
  8021. Gets or sets a value indicating the files should be locked after the put operation.
  8022. </summary>
  8023. <remarks>
  8024. <para>
  8025. This is equivalent to the <c>-l</c> parameter to the <c>pcli put</c> command.
  8026. </para>
  8027. </remarks>
  8028. </member>
  8029. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.OverrideWorkfileLocation">
  8030. <summary>
  8031. Gets or sets a value indicating whether the workfile location for files should be overridden.
  8032. </summary>
  8033. <remarks>
  8034. <para>
  8035. This is equivalent to the <c>-o</c> parameter to the <c>pcli put</c> command.
  8036. </para>
  8037. </remarks>
  8038. </member>
  8039. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.PromotionGroup">
  8040. <summary>
  8041. Gets or sets the promotion in use. If a promotion group is specified, this option identifies the
  8042. promotion group to which the revision is currently assigned. If no promotion group is specified (ie.
  8043. this property is set to an empty string), this option indicates that one is not identifying the
  8044. revision by promotion group.
  8045. </summary>
  8046. <remarks>
  8047. <para>
  8048. This is equivalent to the <c>-g</c> parameter to the <c>pcli put</c> command.
  8049. </para>
  8050. </remarks>
  8051. </member>
  8052. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ReassignLabelIfExists">
  8053. <summary>
  8054. Gets or sets a value indicating whether the version label specified by <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
  8055. should be reassigned if it already exists.
  8056. </summary>
  8057. <remarks>
  8058. <para>
  8059. This is equivalent to the <c>-yv</c> parameter to the <c>pcli put</c> command.
  8060. </para>
  8061. </remarks>
  8062. </member>
  8063. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Revision">
  8064. <summary>
  8065. Gets or sets the revision number to use for the new revision.
  8066. </summary>
  8067. <remarks>
  8068. <para>
  8069. This is equivalent to the <c>-r</c> parameter to the <c>pcli put</c> command.
  8070. </para>
  8071. </remarks>
  8072. </member>
  8073. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.UseSameDescription">
  8074. <summary>
  8075. Gets or sets a value indicating whether the same description should be used for all versioned items.
  8076. This is <c>true</c> by default.
  8077. </summary>
  8078. <remarks>
  8079. <para>
  8080. This is equivalent to the <c>-ym</c> parameter to the <c>pcli put</c> command.
  8081. </para>
  8082. </remarks>
  8083. </member>
  8084. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel">
  8085. <summary>
  8086. Gets or sets the version label to assign to the new revisions.
  8087. </summary>
  8088. <remarks>
  8089. <para>
  8090. This is equivalent to the <c>-v</c> parameter to the <c>pcli put</c> command.
  8091. </para>
  8092. </remarks>
  8093. </member>
  8094. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask">
  8095. <summary>
  8096. Renames a label in a PVCS repository.
  8097. </summary>
  8098. <remarks>
  8099. <para>
  8100. This task uses the <c>renamelabel</c> PCLI command to rename the label.
  8101. </para>
  8102. </remarks>
  8103. <example>
  8104. <para>
  8105. Renames the label on <c>App.ico</c> from <c>Beater</c> to <c>Beta</c> in the project database specified by
  8106. the <c>project-database</c> property.
  8107. </para>
  8108. <code>
  8109. <![CDATA[
  8110. <pvcsrenamelabel projectdatabase="${project-database}" from="Beater" to="Beta">
  8111. <entities>
  8112. <entity name="App.ico"/>
  8113. </entities>
  8114. </pvcsrenamelabel>
  8115. ]]>
  8116. </code>
  8117. </example>
  8118. <example>
  8119. <para>
  8120. Renames the label on all files from <c>Alfa</c> to <c>Alpha</c> in the project database specified by the
  8121. <c>project-database</c> property.
  8122. </para>
  8123. <code>
  8124. <![CDATA[
  8125. <pvcsrenamelabel projectdatabase="${project-database}" from="Alfa" to="Alpha" includesubprojects="true">
  8126. <entities>
  8127. <entity name="/"/>
  8128. </entities>
  8129. </pvcsrenamelabel>
  8130. ]]>
  8131. </code>
  8132. </example>
  8133. </member>
  8134. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask._from">
  8135. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.From"/>
  8136. </member>
  8137. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask._to">
  8138. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.To"/>
  8139. </member>
  8140. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  8141. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  8142. </member>
  8143. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.From">
  8144. <summary>
  8145. Gets or sets the existing label.
  8146. </summary>
  8147. <remarks>
  8148. <para>
  8149. This is equivalent to the <c>-vf</c> parameter to the <c>pcli renamelabel</c> command.
  8150. </para>
  8151. </remarks>
  8152. </member>
  8153. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.To">
  8154. <summary>
  8155. Gets or sets the new label.
  8156. </summary>
  8157. <remarks>
  8158. <para>
  8159. This is equivalent to the <c>-vt</c> parameter to the <c>pcli renamelabel</c> command.
  8160. </para>
  8161. </remarks>
  8162. </member>
  8163. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask">
  8164. <summary>
  8165. Unlocks revisions of versioned files in a PVCS repository.
  8166. </summary>
  8167. <remarks>
  8168. <para>
  8169. This task uses the <c>unlock</c> PCLI command to perform the unlock operation.
  8170. </para>
  8171. </remarks>
  8172. <example>
  8173. <para>
  8174. Unlocks <c>App.ico</c> in the project database specified by the <c>project-database</c> property.
  8175. </para>
  8176. <code>
  8177. <![CDATA[
  8178. <pvcsunlock projectdatabase="${project-database}">
  8179. <entities>
  8180. <entity name="/App.ico"/>
  8181. </entities>
  8182. </pvcsunlock>
  8183. ]]>
  8184. </code>
  8185. </example>
  8186. <example>
  8187. <para>
  8188. Unlocks all files in the project specified by the <c>project-database</c> property. Locks by all users are
  8189. removed.
  8190. </para>
  8191. <code>
  8192. <![CDATA[
  8193. <pvcsunlock projectdatabase="${project-database}" includesubprojects="true" unlockmode="AllUsers">
  8194. <entities>
  8195. <entity name="/"/>
  8196. </entities>
  8197. </pvcsunlock>
  8198. ]]>
  8199. </code>
  8200. </example>
  8201. </member>
  8202. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._revision">
  8203. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.Revision"/>
  8204. </member>
  8205. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._unlockMode">
  8206. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode"/>
  8207. </member>
  8208. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._user">
  8209. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.User"/>
  8210. </member>
  8211. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.#ctor">
  8212. <summary>
  8213. Constructs and initializes an instance of <c>PVCSUnlock</c>.
  8214. </summary>
  8215. </member>
  8216. <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
  8217. <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
  8218. </member>
  8219. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.Revision">
  8220. <summary>
  8221. Gets or sets the revision number to use for the new revision.
  8222. </summary>
  8223. <remarks>
  8224. <para>
  8225. This is equivalent to the <c>-r</c> parameter to the <c>pcli unlock</c> command.
  8226. </para>
  8227. </remarks>
  8228. </member>
  8229. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode">
  8230. <summary>
  8231. Gets or sets the unlock mode for the operation.
  8232. </summary>
  8233. <remarks>
  8234. <para>
  8235. This is equivalent to the <c>-u</c> parameter to the <c>pcli unlock</c> command.
  8236. </para>
  8237. </remarks>
  8238. </member>
  8239. <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.User">
  8240. <summary>
  8241. Gets or sets the user whose locked files are to be unlocked. This is relevant only when
  8242. <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode"/> is set to <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser"/>.
  8243. </summary>
  8244. </member>
  8245. <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode">
  8246. <summary>
  8247. Specifies possible modes for the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask"/> task.
  8248. </summary>
  8249. </member>
  8250. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.CurrentUser">
  8251. <summary>
  8252. All locks held by the current user are removed.
  8253. </summary>
  8254. </member>
  8255. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser">
  8256. <summary>
  8257. All locks held by a specified user are removed.
  8258. </summary>
  8259. </member>
  8260. <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.AllUsers">
  8261. <summary>
  8262. All locks held by all users are removed.
  8263. </summary>
  8264. </member>
  8265. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Add">
  8266. <summary>
  8267. Open file(s) in a client workspace for addition to the depot.
  8268. </summary>
  8269. <example>
  8270. <para>
  8271. Add all cs files under the given directory into the "new" changelist
  8272. (will be created if it doesn't already exist).
  8273. </para>
  8274. <code>
  8275. <![CDATA[
  8276. <p4add file="C:\Src\Project\*.cs" changelist="new" />
  8277. ]]>
  8278. </code>
  8279. </example>
  8280. <example>
  8281. <para>Add Test.txt into the default changelist.</para>
  8282. <code>
  8283. <![CDATA[
  8284. <p4add file="C:\Src\Project\Test.txt" />
  8285. ]]>
  8286. </code>
  8287. </example>
  8288. </member>
  8289. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Base">
  8290. <summary>
  8291. Base class for Perforce (P4) NAnt tasks. See individual task for example usage.
  8292. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Add">P4Add</seealso>
  8293. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Change">P4Change</seealso>
  8294. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Delete">P4Delete</seealso>
  8295. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Edit">P4Edit</seealso>
  8296. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Label">P4Label</seealso>
  8297. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Labelsync">P4Labelsync</seealso>
  8298. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Print">P4Print</seealso>
  8299. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Reopen">P4Reopen</seealso>
  8300. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Revert">P4Revert</seealso>
  8301. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Submit">P4Submit</seealso>
  8302. <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Sync">P4Sync</seealso>
  8303. </summary>
  8304. </member>
  8305. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Base.ExecuteTask">
  8306. <summary>
  8307. Execute the perforce command assembled by subclasses.
  8308. </summary>
  8309. </member>
  8310. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Port">
  8311. <summary>
  8312. The p4 server and port to connect to. The default is "perforce:1666".
  8313. </summary>
  8314. </member>
  8315. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Client">
  8316. <summary>
  8317. The p4 client spec to use. The default is the current client.
  8318. </summary>
  8319. </member>
  8320. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.User">
  8321. <summary>
  8322. The p4 username. The default is the current user.
  8323. </summary>
  8324. </member>
  8325. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.View">
  8326. <summary>
  8327. The client, branch or label view to operate upon. The default is
  8328. "//...".
  8329. </summary>
  8330. </member>
  8331. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Script">
  8332. <summary>
  8333. Prepends a descriptive field (for example, text:, info:, error:, exit:)
  8334. to each line of output produced by a Perforce command. This is most
  8335. often used when scripting. The default is <see langword="false" />.
  8336. </summary>
  8337. </member>
  8338. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.ProgramArguments">
  8339. <summary>
  8340. Gets the command line arguments for the external program.
  8341. </summary>
  8342. <value>
  8343. The command line arguments for the external program.
  8344. </value>
  8345. </member>
  8346. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.ExeName">
  8347. <summary>
  8348. Override the ExeName paramater for p4.exe
  8349. </summary>
  8350. </member>
  8351. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.CommandSpecificArguments">
  8352. <summary>
  8353. Derived classes should override this to provide command-specific
  8354. commandline arguments.
  8355. </summary>
  8356. </member>
  8357. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Add.getSpecificCommandArguments">
  8358. <summary>
  8359. Build the command string for this particular command.
  8360. </summary>
  8361. <returns>
  8362. The command string for this particular command.
  8363. </returns>
  8364. </member>
  8365. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.File">
  8366. <summary>
  8367. File(s) to add. File name can contain wildcard characters. (Note:
  8368. this is not using p4 wildcard syntax, but the OS wildcards).
  8369. </summary>
  8370. </member>
  8371. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.Changelist">
  8372. <summary>
  8373. Changelist that files will be added into. Changelist will be created
  8374. if not already present.
  8375. </summary>
  8376. </member>
  8377. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.Type">
  8378. <summary>
  8379. File Type settings. Applied to all files in the <see cref="P:NAnt.Contrib.Tasks.Perforce.P4Add.File"/>
  8380. parameter.
  8381. </summary>
  8382. </member>
  8383. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.CommandSpecificArguments">
  8384. <summary>
  8385. This is an override used by the base class to get command specific args.
  8386. </summary>
  8387. </member>
  8388. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Change">
  8389. <summary>
  8390. Create or delete a changelist specification.
  8391. </summary>
  8392. <example>
  8393. <para>Create a new changelist called "mynewchange".</para>
  8394. <code>
  8395. <![CDATA[
  8396. <p4change changelist="mynewchange" />
  8397. ]]>
  8398. </code>
  8399. </example>
  8400. <example>
  8401. <para>Delete the changelist called "mynewchange".</para>
  8402. <code>
  8403. <![CDATA[
  8404. <p4change changelist="mynewchange" delete="true" />
  8405. ]]>
  8406. </code>
  8407. </example>
  8408. </member>
  8409. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Change.getSpecificCommandArguments">
  8410. <summary>
  8411. Builds the command string for this particular command.
  8412. </summary>
  8413. <returns>
  8414. The command string for this particular command.
  8415. </returns>
  8416. </member>
  8417. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.Changelist">
  8418. <summary>
  8419. Changelist to create or delete.
  8420. </summary>
  8421. </member>
  8422. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.Delete">
  8423. <summary>
  8424. If <see langword="false" /> causes passed in changelist to be
  8425. deleted. The default is <see langword="false" />.
  8426. </summary>
  8427. </member>
  8428. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.CommandSpecificArguments">
  8429. <summary>
  8430. This is an override used by the base class to get command specific args.
  8431. </summary>
  8432. </member>
  8433. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Client">
  8434. <summary>
  8435. Add/modify/delete a client spec in perforce.
  8436. </summary>
  8437. <example>
  8438. <para>
  8439. Add a client (modify if already present and have sufficient rights).
  8440. </para>
  8441. <code>
  8442. <![CDATA[
  8443. <p4client clientname="myClient" view="//root/test/..." />
  8444. ]]>
  8445. </code>
  8446. </example>
  8447. <example>
  8448. <para>Delete a client.</para>
  8449. <code>
  8450. <![CDATA[
  8451. <p4client delete="true" clientname="myClient" />
  8452. ]]>
  8453. </code>
  8454. </example>
  8455. </member>
  8456. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Client.getSpecificCommandArguments">
  8457. <summary>
  8458. Builds the command string for this particular command.
  8459. </summary>
  8460. <returns>
  8461. The command string for this particular command.
  8462. </returns>
  8463. </member>
  8464. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.ClientName">
  8465. <summary>
  8466. Name of client to create/delete.
  8467. </summary>
  8468. </member>
  8469. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Root">
  8470. <summary>
  8471. Root path for client spec.
  8472. </summary>
  8473. </member>
  8474. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Delete">
  8475. <summary>
  8476. Delete the named client. The default is <see langword="false" />.
  8477. </summary>
  8478. </member>
  8479. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Force">
  8480. <summary>
  8481. Force a delete even if files are open. The default is
  8482. <see langword="false" />.
  8483. </summary>
  8484. </member>
  8485. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.CommandSpecificArguments">
  8486. <summary>
  8487. This is an override used by the base class to get command specific args.
  8488. </summary>
  8489. </member>
  8490. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Delete">
  8491. <summary>
  8492. Open file(s) in a client workspace for deletion from the depot.
  8493. </summary>
  8494. <example>
  8495. <para>
  8496. Mark all cs files under the give view for deletion and place them in
  8497. the "Deleting" changelist.
  8498. </para>
  8499. <code>
  8500. <![CDATA[
  8501. <p4delete view="//Root/ProjectX/Test/...*.cs" changelist="Deleting" />
  8502. ]]>
  8503. </code>
  8504. </example>
  8505. </member>
  8506. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Delete.getSpecificCommandArguments">
  8507. <summary>
  8508. Builds the command string for this particular command.
  8509. </summary>
  8510. <returns>
  8511. The command string for this particular command.
  8512. </returns>
  8513. </member>
  8514. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.Changelist">
  8515. <summary>
  8516. Changelist to place the marked for deletion item into.
  8517. </summary>
  8518. </member>
  8519. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.View">
  8520. <summary>
  8521. The client, branch or label view to operate upon.
  8522. </summary>
  8523. </member>
  8524. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.CommandSpecificArguments">
  8525. <summary>
  8526. This is an override used by the base class to get command specific args.
  8527. </summary>
  8528. </member>
  8529. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Edit">
  8530. <summary>
  8531. Opens file(s) in a client workspace for edit.
  8532. </summary>
  8533. <example>
  8534. <para>
  8535. Open all files in the ProjectX Test folder for edit, and place into
  8536. the default changelist.
  8537. </para>
  8538. <code>
  8539. <![CDATA[
  8540. <p4edit view="//Root/ProjectX/Test/..." />
  8541. ]]>
  8542. </code>
  8543. </example>
  8544. <example>
  8545. <para>
  8546. Open all *.txt files in the ProjectX Test folder for edit, and place
  8547. into the "testing" changelist.
  8548. </para>
  8549. <code>
  8550. <![CDATA[
  8551. <p4edit view="//Root/ProjectX/Test/...*.txt" changelist="testing" />
  8552. ]]>
  8553. </code>
  8554. </example>
  8555. </member>
  8556. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Edit.getSpecificCommandArguments">
  8557. <summary>
  8558. Builds the command string for this particular command.
  8559. </summary>
  8560. <returns>
  8561. The command string for this particular command.
  8562. </returns>
  8563. </member>
  8564. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.Changelist">
  8565. <summary>
  8566. Changelist to place the opened files into.
  8567. </summary>
  8568. </member>
  8569. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.Type">
  8570. <summary>
  8571. File Type settings.
  8572. </summary>
  8573. </member>
  8574. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.View">
  8575. <summary>
  8576. The client, branch or label view to operate upon.
  8577. </summary>
  8578. </member>
  8579. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.CommandSpecificArguments">
  8580. <summary>
  8581. This is an override used by the base class to get command specific args.
  8582. </summary>
  8583. </member>
  8584. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Info">
  8585. <summary>
  8586. Returns information from the "p4 info" command back into variables for
  8587. use within the build process.
  8588. </summary>
  8589. <example>
  8590. <para>Fill the variables using the task.</para>
  8591. <code>
  8592. <![CDATA[
  8593. <p4info user="myuser" client="myclient" host="myhost" root="myroot" />
  8594. <echo message="User: ${myuser} - Client: ${myclient} - Host: ${myhost} - Root: ${myroot}" />
  8595. ]]>
  8596. </code>
  8597. </example>
  8598. </member>
  8599. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.User">
  8600. <summary>
  8601. The name of the property to store the p4 user name in.
  8602. </summary>
  8603. </member>
  8604. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Client">
  8605. <summary>
  8606. The name of the property to store the p4 client name in.
  8607. </summary>
  8608. </member>
  8609. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Host">
  8610. <summary>
  8611. The name of the property to store the p4 host name in.
  8612. </summary>
  8613. </member>
  8614. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Root">
  8615. <summary>
  8616. The name of the property to store the p4 client root in.
  8617. </summary>
  8618. </member>
  8619. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Label">
  8620. <summary>
  8621. Create or edit a label specification and its view.
  8622. </summary>
  8623. <example>
  8624. <para>Create a new label called "SDK_V1.2".</para>
  8625. <code>
  8626. <![CDATA[
  8627. <p4label label="SDK_V1.2" view="//Root/ProjectX/Test/...*.txt" />
  8628. ]]>
  8629. </code>
  8630. </example>
  8631. <example>
  8632. <para>Delete the previously created label.</para>
  8633. <code>
  8634. <![CDATA[
  8635. <p4label label="SDK_V1.2" delete="true" />
  8636. ]]>
  8637. </code>
  8638. </example>
  8639. </member>
  8640. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Label.getSpecificCommandArguments">
  8641. <summary>
  8642. Builds the command string for this particular command.
  8643. </summary>
  8644. <returns>
  8645. The command string for this particular command.
  8646. </returns>
  8647. </member>
  8648. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.Label">
  8649. <summary>
  8650. Name of label to create/delete.
  8651. </summary>
  8652. </member>
  8653. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.Delete">
  8654. <summary>
  8655. Delete the named label. The default is <see langword="false" />.
  8656. </summary>
  8657. </member>
  8658. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.CommandSpecificArguments">
  8659. <summary>
  8660. This is an override used by the base class to get command specific args.
  8661. </summary>
  8662. </member>
  8663. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Labelsync">
  8664. <summary>
  8665. Synchronize a label with the contents of the current client workspace.
  8666. </summary>
  8667. <example>
  8668. <para>Apply a previously created label to the specified view.</para>
  8669. <code>
  8670. <![CDATA[
  8671. <p4labelsync label="SDK_V1.2" view="//Root/..." />
  8672. ]]>
  8673. </code>
  8674. </example>
  8675. </member>
  8676. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Labelsync.getSpecificCommandArguments">
  8677. <summary>
  8678. Builds the command string for this particular command.
  8679. </summary>
  8680. <returns>
  8681. The command string for this particular command.
  8682. </returns>
  8683. </member>
  8684. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.Label">
  8685. <summary>
  8686. Name of the label to sync the specified or default view with.
  8687. </summary>
  8688. </member>
  8689. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.Delete">
  8690. <summary>
  8691. Delete the view defined in the label, or matching the input view
  8692. from the label. The default is <see langword="false" />.
  8693. </summary>
  8694. </member>
  8695. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.CommandSpecificArguments">
  8696. <summary>
  8697. This is an override used by the base class to get command specific args.
  8698. </summary>
  8699. </member>
  8700. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Print">
  8701. <summary>
  8702. Fetch a specific file from a Perforce depot without needing a clientspec
  8703. to map it.
  8704. </summary>
  8705. <example>
  8706. <code>
  8707. <![CDATA[
  8708. <p4print file="//depot/foo/mainline/clientspec" outputfile=".\clientspec" />
  8709. <p4client input=".\clientspec" />
  8710. ]]>
  8711. </code>
  8712. </example>
  8713. </member>
  8714. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Print.getSpecificCommandArguments">
  8715. <summary>
  8716. Builds the command string for this particular command.
  8717. </summary>
  8718. <returns>
  8719. The command string for this particular command.
  8720. </returns>
  8721. </member>
  8722. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.File">
  8723. <summary>
  8724. The depot or local filename (including optional path) of the file
  8725. to fetch.
  8726. </summary>
  8727. </member>
  8728. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.P4OutputFile">
  8729. <summary>
  8730. The local filename to write the fetched file to.
  8731. </summary>
  8732. </member>
  8733. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.CommandSpecificArguments">
  8734. <summary>
  8735. This is an override used by the base class to get command specific args.
  8736. </summary>
  8737. </member>
  8738. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Reopen">
  8739. <summary>
  8740. Move opened files between changelists or change the files’ type.
  8741. </summary>
  8742. <remarks>
  8743. This task has two different but related uses:
  8744. Moving opened files between changelists (default or named).
  8745. Changing the type of an opened file.
  8746. </remarks>
  8747. <example>
  8748. <para>
  8749. Move the specified files matching the view into the "New" changelist.
  8750. </para>
  8751. <code>
  8752. <![CDATA[
  8753. <p4reopen view="//Root/...Version.xml" changelist="New" />
  8754. ]]>
  8755. </code>
  8756. </example>
  8757. <example>
  8758. <para>
  8759. Modify the specified files matching the view to the given file type.
  8760. The change won't affect the repository until submitted.
  8761. </para>
  8762. <code>
  8763. <![CDATA[
  8764. <p4reopen view="//Root/...*.res" type="binary" />
  8765. ]]>
  8766. </code>
  8767. </example>
  8768. </member>
  8769. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Reopen.getSpecificCommandArguments">
  8770. <summary>
  8771. Builds the command string for this particular command.
  8772. </summary>
  8773. <returns>
  8774. The command string for this particular command.
  8775. </returns>
  8776. </member>
  8777. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.View">
  8778. <summary>
  8779. The client, branch or label view to operate upon.
  8780. </summary>
  8781. </member>
  8782. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.Changelist">
  8783. <summary>
  8784. Changelist to place the reopened files into.
  8785. </summary>
  8786. </member>
  8787. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.Type">
  8788. <summary>
  8789. File Type settings.
  8790. </summary>
  8791. </member>
  8792. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.CommandSpecificArguments">
  8793. <summary>
  8794. This is an override used by the base class to get command specific args.
  8795. </summary>
  8796. </member>
  8797. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Revert">
  8798. <summary>
  8799. Discard changes made to open files.
  8800. </summary>
  8801. <example>
  8802. <para>Revert all txt files in a given changelist.</para>
  8803. <code>
  8804. <![CDATA[
  8805. <p4revert changelist="Test" view="//...*.txt" />
  8806. ]]>
  8807. </code>
  8808. </example>
  8809. <example>
  8810. <para>
  8811. Revert all unchanged files opened in the given changelist.
  8812. </para>
  8813. <code>
  8814. <![CDATA[
  8815. <p4revert changelist="Test" revertunchanged="true" />
  8816. ]]>
  8817. </code>
  8818. </example>
  8819. <example>
  8820. <para>Revert all unchanged files opened in any changelist.</para>
  8821. <code>
  8822. <![CDATA[
  8823. <p4revert revertunchanged="true" />
  8824. ]]>
  8825. </code>
  8826. </example>
  8827. </member>
  8828. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Revert.getSpecificCommandArguments">
  8829. <summary>
  8830. Builds the command string for this particular command.
  8831. </summary>
  8832. <returns>
  8833. The command string for this particular command.
  8834. </returns>
  8835. </member>
  8836. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.Changelist">
  8837. <summary>
  8838. Changelist to perform the revert action on. optional.
  8839. </summary>
  8840. </member>
  8841. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.RevertUnchanged">
  8842. <summary>
  8843. Revert all unchanged or missing files from the changelist. default is false. optional.
  8844. </summary>
  8845. </member>
  8846. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.CommandSpecificArguments">
  8847. <summary>
  8848. This is an override used by the base class to get command specific args.
  8849. </summary>
  8850. </member>
  8851. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Set">
  8852. <summary>
  8853. Set registry variables that perforce uses.
  8854. </summary>
  8855. <remarks>
  8856. Note: the environment variables that p4 uses will be set, but will not
  8857. be validated.
  8858. </remarks>
  8859. <example>
  8860. <para>Modify any of the three variables (at least one required).</para>
  8861. <code>
  8862. <![CDATA[
  8863. <p4set client="myClient" user="jonb" port="server:1666" />
  8864. ]]>
  8865. </code>
  8866. </example>
  8867. </member>
  8868. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Set.getSpecificCommandArguments">
  8869. <summary>
  8870. Builds the command string for this particular command.
  8871. </summary>
  8872. <returns>
  8873. The command string for this particular command.
  8874. </returns>
  8875. </member>
  8876. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Set.CommandSpecificArguments">
  8877. <summary>
  8878. This is an override used by the base class to get command specific args.
  8879. </summary>
  8880. </member>
  8881. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Submit">
  8882. <summary>
  8883. Send changes made to open files to the depot.
  8884. </summary>
  8885. <example>
  8886. <para>
  8887. Submit changelist "Temp", but first revert all unchanged files in the
  8888. changelist.
  8889. </para>
  8890. <code>
  8891. <![CDATA[
  8892. <p4submit changelist="Temp" revertunchanged="true" />
  8893. ]]>
  8894. </code>
  8895. </example>
  8896. <example>
  8897. <para>Submit changelist, but leave the files open afterwards.</para>
  8898. <code>
  8899. <![CDATA[
  8900. <p4submit changelist="Temp" remainopen="true" />
  8901. ]]>
  8902. </code>
  8903. </example>
  8904. </member>
  8905. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Submit.getSpecificCommandArguments">
  8906. <summary>
  8907. Builds the command string for this particular command.
  8908. </summary>
  8909. <returns>
  8910. The command string for this particular command.
  8911. </returns>
  8912. </member>
  8913. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.Changelist">
  8914. <summary>
  8915. Changelist to submit.
  8916. </summary>
  8917. </member>
  8918. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.RemainOpen">
  8919. <summary>
  8920. Keep the files open after submitting. The default is
  8921. <see langword="false" />.
  8922. </summary>
  8923. </member>
  8924. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.RevertUnchanged">
  8925. <summary>
  8926. Revert all unchanged or missing files from the changelist.
  8927. The default is <see langword="false" />.
  8928. </summary>
  8929. </member>
  8930. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.CommandSpecificArguments">
  8931. <summary>
  8932. This is an override used by the base class to get command specific args.
  8933. </summary>
  8934. </member>
  8935. <member name="T:NAnt.Contrib.Tasks.Perforce.P4Sync">
  8936. <summary>
  8937. Synchronize client space to a Perforce depot view.
  8938. </summary>
  8939. <example>
  8940. <para>
  8941. Sync to head using P4USER, P4PORT and P4CLIENT settings specified.
  8942. </para>
  8943. <code>
  8944. <![CDATA[
  8945. <p4sync
  8946. view="//projects/foo/main/source/..."
  8947. user="fbloggs"
  8948. port="km01:1666"
  8949. client="fbloggsclient"
  8950. />
  8951. ]]>
  8952. </code>
  8953. </example>
  8954. <example>
  8955. <para>Sync to head using default p4 environment variables.</para>
  8956. <code>
  8957. <![CDATA[
  8958. <p4sync view="//projects/foo/main/source/..." />
  8959. ]]>
  8960. </code>
  8961. </example>
  8962. <example>
  8963. <para>Force a re-sync to head, refreshing all files.</para>
  8964. <code>
  8965. <![CDATA[
  8966. <p4sync force="true" view="//projects/foo/main/source/..." />
  8967. ]]>
  8968. </code>
  8969. </example>
  8970. <example>
  8971. <para>Sync to a label.</para>
  8972. <code>
  8973. <![CDATA[
  8974. <p4sync label="myPerforceLabel" />
  8975. ]]>
  8976. </code>
  8977. </example>
  8978. </member>
  8979. <member name="M:NAnt.Contrib.Tasks.Perforce.P4Sync.getSpecificCommandArguments">
  8980. <summary>
  8981. Builds the command string for this particular command.
  8982. </summary>
  8983. <returns>
  8984. The command string for this particular command.
  8985. </returns>
  8986. </member>
  8987. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.Label">
  8988. <summary> Label to sync client to; optional.
  8989. </summary>
  8990. </member>
  8991. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.Force">
  8992. <summary>
  8993. Force a refresh of files. The default is <see langword="false" />.
  8994. </summary>
  8995. </member>
  8996. <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.CommandSpecificArguments">
  8997. <summary>
  8998. This is an override used by the base class to get command specific args.
  8999. </summary>
  9000. </member>
  9001. <member name="T:NAnt.Contrib.Tasks.Perforce.Perforce">
  9002. <summary>
  9003. Static helper class for Perforce tasks.
  9004. </summary>
  9005. </member>
  9006. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetUserName">
  9007. <summary>
  9008. ask p4 for the user name
  9009. </summary>
  9010. <returns></returns>
  9011. </member>
  9012. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetClient">
  9013. <summary>
  9014. ask p4 for the client name
  9015. </summary>
  9016. <returns></returns>
  9017. </member>
  9018. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetChangelistNumber(System.String,System.String,System.String,System.Boolean)">
  9019. <summary>
  9020. Get a changelist number based on on its name
  9021. </summary>
  9022. <param name="User"></param>
  9023. <param name="Client"></param>
  9024. <param name="ChangeList"></param>
  9025. <param name="CreateIfMissing"></param>
  9026. <returns></returns>
  9027. </member>
  9028. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetChangelistNumber(System.String,System.String,System.String)">
  9029. <summary>
  9030. Get a changelist number based on on its name
  9031. </summary>
  9032. <param name="User"></param>
  9033. <param name="Client"></param>
  9034. <param name="ChangeList"></param>
  9035. <returns></returns>
  9036. </member>
  9037. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateLabel(System.String,System.String,System.String)">
  9038. <summary>
  9039. Create a new label
  9040. </summary>
  9041. <param name="User"></param>
  9042. <param name="Labelname"></param>
  9043. <param name="View"></param>
  9044. </member>
  9045. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateClient(System.String,System.String,System.String,System.String)">
  9046. <summary>
  9047. Create a new Client
  9048. </summary>
  9049. <param name="User"></param>
  9050. <param name="Clientname"></param>
  9051. <param name="Root"></param>
  9052. <param name="View"></param>
  9053. </member>
  9054. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateChangelist(System.String,System.String,System.String)">
  9055. <summary>
  9056. Create a new changelist
  9057. </summary>
  9058. <param name="User"></param>
  9059. <param name="Client"></param>
  9060. <param name="ChangeList">Description of Changelist</param>
  9061. <returns></returns>
  9062. </member>
  9063. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetP4Info(System.String)">
  9064. <summary>
  9065. call the p4 process to
  9066. </summary>
  9067. <param name="SearchPattern"></param>
  9068. <returns></returns>
  9069. </member>
  9070. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetP4Info(System.String[])">
  9071. <summary>
  9072. call the p4 process to
  9073. </summary>
  9074. <param name="SearchPatterns"></param>
  9075. <returns></returns>
  9076. </member>
  9077. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.getProcessOutput(System.String,System.String,System.String)">
  9078. <summary>
  9079. Execute a process and return its ourput
  9080. </summary>
  9081. <param name="exe"></param>
  9082. <param name="prms"></param>
  9083. <param name="input"></param>
  9084. <returns></returns>
  9085. </member>
  9086. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.RunProcess(System.String,System.String,System.String,System.String@)">
  9087. <summary>
  9088. Execute a process and return its ourput
  9089. </summary>
  9090. <param name="exe"></param>
  9091. <param name="prms"></param>
  9092. <param name="input"></param>
  9093. <param name="output"></param>
  9094. <returns></returns>
  9095. </member>
  9096. <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.RunProcess(System.String,System.String,System.String)">
  9097. <summary>
  9098. Execute a process by name
  9099. </summary>
  9100. <param name="exe"></param>
  9101. <param name="prms"></param>
  9102. <param name="input"></param>
  9103. <returns></returns>
  9104. </member>
  9105. <member name="T:NAnt.Contrib.Tasks.SourceSafe.AddTask">
  9106. <summary>
  9107. Used to add files to a Visual SourceSafe database. If the file is currently
  9108. in the SourceSafe database a message will be logged but files will continue to be added.
  9109. </summary>
  9110. <remarks>
  9111. This version does not support recursive adds. Only adds in the root directory will be added to the
  9112. SourceSafe database.
  9113. </remarks>
  9114. <example>
  9115. <code><![CDATA[
  9116. <vssadd dbpath="C:\SourceSafeFolder\srcsafe.ini" user="user1" password="" path="$/Somefolder">
  9117. <fileset basedir="C:\SourceFolder\">
  9118. <include name="*.dll"/>
  9119. </fileset>
  9120. </vssadd>
  9121. ]]></code>
  9122. </example>
  9123. </member>
  9124. <member name="T:NAnt.Contrib.Tasks.SourceSafe.BaseTask">
  9125. <summary>
  9126. The base abstract class for all Visual Source Safe Tasks.
  9127. Provides the core attributes, and functionality for opening an item
  9128. in a Visual Source Safe database.
  9129. </summary>
  9130. </member>
  9131. <member name="M:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Open">
  9132. <summary>
  9133. Opens the Source Safe database and sets the reference to the specified
  9134. item and version.
  9135. </summary>
  9136. </member>
  9137. <member name="M:NAnt.Contrib.Tasks.SourceSafe.BaseTask.GetFileTimestampFlags(NAnt.Contrib.Tasks.SourceSafe.FileTimestamp)">
  9138. <summary>
  9139. Gets the <see cref="T:SourceSafeTypeLib.VSSFlags"/> value corresponding with the
  9140. specified <see cref="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp"/>.
  9141. </summary>
  9142. <param name="timestamp">A <see cref="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp"/>.</param>
  9143. <returns>
  9144. An <see cref="T:System.Int32"/> representing the <see cref="T:SourceSafeTypeLib.VSSFlags"/> value
  9145. for the <paramref name="timestamp"/>.
  9146. </returns>
  9147. </member>
  9148. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.DBPath">
  9149. <summary>
  9150. The path to the folder that contains "srcsafe.ini".
  9151. </summary>
  9152. </member>
  9153. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Path">
  9154. <summary>
  9155. The Visual SourceSafe project or file path you wish the perform the
  9156. action on (starting with "$/").
  9157. </summary>
  9158. </member>
  9159. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Password">
  9160. <summary>
  9161. The password to use to login to the SourceSafe database.
  9162. </summary>
  9163. </member>
  9164. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName">
  9165. <summary>
  9166. The name of the user needed to access the Visual SourceSafe database.
  9167. When no <see cref="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName"/> is specified and "Use network
  9168. name for automatic user log in" is enabled for the Visual SourceSafe
  9169. database, then the current Windows username will be used to log in.
  9170. </summary>
  9171. </member>
  9172. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Login">
  9173. <summary>
  9174. The name of the user needed to access the Visual SourceSafe database.
  9175. When no <see cref="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName"/> is specified and "Use network
  9176. name for automatic user log in" is enabled, then the current
  9177. Windows username will be used to log in.
  9178. </summary>
  9179. </member>
  9180. <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Version">
  9181. <summary>
  9182. A version of the path to reference. Accepts multiple forms,
  9183. including the label, version number, or date of the version.
  9184. If omitted, the latest version is used.
  9185. </summary>
  9186. </member>
  9187. <member name="M:NAnt.Contrib.Tasks.SourceSafe.AddTask.ExecuteTask">
  9188. <summary>
  9189. Main task execution method
  9190. </summary>
  9191. </member>
  9192. <member name="M:NAnt.Contrib.Tasks.SourceSafe.AddTask.CreateProjectPath(System.String)">
  9193. <summary>
  9194. Create project hierarchy in vss
  9195. </summary>
  9196. <param name="file"></param>
  9197. <returns></returns>
  9198. </member>
  9199. <member name="P:NAnt.Contrib.Tasks.SourceSafe.AddTask.Comment">
  9200. <summary>
  9201. Places a comment on all files added into the SourceSafe repository.
  9202. </summary>
  9203. </member>
  9204. <member name="P:NAnt.Contrib.Tasks.SourceSafe.AddTask.AddFileSet">
  9205. <summary>
  9206. List of files that should be added to SourceSafe.
  9207. </summary>
  9208. </member>
  9209. <member name="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp">
  9210. <summary>
  9211. Defines how the local timestamp of files retrieved from a SourceSafe
  9212. database should be set.
  9213. </summary>
  9214. </member>
  9215. <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Current">
  9216. <summary>
  9217. The timestamp of the local file is set to the current date and time.
  9218. </summary>
  9219. </member>
  9220. <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Modified">
  9221. <summary>
  9222. The timestamp of the local file is set to the file's last
  9223. modification date and time.
  9224. </summary>
  9225. </member>
  9226. <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Updated">
  9227. <summary>
  9228. The timestamp of the local file is set to the date and time that
  9229. the file was last checked in to the database.
  9230. </summary>
  9231. </member>
  9232. <member name="T:NAnt.Contrib.Tasks.SourceSafe.CheckinTask">
  9233. <summary>
  9234. Used to checkin files into Visual Source Safe.
  9235. </summary>
  9236. <example>
  9237. <para>Checkin all files from an absolute directory to a local sourcesafe database.</para>
  9238. <code><![CDATA[
  9239. <vsscheckin
  9240. user="myusername"
  9241. password="mypassword"
  9242. localpath="C:\Dev\Latest"
  9243. recursive="true"
  9244. writable="true"
  9245. dbpath="C:\VSS\srcsafe.ini"
  9246. path="$/MyProduct"
  9247. comment="NAnt checkin"
  9248. />
  9249. ]]></code>
  9250. </example>
  9251. <example>
  9252. <para>Checkin a file from a relative directory to a remote sourcesafe database.</para>
  9253. <code><![CDATA[
  9254. <vsscheckin
  9255. user="myusername"
  9256. password="mypassword"
  9257. localpath="Latest\myFile.cs"
  9258. recursive="false"
  9259. writable="true"
  9260. dbpath="\\MyServer\VSS\srcsafe.ini"
  9261. path="$/MyProduct/myFile.cs"
  9262. comment="NAnt checkin"
  9263. />
  9264. ]]></code>
  9265. </example>
  9266. </member>
  9267. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Comment">
  9268. <summary>
  9269. The comment for the new version.
  9270. </summary>
  9271. </member>
  9272. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.LocalPath">
  9273. <summary>
  9274. The path to the local working directory.
  9275. </summary>
  9276. </member>
  9277. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Recursive">
  9278. <summary>
  9279. Determines whether to perform a recursive checkin.
  9280. The default is <see langword="true" />.
  9281. </summary>
  9282. </member>
  9283. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Writable">
  9284. <summary>
  9285. Determines whether to leave the file(s) as writable.
  9286. The default is <see langword="false" />.
  9287. </summary>
  9288. </member>
  9289. <member name="T:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask">
  9290. <summary>
  9291. Task used to checkout files from Visual Source Safe.
  9292. </summary>
  9293. <example>
  9294. <para>Checkout the latest files from a local sourcesafe database.</para>
  9295. <code><![CDATA[
  9296. <vsscheckout
  9297. user="myusername"
  9298. password="mypassword"
  9299. localpath="C:\Dev\Latest"
  9300. recursive="true"
  9301. writable="true"
  9302. dbpath="C:\VSS\srcsafe.ini"
  9303. path="$/MyProduct"
  9304. />
  9305. ]]></code>
  9306. </example>
  9307. <example>
  9308. <para>Checkout a file from a remote sourcesafe database. Put it in a relative directory.</para>
  9309. <code><![CDATA[
  9310. <vsscheckout
  9311. user="myusername"
  9312. password="mypassword"
  9313. localpath="Latest"
  9314. recursive="false"
  9315. writable="true"
  9316. dbpath="\\MyServer\VSS\srcsafe.ini"
  9317. path="$/MyProduct/myFile.cs"
  9318. />
  9319. ]]></code>
  9320. </example>
  9321. </member>
  9322. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.LocalPath">
  9323. <summary>
  9324. The path to the local working directory.
  9325. </summary>
  9326. </member>
  9327. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.Recursive">
  9328. <summary>
  9329. Determines whether to perform a recursive checkout.
  9330. The default is <see langword="true" />.
  9331. </summary>
  9332. </member>
  9333. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.Writable">
  9334. <summary>
  9335. Determines whether to leave the file(s) as writable.
  9336. The default is <see langword="true" />.
  9337. </summary>
  9338. </member>
  9339. <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.FileTimestamp">
  9340. <summary>
  9341. Set the behavior for timestamps of local files. The default is
  9342. <see cref="F:FileTimestamp.Current" />.
  9343. </summary>
  9344. </member>
  9345. <member name="T:NAnt.Contrib.Tasks.SourceSafe.DeleteTask">
  9346. <summary>
  9347. Used to delete or Destroy files or projects in Visual Source Safe.
  9348. </summary>
  9349. <example>
  9350. <para>Delete a project from a local sourcesafe database.</para>
  9351. <code><![CDATA[
  9352. <vssdelete
  9353. user="myusername"
  9354. password="mypassword"
  9355. dbpath="C:\VSS\srcsafe.ini"
  9356. path="$/MyProduct"
  9357. />
  9358. ]]></code>
  9359. </example>
  9360. <example>
  9361. <para>Delete a file from the remote sourcesafe database.</para>
  9362. <code><![CDATA[
  9363. <vsscheckin
  9364. user="myusername"
  9365. password="mypassword"
  9366. dbpath="\\MyServer\VSS\srcsafe.ini"
  9367. path="$/MyProduct/myFile.cs"
  9368. />
  9369. ]]></code>
  9370. </example>
  9371. <example>
  9372. <para>Destroy a project from a local sourcesafe database.</para>
  9373. <code><![CDATA[
  9374. <vssdelete
  9375. user="myusername"
  9376. password="mypassword"
  9377. dbpath="C:\VSS\srcsafe.ini"
  9378. path="$/MyProduct"
  9379. Destroy="true"
  9380. />
  9381. ]]></code>
  9382. </example>
  9383. <example>
  9384. <para>Destroy a file from the remote sourcesafe database.</para>
  9385. <code><![CDATA[
  9386. <vssdelete
  9387. user="myusername"
  9388. password="mypassword"
  9389. dbpath="\\MyServer\VSS\srcsafe.ini"
  9390. path="$/MyProduct/myFile.cs"
  9391. Destroy="true"
  9392. />
  9393. ]]></code>
  9394. </example>
  9395. </member>
  9396. <member name="M:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.DeleteItem">
  9397. <summary>
  9398. Deletes the item unless <see cref="P:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.Destroy"/> is <see langword="true"/>
  9399. then the item is destroyed.
  9400. </summary>
  9401. </member>
  9402. <member name="P:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.Destroy">
  9403. <summary>
  9404. Determines whether or not the item is Destroyed.
  9405. The default is <see langword="false" />.
  9406. </summary>
  9407. </member>
  9408. <member name="T:NAnt.Contrib.Tasks.SourceSafe.DiffTask">
  9409. <summary>
  9410. Used to generate differences in a vss database. It will show all changes to a project
  9411. after the specified label.
  9412. </summary>
  9413. <remarks>
  9414. This only shows differences between the current version and the version specified.
  9415. </remarks>
  9416. <example>
  9417. <code><![CDATA[
  9418. <vssdiff
  9419. dbpath='ss.ini'
  9420. path='$/My Project'
  9421. label='My Label'
  9422. user='ssuser'
  9423. outputfile='diff.xml'
  9424. />
  9425. ]]></code>
  9426. </example>
  9427. </member>
  9428. <member name="P:NAnt.Contrib.Tasks.SourceSafe.DiffTask.Label">
  9429. <summary>
  9430. The value of the label to compare to. Required.
  9431. </summary>
  9432. </member>
  9433. <member name="P:NAnt.Contrib.Tasks.SourceSafe.DiffTask.OutputFile">
  9434. <summary>
  9435. The output file to generate (xml)
  9436. </summary>
  9437. </member>
  9438. <member name="T:NAnt.Contrib.Tasks.SourceSafe.GetTask">
  9439. <summary>
  9440. Used to retrieve an item or project from a Visual Source Safe database.
  9441. </summary>
  9442. <example>
  9443. <para>Get the latest files from a local sourcesafe database.</para>
  9444. <code><![CDATA[
  9445. <vssget
  9446. user="myusername"
  9447. password="mypassword"
  9448. localpath="C:\Dev\Latest"
  9449. recursive="true"
  9450. replace="true"
  9451. writable="true"
  9452. dbpath="C:\VSS\srcsafe.ini"
  9453. path="$/MyProduct"
  9454. />
  9455. ]]></code>
  9456. </example>
  9457. <example>
  9458. <para>Get the latest version of a file from a remote sourcesafe database. Put it in a relative directory.</para>
  9459. <code><![CDATA[
  9460. <vssget
  9461. user="myusername"
  9462. password="mypassword"
  9463. localpath="Latest"
  9464. recursive="true"
  9465. replace="true"
  9466. writable="true"
  9467. dbpath="\\MyServer\VSS\srcsafe.ini"
  9468. path="$/MyProduct/myFile.cs"
  9469. />
  9470. ]]></code>
  9471. </example>
  9472. <example>
  9473. <para>Get the latest version of a file from a remote sourcesafe database. Remove any deleted files from local image.</para>
  9474. <code><![CDATA[
  9475. <vssget
  9476. user="myusername"
  9477. password="mypassword"
  9478. localpath="C:\Dev\Latest"
  9479. recursive="true"
  9480. replace="true"
  9481. writable="true"
  9482. removedeleted="true"
  9483. dbpath="\\MyServer\VSS\srcsafe.ini"
  9484. path="$/MyProduct/myFile.cs"
  9485. />
  9486. ]]></code>
  9487. </example>
  9488. </member>
  9489. <member name="M:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeletedFromLocalImage">
  9490. <summary>
  9491. Checks to see if we should remove local copies of deleted files, and starts
  9492. the scan.
  9493. </summary>
  9494. </member>
  9495. <member name="M:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeletedFromLocalImage(SourceSafeTypeLib.IVSSItem,System.String)">
  9496. <summary>
  9497. Scans the Project Item for deleted files and removes their local
  9498. copies from the local image of the project. Obeys the recursive setting
  9499. (and thus optionally calls itself recursively).
  9500. </summary>
  9501. <param name="item">The VSS Item (project) to check for deletions</param>
  9502. <param name="localPathPrefix">The path to the folder of the item being processed</param>
  9503. </member>
  9504. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.LocalPath">
  9505. <summary>
  9506. The path to the local working directory.
  9507. </summary>
  9508. </member>
  9509. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Recursive">
  9510. <summary>
  9511. Determines whether to perform the get recursively.
  9512. The default is <see langword="true" />.
  9513. </summary>
  9514. </member>
  9515. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Replace">
  9516. <summary>
  9517. Determines whether to replace writable files.
  9518. The default is <see langword="false" />.
  9519. </summary>
  9520. </member>
  9521. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Writable">
  9522. <summary>
  9523. Determines whether the files will be writable.
  9524. The default is <see langword="false" />.
  9525. </summary>
  9526. </member>
  9527. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeleted">
  9528. <summary>
  9529. If <see cref="T:System.IO.Path"/> refers to a project, determines whether files
  9530. marked "deleted" in the repository will be removed from the local
  9531. copy. The default is <see langword="false"/>.
  9532. </summary>
  9533. </member>
  9534. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.UseModificationTime">
  9535. <summary>
  9536. Determines whether the timestamp on the local copy
  9537. will be the modification time (if false or omitted,
  9538. the checkout time will be used)
  9539. </summary>
  9540. </member>
  9541. <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.FileTimestamp">
  9542. <summary>
  9543. Set the behavior for timestamps of local files. The default is
  9544. <see cref="F:FileTimestamp.Current" />.
  9545. </summary>
  9546. </member>
  9547. <member name="T:NAnt.Contrib.Tasks.SourceSafe.History">
  9548. <summary>
  9549. Generates an XML file showing all changes made to a Visual SourceSafe
  9550. project/file between specified labels or dates (by a given user).
  9551. </summary>
  9552. <example>
  9553. <para>
  9554. Write all changes between "Release1" and "Release2" to XML file
  9555. "changelog.xml".
  9556. </para>
  9557. <code>
  9558. <![CDATA[
  9559. <vsshistory
  9560. dbpath="C:\VSS\srcsafe.ini"
  9561. path="$/My Project"
  9562. fromlabel="Release1"
  9563. tolabel="Release2"
  9564. output="changelog.xml" />
  9565. ]]>
  9566. </code>
  9567. </example>
  9568. <example>
  9569. <para>
  9570. Write all changes between January 1st 2004 and March 31st 2004 to XML
  9571. file "history.xml".
  9572. </para>
  9573. <code>
  9574. <![CDATA[
  9575. <vsshistory
  9576. dbpath="C:\VSS\srcsafe.ini"
  9577. path="$/My Project"
  9578. fromdate="01/01/2004"
  9579. todate="03/31/2004"
  9580. output="history.xml"
  9581. />
  9582. ]]>
  9583. </code>
  9584. </example>
  9585. </member>
  9586. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.FromLabel">
  9587. <summary>
  9588. The value of the label to start comparing to. If it is not included,
  9589. the compare will start with the very first history item.
  9590. </summary>
  9591. </member>
  9592. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.ToLabel">
  9593. <summary>
  9594. The value of the label to compare up to. If it is not included,
  9595. the compare will end with the last history item.
  9596. </summary>
  9597. </member>
  9598. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.FromDate">
  9599. <summary>
  9600. Start date for comparison.
  9601. </summary>
  9602. </member>
  9603. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.ToDate">
  9604. <summary>
  9605. End date for comparison.
  9606. </summary>
  9607. </member>
  9608. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Output">
  9609. <summary>
  9610. Output file to save history to (as XML).
  9611. </summary>
  9612. </member>
  9613. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Recursive">
  9614. <summary>
  9615. Determines whether to perform the comparison recursively.
  9616. The default is <see langword="true" />.
  9617. </summary>
  9618. </member>
  9619. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.User">
  9620. <summary>
  9621. Name of the user whose changes you want to see.
  9622. </summary>
  9623. </member>
  9624. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.VersionFlags">
  9625. <summary>
  9626. Gets the flags that should be used to retrieve the history of
  9627. <see cref="T:System.IO.Path"/>.
  9628. </summary>
  9629. </member>
  9630. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Login">
  9631. <summary>
  9632. Override to avoid exposing the corresponding attribute to build
  9633. authors.
  9634. </summary>
  9635. </member>
  9636. <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Version">
  9637. <summary>
  9638. Override to avoid exposing the corresponding attribute to build
  9639. authors.
  9640. </summary>
  9641. </member>
  9642. <member name="T:NAnt.Contrib.Tasks.SourceSafe.LabelTask">
  9643. <summary>
  9644. Used to apply a label to a Visual Source Safe item.
  9645. </summary>
  9646. <example>
  9647. <para>Label all files in a local sourcesafe database. (Automatically applies the label recursively)</para>
  9648. <code><![CDATA[
  9649. <vsslabel
  9650. user="myusername"
  9651. password="mypassword"
  9652. dbpath="C:\VSS\srcsafe.ini"
  9653. path="$/MyProduct"
  9654. comment="NAnt label"
  9655. label="myLabel"
  9656. />
  9657. ]]></code>
  9658. </example>
  9659. <example>
  9660. <para>Label a file in a remote sourcesafe database.</para>
  9661. <code><![CDATA[
  9662. <vsslabel
  9663. user="myusername"
  9664. password="mypassword"
  9665. dbpath="\\MyServer\VSS\srcsafe.ini"
  9666. path="$/MyProduct/myFile.cs"
  9667. comment="NAnt label"
  9668. label="myLabel"
  9669. />
  9670. ]]></code>
  9671. </example>
  9672. </member>
  9673. <member name="P:NAnt.Contrib.Tasks.SourceSafe.LabelTask.Comment">
  9674. <summary>
  9675. The label comment.
  9676. </summary>
  9677. </member>
  9678. <member name="P:NAnt.Contrib.Tasks.SourceSafe.LabelTask.Label">
  9679. <summary>
  9680. The name of the label.
  9681. </summary>
  9682. </member>
  9683. <member name="T:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask">
  9684. <summary>
  9685. Task is used to undo a checkout from SourceSafe
  9686. </summary>
  9687. <example>
  9688. <para>Undo a checkout of all of the files from a local sourcesafe database.</para>
  9689. <code><![CDATA[
  9690. <vssundocheckout
  9691. user="myusername"
  9692. password="mypassword"
  9693. localpath="C:\Dev\Latest"
  9694. recursive="true"
  9695. dbpath="C:\VSS\srcsafe.ini"
  9696. path="$/MyProduct"
  9697. />
  9698. ]]></code>
  9699. </example>
  9700. <example>
  9701. <para>Checkout a file from a remote sourcesafe database. Put it in a relative directory.</para>
  9702. <code><![CDATA[
  9703. <vssundocheckout
  9704. user="myusername"
  9705. password="mypassword"
  9706. localpath="Latest"
  9707. recursive="false"
  9708. dbpath="\\MyServer\VSS\srcsafe.ini"
  9709. path="$/MyProduct/myFile.cs"
  9710. />
  9711. ]]></code>
  9712. </example>
  9713. </member>
  9714. <member name="P:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask.LocalPath">
  9715. <summary>
  9716. The path to the local working directory. This is required if you wish to
  9717. have your local file replaced with the latest version from SourceSafe.
  9718. </summary>
  9719. </member>
  9720. <member name="P:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask.Recursive">
  9721. <summary>
  9722. Determines whether to perform a recursive undo of the checkout.
  9723. The default is <see langword="true" />.
  9724. </summary>
  9725. </member>
  9726. <member name="T:NAnt.Contrib.Tasks.StarTeam.LabelTask">
  9727. <summary>
  9728. Allows creation of view labels in StarTeam repositories.
  9729. </summary>
  9730. <remarks>
  9731. <para>Often when building projects you wish to label the source control repository.</para>
  9732. <para>By default this task creates view labels with the build option turned on.</para>
  9733. <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel </para>
  9734. <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
  9735. </remarks>
  9736. <example>
  9737. <para>Creates a label in a StarTeam repository.</para>
  9738. <code>
  9739. <![CDATA[
  9740. <!--
  9741. constructs a 'url' containing connection information to pass to the task
  9742. alternatively you can set each attribute manually
  9743. -->
  9744. <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
  9745. <stlabel label="3.1 (label title goes here)" description="This is a label description" url="${ST.url}" />
  9746. ]]>
  9747. </code>
  9748. </example>
  9749. </member>
  9750. <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamTask">
  9751. <summary>
  9752. Base star team task.
  9753. </summary>
  9754. <remarks>
  9755. <para>
  9756. Common super class for all StarTeam tasks. At this level of the hierarchy we are concerned only with obtaining a
  9757. connection to the StarTeam server. The subclass <see cref="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask"/>, abstracts tree-walking
  9758. behavior common to many subtasks.
  9759. </para>
  9760. <para>This class ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html </para>
  9761. <para>You need to have the StarTeam SDK installed for StarTeam tasks to function correctly.</para>
  9762. </remarks>
  9763. <seealso cref="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask"/>
  9764. <author> <a href="mailto:jcyip@thoughtworks.com">Jason Yip</a></author>
  9765. <author> <a href="mailto:stevec@ignitesports.com">Steve Cohen</a></author>
  9766. </member>
  9767. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._username">
  9768. <value> The username of the connection</value>
  9769. </member>
  9770. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._password">
  9771. <value> The username of the connection</value>
  9772. </member>
  9773. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._servername">
  9774. <value> name of Starteam server to connect to</value>
  9775. </member>
  9776. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._serverport">
  9777. <value> port of Starteam server to connect to</value>
  9778. </member>
  9779. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._projectname">
  9780. <value> name of Starteam project to connect to</value>
  9781. </member>
  9782. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._viewname">
  9783. <value> name of Starteam view to connect to</value>
  9784. </member>
  9785. <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._server">
  9786. <value>The starteam server through which all activities will be done.</value>
  9787. </member>
  9788. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.createSnapshotView(StarTeam.StView)">
  9789. <summary>
  9790. Derived classes must override this method to instantiate a view configured appropriately to its task.
  9791. </summary>
  9792. <param name="rawview">the unconfigured <code>View</code></param>
  9793. <returns>the view appropriately configured.</returns>
  9794. </member>
  9795. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.openView">
  9796. <summary>
  9797. All tasks will call on this method to connect to StarTeam and open the view for processing.
  9798. </summary>
  9799. <returns>the a view to be used for processing.</returns>
  9800. <seealso cref="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.createSnapshotView(StarTeam.StView)"/>
  9801. </member>
  9802. <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.getUserName(System.Int32)">
  9803. <summary> Returns the name of the user or a blank string if the user is not found.</summary>
  9804. <param name="userID">a user's ID</param>
  9805. <returns>the name of the user</returns>
  9806. </member>
  9807. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.servername">
  9808. <summary>
  9809. Name of StarTeamServer.
  9810. </summary>
  9811. <remarks>
  9812. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9813. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9814. </remarks>
  9815. </member>
  9816. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.serverport">
  9817. <summary>
  9818. Port number of the StarTeam connection.
  9819. </summary>
  9820. <remarks>
  9821. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9822. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9823. </remarks>
  9824. </member>
  9825. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.projectname">
  9826. <summary>
  9827. The name of the StarTeam project to be acted on
  9828. </summary>
  9829. <remarks>
  9830. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9831. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9832. </remarks>
  9833. </member>
  9834. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.viewname">
  9835. <summary>
  9836. The name of the StarTeam view to be acted on.
  9837. </summary>
  9838. <remarks>
  9839. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9840. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9841. </remarks>
  9842. </member>
  9843. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.username">
  9844. <summary>
  9845. The StarTeam user name used for login.
  9846. </summary>
  9847. <remarks>
  9848. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9849. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9850. </remarks>
  9851. </member>
  9852. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.password">
  9853. <summary>
  9854. The password used for login.
  9855. </summary>
  9856. <remarks>
  9857. Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
  9858. connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
  9859. </remarks>
  9860. </member>
  9861. <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url">
  9862. <summary>
  9863. One stop to set all parameters needed to connect to a StarTeam server.
  9864. </summary>
  9865. <remarks>
  9866. <para>If you do not wish to specify a url you can set each parameter individually.
  9867. You must set all connection parameters for the task to be able to connect to the StarTeam server.</para>
  9868. </remarks>
  9869. <example>
  9870. <para>Here is how to configure the url string.</para>
  9871. <code>servername:portnum/project/view</code>
  9872. <para>You can optionally specify a username and password.</para>
  9873. <code>username:password@servername:portnum/project/view</code>
  9874. </example>
  9875. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.servername"/>
  9876. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.serverport"/>
  9877. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.projectname"/>
  9878. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.viewname"/>
  9879. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.username"/>
  9880. <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.password"/>
  9881. </member>
  9882. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._labelName">
  9883. <summary> The name of the label to be set in Starteam.</summary>
  9884. </member>
  9885. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._description">
  9886. <summary> The label description to be set in Starteam.</summary>
  9887. </member>
  9888. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isBuildLabel">
  9889. <summary> Is the label being created a build label.</summary>
  9890. </member>
  9891. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._labelAsOfDate">
  9892. <summary> If set the datetime to set the label as of.</summary>
  9893. </member>
  9894. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isAsOfDateSet">
  9895. <summary> Kludgy flag to keep track if date has been set.
  9896. Please kill this if you can. Here based on experiences I have had with VB.NET</summary>
  9897. </member>
  9898. <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isRevision">
  9899. <summary> Does user wish to make a revision label?</summary>
  9900. </member>
  9901. <member name="M:NAnt.Contrib.Tasks.StarTeam.LabelTask.createSnapshotView(StarTeam.StView)">
  9902. <summary>
  9903. Override of base-class abstract function creates an appropriately configured view.
  9904. For labels this a view configured as of this.lastBuild.
  9905. </summary>
  9906. <param name="raw">the unconfigured <code>View</code></param>
  9907. <returns>the snapshot <code>View</code> appropriately configured.</returns>
  9908. </member>
  9909. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label">
  9910. <summary>
  9911. The name to be given to the label; required.
  9912. </summary>
  9913. </member>
  9914. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.BuildLabel">
  9915. <summary> Should label be marked build : default is true</summary>
  9916. </member>
  9917. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.RevisionLabel">
  9918. <summary>
  9919. Should label created be a revision label. The default is
  9920. <see langword="false"/>.
  9921. </summary>
  9922. <remarks>
  9923. <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.BuildLabel"/> has no effect if this is set to <see langword="true"/>
  9924. as revision labels cannot have a build status.
  9925. </remarks>
  9926. </member>
  9927. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Description">
  9928. <summary> Optional description of the label to be stored in the StarTeam project.</summary>
  9929. </member>
  9930. <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.LastBuild">
  9931. <summary>
  9932. Optional: If this property is set the label will be created as of the datetime specified.
  9933. Please provide a datetime format that can be parsed via
  9934. <see cref="M:System.DateTime.Parse(System.String,System.IFormatProvider)"/>.
  9935. </summary>
  9936. <remarks>
  9937. This property is ignored when <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.RevisionLabel"/> set to
  9938. <see langword="true"/>.
  9939. </remarks>
  9940. </member>
  9941. <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel">
  9942. <summary>
  9943. Task for supporting labeling of repositories with incremented version
  9944. numbers. The version number calculated will be concatenated to the
  9945. <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label"/>.
  9946. </summary>
  9947. <remarks>
  9948. <para>
  9949. Instruments root of repository with <c>versionnumber.xml</c> file.
  9950. </para>
  9951. <para>
  9952. If this file is not present, it is created and checked into StarTeam.
  9953. The default version number is 1.0.0. By default the build number is
  9954. incremented. Properties are present to allow setting and incrementing
  9955. of major, minor, and build versions.
  9956. </para>
  9957. <para>
  9958. When label is created, properties are set to expose version information
  9959. and the new label :
  9960. </para>
  9961. <list type="bullet">
  9962. <item>
  9963. <description>label</description>
  9964. </item>
  9965. <item>
  9966. <description>Version.text</description>
  9967. </item>
  9968. <item>
  9969. <description>Version.major</description>
  9970. </item>
  9971. <item>
  9972. <description>Version.minor</description>
  9973. </item>
  9974. <item>
  9975. <description>Version.build</description>
  9976. </item>
  9977. </list>