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