/tools/nant/NAnt.Core.xml
XML | 10512 lines | 10490 code | 21 blank | 1 comment | 0 complexity | fbb84cdf29ffa44e9e2c7beaee9a47da MD5 | raw file
1<?xml version="1.0"?> 2<doc> 3 <assembly> 4 <name>NAnt.Core</name> 5 </assembly> 6 <members> 7 <member name="T:NAnt.Core.Attributes.BooleanValidatorAttribute"> 8 <summary> 9 Used to indicate that a property should be able to be converted into a 10 <see cref="T:System.Boolean"/>. 11 </summary> 12 </member> 13 <member name="T:NAnt.Core.Attributes.ValidatorAttribute"> 14 <summary> 15 Base class for all validator attributes. 16 </summary> 17 </member> 18 <member name="M:NAnt.Core.Attributes.ValidatorAttribute.Validate(System.Object)"> 19 <summary> 20 Validates the specified value. 21 </summary> 22 <param name="value">The value to be validated.</param> 23 <exception cref="T:NAnt.Core.ValidationException">The validation fails.</exception> 24 </member> 25 <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.#ctor"> 26 <summary> 27 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BooleanValidatorAttribute"/> 28 class. 29 </summary> 30 </member> 31 <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.Validate(System.Object)"> 32 <summary> 33 Checks if the specified value can be converted to a <see cref="T:System.Boolean"/>. 34 </summary> 35 <param name="value">The value to be checked.</param> 36 <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.Boolean"/>.</exception> 37 </member> 38 <member name="T:NAnt.Core.Attributes.BuildAttributeAttribute"> 39 <summary> 40 Indicates that property should be treated as a XML attribute for the 41 task. 42 </summary> 43 <example> 44 Examples of how to specify task attributes 45 <code> 46 #region Public Instance Properties 47 48 [BuildAttribute("out", Required=true)] 49 public string Output { 50 get { return _out; } 51 set { _out = value; } 52 } 53 [BuildAttribute("optimize")] 54 [BooleanValidator()] 55 public bool Optimize { 56 get { return _optimize; } 57 set { _optimize = value; } 58 } 59 [BuildAttribute("warnlevel")] 60 [Int32Validator(0,4)] // limit values to 0-4 61 public int WarnLevel { 62 get { return _warnLevel; } 63 set { _warnLevel = value; } 64 } 65 [BuildElement("sources")] 66 public FileSet Sources { 67 get { return _sources; } 68 set { _sources = value; } 69 } 70 71 #endregion Public Instance Properties 72 73 #region Private Instance Fields 74 75 private string _out = null; 76 private bool _optimize = false; 77 private int _warnLevel = 4; 78 private FileSet _sources = new FileSet(); 79 80 #endregion Private Instance Fields 81 </code> 82 </example> 83 </member> 84 <member name="M:NAnt.Core.Attributes.BuildAttributeAttribute.#ctor(System.String)"> 85 <summary> 86 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildAttributeAttribute"/> with the 87 specified name. 88 </summary> 89 <param name="name">The name of the attribute.</param> 90 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> 91 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 92 </member> 93 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Name"> 94 <summary> 95 Gets or sets the name of the XML attribute. 96 </summary> 97 <value> 98 The name of the XML attribute. 99 </value> 100 </member> 101 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Required"> 102 <summary> 103 Gets or sets a value indicating whether the attribute is required. 104 </summary> 105 <value> 106 <see langword="true" /> if the attribute is required; otherwise, 107 <see langword="false" />. The default is <see langword="false" />. 108 </value> 109 </member> 110 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ExpandProperties"> 111 <summary> 112 Gets or sets a value indicating whether property references should 113 be expanded. 114 </summary> 115 <value> 116 <see langword="true" /> if properties should be expanded; otherwise 117 <see langword="false" />. The default is <see langword="true" />. 118 </value> 119 </member> 120 <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ProcessXml"> 121 <summary> 122 Used to specify how this attribute will be handled as the XML is 123 parsed and given to the element. 124 </summary> 125 <value> 126 <see langword="true" /> if XML should be processed; otherwise 127 <see langword="false" />. The default is <see langword="true" />. 128 </value> 129 </member> 130 <member name="T:NAnt.Core.Attributes.BuildElementArrayAttribute"> 131 <summary> 132 Indicates that property should be treated as a XML arrayList 133 </summary> 134 <remarks> 135 <para> 136 Should only be applied to properties exposing strongly typed arrays or 137 strongly typed collections. 138 </para> 139 <para> 140 The XML format is like this: 141 <code> 142 <![CDATA[ 143 <task> 144 <elementName ... /> 145 <elementName ... /> 146 <elementName ... /> 147 <elementName ... /> 148 </task> 149 ]]> 150 </code> 151 </para> 152 </remarks> 153 </member> 154 <member name="T:NAnt.Core.Attributes.BuildElementAttribute"> 155 <summary> 156 Indicates that the property should be treated as an XML element and 157 further processing should be done. 158 </summary> 159 <remarks> 160 <para> 161 The XML format is like this: 162 <code> 163 <![CDATA[ 164 <task> 165 <elementName ...> 166 <morestuff /> 167 </elementName> 168 </task> 169 ]]> 170 </code> 171 </para> 172 </remarks> 173 </member> 174 <member name="M:NAnt.Core.Attributes.BuildElementAttribute.#ctor(System.String)"> 175 <summary> 176 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> with the 177 specified name. 178 </summary> 179 <param name="name">The name of the attribute.</param> 180 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> 181 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 182 </member> 183 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Name"> 184 <summary> 185 Gets or sets the name of the attribute. 186 </summary> 187 <value> 188 The name of the attribute. 189 </value> 190 </member> 191 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Required"> 192 <summary> 193 Gets or sets a value indicating whether the attribute is required. 194 </summary> 195 <value> 196 <see langword="true" /> if the attribute is required; otherwise, 197 <see langword="false" />. The default is <see langword="false" />. 198 </value> 199 </member> 200 <member name="P:NAnt.Core.Attributes.BuildElementAttribute.ProcessXml"> 201 <summary> 202 Used to specify how this element will be handled as the XML is parsed 203 and given to the element. 204 </summary> 205 <value> 206 <see langword="true" /> if XML should be processed; otherwise 207 <see langword="false" />. The default is <see langword="true" />. 208 </value> 209 </member> 210 <member name="M:NAnt.Core.Attributes.BuildElementArrayAttribute.#ctor(System.String)"> 211 <summary> 212 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementArrayAttribute"/> 213 with the specified name. 214 </summary> 215 <param name="name">The name of the attribute.</param> 216 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> 217 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 218 </member> 219 <member name="P:NAnt.Core.Attributes.BuildElementArrayAttribute.ElementType"> 220 <summary> 221 Gets or sets the type of objects that this container holds. 222 </summary> 223 <value> 224 The type of the elements that this container holds. 225 </value> 226 <remarks> 227 <para> 228 This can be used for validation and schema generation. 229 </para> 230 <para> 231 If not specified, the type of the elements will be determined using 232 reflection. 233 </para> 234 </remarks> 235 <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception> 236 </member> 237 <member name="T:NAnt.Core.Attributes.BuildElementCollectionAttribute"> 238 <summary> 239 Indicates that the property should be treated as a container for a 240 collection of build elements. 241 </summary> 242 <remarks> 243 <para> 244 Should only be applied to properties exposing strongly typed arrays or 245 strongly typed collections. 246 </para> 247 <para> 248 The XML format is like this: 249 <code> 250 <![CDATA[ 251 <task> 252 <collectionName> 253 <elementName ... /> 254 <elementName ... /> 255 <elementName ... /> 256 <elementName ... /> 257 </collectionName> 258 </task> 259 ]]> 260 </code> 261 </para> 262 </remarks> 263 </member> 264 <member name="M:NAnt.Core.Attributes.BuildElementCollectionAttribute.#ctor(System.String,System.String)"> 265 <summary> 266 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementCollectionAttribute"/> with the 267 specified name and child element name. 268 </summary> 269 <param name="collectionName">The name of the collection.</param> 270 <param name="childName">The name of the child elements in the collection</param> 271 <exception cref="T:System.ArgumentNullException"><paramref name="childName"/> is <see langword="null"/>.</exception> 272 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="childName"/> is a zero-length <see cref="T:System.String"/>.</exception> 273 </member> 274 <member name="P:NAnt.Core.Attributes.BuildElementCollectionAttribute.ChildElementName"> 275 <summary> 276 The name of the child element within the collection. 277 </summary> 278 <value> 279 The name to check for in the XML of the elements in the collection. 280 </value> 281 <remarks> 282 This can be used for validation and schema generation. 283 </remarks> 284 </member> 285 <member name="T:NAnt.Core.Attributes.DateTimeValidatorAttribute"> 286 <summary> 287 Used to indicate that a property should be able to be converted into a 288 <see cref="T:System.DateTime"/>. 289 </summary> 290 </member> 291 <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.#ctor"> 292 <summary> 293 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.DateTimeValidatorAttribute"/> 294 class. 295 </summary> 296 </member> 297 <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.Validate(System.Object)"> 298 <summary> 299 Checks if the specified value can be converted to a <see cref="T:System.DateTime"/>. 300 </summary> 301 <param name="value">The value to be checked.</param> 302 <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.DateTime"/>.</exception> 303 </member> 304 <member name="T:NAnt.Core.Attributes.ElementNameAttribute"> 305 <summary> 306 Indicates that class should be treated as a NAnt element. 307 </summary> 308 <remarks> 309 Attach this attribute to a subclass of Element to have NAnt be able 310 to recognize it. The name should be short but must not confict 311 with any other element already in use. 312 </remarks> 313 </member> 314 <member name="M:NAnt.Core.Attributes.ElementNameAttribute.#ctor(System.String)"> 315 <summary> 316 Initializes a new instance of the <see cre="ElementNameAttribute"/> 317 with the specified name. 318 </summary> 319 <param name="name">The name of the element.</param> 320 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> 321 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 322 </member> 323 <member name="P:NAnt.Core.Attributes.ElementNameAttribute.Name"> 324 <summary> 325 Gets or sets the name of the element. 326 </summary> 327 <value> 328 The name of the element. 329 </value> 330 </member> 331 <member name="T:NAnt.Core.Attributes.FileSetAttribute"> 332 <summary> 333 Indicates that a property should be treated as a XML file set for the 334 task. 335 </summary> 336 </member> 337 <member name="M:NAnt.Core.Attributes.FileSetAttribute.#ctor(System.String)"> 338 <summary> 339 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FileSetAttribute"/> with the 340 specified name. 341 </summary> 342 <param name="name">The name of the attribute.</param> 343 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> 344 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 345 </member> 346 <member name="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute"> 347 <summary> 348 Indicates that the value of the property to which the attribute is 349 assigned, can be configured on the framework-level in the NAnt application 350 configuration file. 351 </summary> 352 <example> 353 <para> 354 The following example shows a property of which the value can be 355 configured for a specific framework in the NAnt configuration file. 356 </para> 357 <code lang="C#"> 358 [FrameworkConfigurable("exename", Required=true)] 359 public virtual string ExeName { 360 get { return _exeName; } 361 set { _exeName = value; } 362 } 363 </code> 364 </example> 365 </member> 366 <member name="M:NAnt.Core.Attributes.FrameworkConfigurableAttribute.#ctor(System.String)"> 367 <summary> 368 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute"/> 369 with the specified attribute name. 370 </summary> 371 <param name="name">The name of the framework configuration attribute.</param> 372 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception> 373 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 374 </member> 375 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Name"> 376 <summary> 377 Gets or sets the name of the framework configuration attribute. 378 </summary> 379 <value>The name of the framework configuration attribute.</value> 380 </member> 381 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Required"> 382 <summary> 383 Gets or sets a value indicating whether the configuration attribute 384 is required. 385 </summary> 386 <value> 387 <see langword="true" /> if the configuration attribute is required; 388 otherwise, <see langword="true" />. The default is <see langword="false" />. 389 </value> 390 </member> 391 <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.ExpandProperties"> 392 <summary> 393 Gets or sets a value indicating whether property references should 394 be expanded. 395 </summary> 396 <value> 397 <see langword="true" /> if properties should be expanded; otherwise 398 <see langword="false" />. The default is <see langword="true" />. 399 </value> 400 </member> 401 <member name="T:NAnt.Core.Attributes.FunctionAttribute"> 402 <summary> 403 Indicates that the method should be exposed as a function in NAnt build 404 files. 405 </summary> 406 <remarks> 407 Attach this attribute to a method of a class that derives from 408 <see cref="T:NAnt.Core.FunctionSetBase"/> to have NAnt be able to recognize it. 409 </remarks> 410 </member> 411 <member name="M:NAnt.Core.Attributes.FunctionAttribute.#ctor(System.String)"> 412 <summary> 413 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionAttribute"/> 414 class with the specified name. 415 </summary> 416 <param name="name">The name of the function.</param> 417 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> 418 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 419 </member> 420 <member name="P:NAnt.Core.Attributes.FunctionAttribute.Name"> 421 <summary> 422 Gets or sets the name of the function. 423 </summary> 424 <value> 425 The name of the function. 426 </value> 427 </member> 428 <member name="T:NAnt.Core.Attributes.FunctionSetAttribute"> 429 <summary> 430 Indicates that class should be treated as a set of functions. 431 </summary> 432 <remarks> 433 Attach this attribute to a class that derives from <see cref="T:NAnt.Core.FunctionSetBase"/> 434 to have NAnt be able to recognize it as containing custom functions. 435 </remarks> 436 </member> 437 <member name="M:NAnt.Core.Attributes.FunctionSetAttribute.#ctor(System.String,System.String)"> 438 <summary> 439 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionSetAttribute"/> 440 class with the specified name. 441 </summary> 442 <param name="prefix">The prefix used to distinguish the functions.</param> 443 <param name="category">The category of the functions.</param> 444 <exception cref="T:System.ArgumentNullException"> 445 <para><paramref name="prefix"/> is <see langword="null"/>.</para> 446 <para>-or-</para> 447 <para><paramref name="category"/> is <see langword="null"/>.</para> 448 </exception> 449 <exception cref="T:System.ArgumentOutOfRangeException"> 450 <para><paramref name="prefix"/> is a zero-length <see cref="T:System.String"/>.</para> 451 <para>-or-</para> 452 <para><paramref name="category"/> is a zero-length <see cref="T:System.String"/>.</para> 453 </exception> 454 </member> 455 <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Category"> 456 <summary> 457 Gets or sets the category of the function set. 458 </summary> 459 <value> 460 The name of the category of the function set. 461 </value> 462 <remarks> 463 This will be displayed in the user docs. 464 </remarks> 465 </member> 466 <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Prefix"> 467 <summary> 468 Gets or sets the prefix of all functions in this function set. 469 </summary> 470 <value> 471 The prefix of the functions in this function set. 472 </value> 473 </member> 474 <member name="T:NAnt.Core.Attributes.Int32ValidatorAttribute"> 475 <summary> 476 Indicates that property should be able to be converted into a <see cref="T:System.Int32"/> 477 within the given range. 478 </summary> 479 </member> 480 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor"> 481 <summary> 482 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/> 483 class. 484 </summary> 485 </member> 486 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor(System.Int32,System.Int32)"> 487 <summary> 488 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/> 489 class with the specied minimum and maximum values. 490 </summary> 491 <param name="minValue">The minimum value.</param> 492 <param name="maxValue">The maximum value.</param> 493 </member> 494 <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.Validate(System.Object)"> 495 <summary> 496 Checks whether the specified value can be converted to an <see cref="T:System.Int32"/> 497 and whether the value lies within the range defined by the <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/> 498 and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/> properties. 499 </summary> 500 <param name="value">The value to be checked.</param> 501 <exception cref="T:NAnt.Core.ValidationException"> 502 <para> 503 <paramref name="value"/> cannot be converted to an <see cref="T:System.Int32"/>. 504 </para> 505 <para>-or-</para> 506 <para> 507 <paramref name="value"/> is not in the range defined by <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/> 508 and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/>. 509 </para> 510 </exception> 511 </member> 512 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"> 513 <summary> 514 Gets or sets the minimum value. 515 </summary> 516 <value> 517 The minimum value. The default is <see cref="F:System.Int32.MinValue"/>. 518 </value> 519 </member> 520 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"> 521 <summary> 522 Gets or sets the maximum value. 523 </summary> 524 <value> 525 The maximum value. The default is <see cref="F:System.Int32.MaxValue"/>. 526 </value> 527 </member> 528 <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.Base"> 529 <summary> 530 The base of the number to validate, which must be 2, 8, 10, or 16. 531 </summary> 532 <value> 533 The base of the number to validate. 534 </value> 535 <remarks> 536 The default is 10. 537 </remarks> 538 </member> 539 <member name="T:NAnt.Core.Attributes.LocationType"> 540 <summary> 541 Defines possible locations in which a task executable can be located. 542 </summary> 543 </member> 544 <member name="F:NAnt.Core.Attributes.LocationType.FrameworkDir"> 545 <summary> 546 Locates the task executable in the current Framework directory. 547 </summary> 548 </member> 549 <member name="F:NAnt.Core.Attributes.LocationType.FrameworkSdkDir"> 550 <summary> 551 Locates the task executable in the current Framework SDK directory. 552 </summary> 553 </member> 554 <member name="T:NAnt.Core.Attributes.ProgramLocationAttribute"> 555 <summary> 556 Indicates the location that a task executable can be located in. 557 </summary> 558 <remarks> 559 <para> 560 When applied to a task deriving from <see cref="T:NAnt.Core.Tasks.ExternalProgramBase"/>, 561 the program to execute will first be searched for in the designated 562 location. 563 </para> 564 <para> 565 If the program does not exist in that location, and the file name is 566 not an absolute path then the list of tool paths of the current 567 target framework will be searched (in the order in which they are 568 defined in the NAnt configuration file). 569 </para> 570 </remarks> 571 </member> 572 <member name="M:NAnt.Core.Attributes.ProgramLocationAttribute.#ctor(NAnt.Core.Attributes.LocationType)"> 573 <summary> 574 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/> 575 with the specified location. 576 </summary> 577 <param type="type">The <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the attribute.</param> 578 </member> 579 <member name="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"> 580 <summary> 581 Gets or sets the <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the task. 582 </summary> 583 <value> 584 The location type of the task to which the attribute is assigned. 585 </value> 586 </member> 587 <member name="T:NAnt.Core.Attributes.StringValidatorAttribute"> 588 <summary> 589 Used to indicate whether a <see cref="T:System.String"/> property should allow 590 an empty string value or not. 591 </summary> 592 </member> 593 <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.#ctor"> 594 <summary> 595 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/> 596 class. 597 </summary> 598 </member> 599 <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.Validate(System.Object)"> 600 <summary> 601 Checks if the specified value adheres to the rules defined by the 602 properties of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>. 603 </summary> 604 <param name="value">The value to be checked.</param> 605 <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> is an empty string value and <see cref="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty"/> is set to <see langword="false"/>.</exception> 606 </member> 607 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty"> 608 <summary> 609 Gets or sets a value indicating whether an empty string or 610 <see langword="null" /> should be a considered a valid value. 611 </summary> 612 <value> 613 <see langword="true" /> if an empty string or <see langword="null" /> 614 should be considered a valid value; otherwise, <see langword="false" />. 615 The default is <see langword="true" />. 616 </value> 617 </member> 618 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.Expression"> 619 <summary> 620 Gets or sets a regular expression. The string will be validated to 621 determine if it matches the expression. 622 </summary> 623 <value> 624 <see cref="N:System.Text.RegularExpressions"/> 625 </value> 626 </member> 627 <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.ExpressionErrorMessage"> 628 <summary> 629 An optional error message that can be used to better describe the 630 regular expression error. 631 </summary> 632 </member> 633 <member name="T:NAnt.Core.Attributes.TaskAttributeAttribute"> 634 <summary> 635 Indicates that property should be treated as a XML attribute for the 636 task. 637 </summary> 638 <example> 639 Examples of how to specify task attributes 640 <code> 641 // task XmlType default is string 642 [TaskAttribute("out", Required=true)] 643 string _out = null; // assign default value here 644 [TaskAttribute("optimize")] 645 [BooleanValidator()] 646 // during ExecuteTask you can safely use Convert.ToBoolean(_optimize) 647 string _optimize = Boolean.FalseString; 648 [TaskAttribute("warnlevel")] 649 [Int32Validator(0,4)] // limit values to 0-4 650 // during ExecuteTask you can safely use Convert.ToInt32(_optimize) 651 string _warnlevel = "0"; 652 [BuildElement("sources")] 653 FileSet _sources = new FileSet(); 654 </code> 655 NOTE: Attribute values must be of type of string if you want 656 to be able to have macros. The field stores the exact value during 657 Initialize. Just before ExecuteTask is called NAnt will expand 658 all the macros with the current values. 659 </example> 660 </member> 661 <member name="M:NAnt.Core.Attributes.TaskAttributeAttribute.#ctor(System.String)"> 662 <summary> 663 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskAttributeAttribute"/> 664 with the specified attribute name. 665 </summary> 666 <param name="name">The name of the task attribute.</param> 667 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception> 668 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 669 </member> 670 <member name="T:NAnt.Core.Attributes.TaskNameAttribute"> 671 <summary> 672 Indicates that class should be treated as a task. 673 </summary> 674 <remarks> 675 Attach this attribute to a subclass of Task to have NAnt be able 676 to recognize it. The name should be short but must not confict 677 with any other task already in use. 678 </remarks> 679 </member> 680 <member name="M:NAnt.Core.Attributes.TaskNameAttribute.#ctor(System.String)"> 681 <summary> 682 Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskNameAttribute"/> 683 with the specified name. 684 </summary> 685 <param name="name">The name of the task.</param> 686 <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception> 687 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception> 688 </member> 689 <member name="T:NAnt.Core.Element"> 690 <summary> 691 Models a NAnt XML element in the build file. 692 </summary> 693 <remarks> 694 <para> 695 Automatically validates attributes in the element based on attributes 696 applied to members in derived classes. 697 </para> 698 </remarks> 699 </member> 700 <member name="M:NAnt.Core.Element.#ctor"> 701 <summary> 702 Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class. 703 </summary> 704 </member> 705 <member name="M:NAnt.Core.Element.#ctor(NAnt.Core.Element)"> 706 <summary> 707 Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class 708 from the specified element. 709 </summary> 710 <param name="e">The element that should be used to create a new instance of the <see cref="T:NAnt.Core.Element"/> class.</param> 711 </member> 712 <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode)"> 713 <summary> 714 Performs default initialization. 715 </summary> 716 <remarks> 717 Derived classes that wish to add custom initialization should override 718 the <see cref="M:NAnt.Core.Element.Initialize"/> method. 719 </remarks> 720 </member> 721 <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String)"> 722 <summary> 723 Logs a message with the given priority. 724 </summary> 725 <param name="messageLevel">The message priority at which the specified message is to be logged.</param> 726 <param name="message">The message to be logged.</param> 727 <remarks> 728 The actual logging is delegated to the project. 729 </remarks> 730 </member> 731 <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String,System.Object[])"> 732 <summary> 733 Logs a message with the given priority. 734 </summary> 735 <param name="messageLevel">The message priority at which the specified message is to be logged.</param> 736 <param name="message">The message to log, containing zero or more format items.</param> 737 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param> 738 <remarks> 739 The actual logging is delegated to the project. 740 </remarks> 741 </member> 742 <member name="M:NAnt.Core.Element.InitializeElement(System.Xml.XmlNode)"> 743 <summary> 744 Derived classes should override to this method to provide extra 745 initialization and validation not covered by the base class. 746 </summary> 747 <param name="elementNode">The XML node of the element to use for initialization.</param> 748 </member> 749 <member name="M:NAnt.Core.Element.Initialize"> 750 <summary> 751 Derived classes should override to this method to provide extra 752 initialization and validation not covered by the base class. 753 </summary> 754 <remarks> 755 Access to the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize 756 this <see cref="T:NAnt.Core.Element"/> is available through <see cref="P:NAnt.Core.Element.XmlNode"/>. 757 </remarks> 758 </member> 759 <member name="M:NAnt.Core.Element.CopyTo(NAnt.Core.Element)"> 760 <summary> 761 Copies all instance data of the <see cref="T:NAnt.Core.Element"/> to a given 762 <see cref="T:NAnt.Core.Element"/>. 763 </summary> 764 </member> 765 <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)"> 766 <summary> 767 Performs initialization using the given set of properties. 768 </summary> 769 </member> 770 <member name="M:NAnt.Core.Element.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)"> 771 <summary> 772 Initializes all build attributes and child elements. 773 </summary> 774 </member> 775 <member name="M:NAnt.Core.Element.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)"> 776 <summary> 777 Locates the XML node for the specified attribute in the project 778 configuration node. 779 </summary> 780 <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param> 781 <param name="framework">The framework to use to obtain framework specific information, or <see langword="null" /> if no framework specific information should be used.</param> 782 <returns> 783 The XML configuration node for the specified attribute, or 784 <see langword="null" /> if no corresponding XML node could be 785 located. 786 </returns> 787 <remarks> 788 If there's a valid current framework, the configuration section for 789 that framework will first be searched. If no corresponding 790 configuration node can be located in that section, the framework-neutral 791 section of the project configuration node will be searched. 792 </remarks> 793 </member> 794 <member name="M:NAnt.Core.Element.GetElementNameFromType(System.Type)"> 795 <summary> 796 Returns the <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> of the 797 <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned to the specified 798 <see cref="T:System.Type"/>. 799 </summary> 800 <param name="type">The <see cref="T:System.Type"/> of which the assigned <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> should be retrieved.</param> 801 <returns> 802 The <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> assigned to the specified 803 <see cref="T:System.Type"/> or a null reference is no <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> 804 is assigned to the <paramref name="type"/>. 805 </returns> 806 </member> 807 <member name="P:NAnt.Core.Element.Parent"> 808 <summary> 809 Gets or sets the parent of the element. 810 </summary> 811 <value> 812 The parent of the element. 813 </value> 814 <remarks> 815 This will be the parent <see cref="T:NAnt.Core.Task"/>, <see cref="T:NAnt.Core.Target"/>, or 816 <see cref="P:NAnt.Core.Element.Project"/> depending on where the element is defined. 817 </remarks> 818 </member> 819 <member name="P:NAnt.Core.Element.Name"> 820 <summary> 821 Gets the name of the XML element used to initialize this element. 822 </summary> 823 <value> 824 The name of the XML element used to initialize this element. 825 </value> 826 </member> 827 <member name="P:NAnt.Core.Element.Project"> 828 <summary> 829 Gets or sets the <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs. 830 </summary> 831 <value> 832 The <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs. 833 </value> 834 </member> 835 <member name="P:NAnt.Core.Element.Properties"> 836 <summary> 837 Gets the properties local to this <see cref="T:NAnt.Core.Element"/> and the 838 <see cref="P:NAnt.Core.Element.Project"/>. 839 </summary> 840 <value> 841 The properties local to this <see cref="T:NAnt.Core.Element"/> and the <see cref="P:NAnt.Core.Element.Project"/>. 842 </value> 843 </member> 844 <member name="P:NAnt.Core.Element.NamespaceManager"> 845 <summary> 846 Gets or sets the <see cref="T:System.Xml.XmlNamespaceManager"/>. 847 </summary> 848 <value> 849 The <see cref="T:System.Xml.XmlNamespaceManager"/>. 850 </value> 851 <remarks> 852 The <see cref="P:NAnt.Core.Element.NamespaceManager"/> defines the current namespace 853 scope and provides methods for looking up namespace information. 854 </remarks> 855 </member> 856 <member name="P:NAnt.Core.Element.XmlNode"> 857 <summary> 858 Gets or sets the XML node of the element. 859 </summary> 860 <value> 861 The XML node of the element. 862 </value> 863 </member> 864 <member name="P:NAnt.Core.Element.Location"> 865 <summary> 866 Gets or sets the location in the build file where the element is 867 defined. 868 </summary> 869 <value> 870 The location in the build file where the element is defined. 871 </value> 872 </member> 873 <member name="P:NAnt.Core.Element.CustomXmlProcessing"> 874 <summary> 875 Gets a value indicating whether the element is performing additional 876 processing using the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to 877 initialize the element. 878 </summary> 879 <value> 880 <see langword="false"/>. 881 </value> 882 <remarks> 883 <para> 884 Elements that need to perform additional processing of the 885 <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize the element, should 886 override this property and return <see langword="true"/>. 887 </para> 888 <para> 889 When <see langword="true"/>, no build errors will be reported for 890 unknown nested build elements. 891 </para> 892 </remarks> 893 </member> 894 <member name="T:NAnt.Core.Element.AttributeConfigurator"> 895 <summary> 896 Configures an <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using meta-data provided by 897 assigned attributes. 898 </summary> 899 </member> 900 <member name="M:NAnt.Core.Element.AttributeConfigurator.#ctor(NAnt.Core.Element,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)"> 901 <summary> 902 Initializes a new instance of the <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> 903 class for the given <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>. 904 </summary> 905 <param name="element">The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> should be created.</param> 906 <param name="elementNode">The <see cref="P:NAnt.Core.Element.XmlNode"/> to initialize the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> with.</param> 907 <param name="properties">The <see cref="T:NAnt.Core.PropertyDictionary"/> to use for property expansion.</param> 908 <param name="targetFramework">The framework that the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> should target.</param> 909 <exception cref="T:System.ArgumentNullException"> 910 <para><paramref name="element"/> is <see langword="null"/>.</para> 911 <para>-or-</para> 912 <para><paramref name="elementNode"/> is <see langword="null"/>.</para> 913 <para>-or-</para> 914 <para><paramref name="properties"/> is <see langword="null"/>.</para> 915 </exception> 916 </member> 917 <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateChildBuildElement(System.Reflection.PropertyInfo,System.Reflection.MethodInfo,System.Reflection.MethodInfo,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)"> 918 <summary> 919 Creates a child <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using property set/get methods. 920 </summary> 921 <param name="propInf">The <see cref="T:System.Reflection.PropertyInfo"/> instance that represents the property of the current class.</param> 922 <param name="getter">A <see cref="T:System.Reflection.MethodInfo"/> representing the get accessor for the property.</param> 923 <param name="setter">A <see cref="T:System.Reflection.MethodInfo"/> representing the set accessor for the property.</param> 924 <param name="xml">The <see cref="P:NAnt.Core.Element.XmlNode"/> used to initialize the new <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> instance.</param> 925 <param name="properties">The collection of property values to use for macro expansion.</param> 926 <param name="framework">The <see cref="T:NAnt.Core.FrameworkInfo"/> from which to obtain framework-specific information.</param> 927 <returns>The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> child.</returns> 928 </member> 929 <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateAttributeSetter(System.Type)"> 930 <summary> 931 Creates an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given 932 <see cref="T:System.Type"/>. 933 </summary> 934 <param name="attributeType">The <see cref="T:System.Type"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> should be created.</param> 935 <returns> 936 An <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given <see cref="T:System.Type"/>. 937 </returns> 938 </member> 939 <member name="F:NAnt.Core.Element.AttributeConfigurator._element"> 940 <summary> 941 Holds the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that should be initialized. 942 </summary> 943 </member> 944 <member name="F:NAnt.Core.Element.AttributeConfigurator._elementXml"> 945 <summary> 946 Holds the <see cref="P:NAnt.Core.Element.XmlNode"/> that should be used to initialize 947 the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>. 948 </summary> 949 </member> 950 <member name="F:NAnt.Core.Element.AttributeConfigurator._properties"> 951 <summary> 952 Holds the dictionary that should be used for property 953 expansion. 954 </summary> 955 </member> 956 <member name="F:NAnt.Core.Element.AttributeConfigurator._targetFramework"> 957 <summary> 958 Holds the framework that should be targeted by the 959 <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that we're configuring, or 960 <see langword="null"/> if there's no current target 961 framework. 962 </summary> 963 </member> 964 <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedAttributes"> 965 <summary> 966 Holds the names of the attributes that still need to be 967 processed. 968 </summary> 969 </member> 970 <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedChildNodes"> 971 <summary> 972 Holds the names of the child nodes that still need to be 973 processed. 974 </summary> 975 </member> 976 <member name="F:NAnt.Core.Element.AttributeConfigurator.logger"> 977 <summary> 978 Holds the logger for the current class. 979 </summary> 980 </member> 981 <member name="F:NAnt.Core.Element.AttributeConfigurator.AttributeSetters"> 982 <summary> 983 Holds the cache of <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> instances. 984 </summary> 985 </member> 986 <member name="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager"> 987 <summary> 988 Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>. 989 </summary> 990 <value> 991 The <see cref="T:System.Xml.XmlNamespaceManager"/>. 992 </value> 993 <remarks> 994 The <see cref="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager"/> defines the current namespace 995 scope and provides methods for looking up namespace information. 996 </remarks> 997 </member> 998 <member name="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"> 999 <summary> 1000 Internal interface used for setting element attributes. 1001 </summary> 1002 </member> 1003 <member name="T:NAnt.Core.Configuration.DirList"> 1004 <summary> 1005 Represents an explicitly named list of directories. 1006 </summary> 1007 <remarks> 1008 A <see cref="T:NAnt.Core.Configuration.DirList"/> is useful when you want to capture a list of 1009 directories regardless whether they currently exist. 1010 </remarks> 1011 </member> 1012 <member name="P:NAnt.Core.Configuration.DirList.Directory"> 1013 <summary> 1014 The base of the directory of this dirlist. The default is the project 1015 base directory. 1016 </summary> 1017 </member> 1018 <member name="P:NAnt.Core.Configuration.ManagedExecutionMode.Environment"> 1019 <summary> 1020 Gets the collection of environment variables that should be passed 1021 to external programs that are launched. 1022 </summary> 1023 <value> 1024 <summary> 1025 The collection of environment variables that should be passed 1026 to external programs that are launched. 1027 </summary> 1028 </value> 1029 </member> 1030 <member name="P:NAnt.Core.Configuration.RuntimeEngine.Arguments"> 1031 <summary> 1032 The command-line arguments for the runtime engine. 1033 </summary> 1034 </member> 1035 <member name="T:NAnt.Core.Extensibility.ExtensionAssembly"> 1036 <summary> 1037 Represents an <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> in which one or more extensions 1038 are found. 1039 </summary> 1040 </member> 1041 <member name="M:NAnt.Core.Extensibility.ExtensionAssembly.#ctor(System.Reflection.Assembly)"> 1042 <summary> 1043 Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> 1044 class for a given <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/>. 1045 </summary> 1046 <remarks> 1047 The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> instance is not cached for 1048 future use. If this is required, use <see cref="M:NAnt.Core.Extensibility.ExtensionAssembly.Create(System.Reflection.Assembly)"/>. 1049 </remarks> 1050 <param name="assembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> for which to construct an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.</param> 1051 </member> 1052 <member name="M:NAnt.Core.Extensibility.ExtensionAssembly.Create(System.Reflection.Assembly)"> 1053 <summary> 1054 Creates an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified 1055 <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> and caches it for future use. 1056 </summary> 1057 <remarks> 1058 If an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the same assembly is 1059 available in the cache, then this cached instance is returned. 1060 </remarks> 1061 <param name="assembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> for which to construct an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.</param> 1062 <returns> 1063 The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/>. 1064 </returns> 1065 </member> 1066 <member name="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"> 1067 <summary> 1068 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> containing extensions. 1069 </summary> 1070 </member> 1071 <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly)"> 1072 <summary> 1073 Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/> 1074 class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/>. 1075 </summary> 1076 <param name="extensionAssembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension is found.</param> 1077 <exception cref="T:System.ArgumentNullException"><paramref name="extensionAssembly"/> is <see langword="null"/>.</exception> 1078 </member> 1079 <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(System.Reflection.Assembly)"> 1080 <summary> 1081 Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/> 1082 class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/>. 1083 </summary> 1084 <param name="assembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> in which the extension is found.</param> 1085 <exception cref="T:System.ArgumentNullException"><paramref name="assembly"/> is <see langword="null"/>.</exception> 1086 </member> 1087 <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"> 1088 <summary> 1089 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension 1090 was found. 1091 </summary> 1092 </member> 1093 <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"> 1094 <summary> 1095 Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> from which the extension will 1096 be created. 1097 </summary> 1098 <value> 1099 The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> containing the extension. 1100 </value> 1101 </member> 1102 <member name="M:NAnt.Core.Extensibility.PluginConsumerAttribute.#ctor(System.Type)"> 1103 <summary> 1104 Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.PluginConsumerAttribute"/> 1105 with the specified type. 1106 </summary> 1107 <param name="type">The type of the <see cref="T:NAnt.Core.Extensibility.IPlugin"/> to consume.</param> 1108 <exception cref="T:System.ArgumentNullException"><paramref name="type"/> is <see langword="null"/>.</exception> 1109 </member> 1110 <member name="T:NAnt.Core.Extensibility.PluginScanner"> 1111 <summary> 1112 Responsible for scanning types for plugins, and maintaining a cache of 1113 <see cref="T:NAnt.Core.Extensibility.PluginBuilder"/> instances. 1114 </summary> 1115 </member> 1116 <member name="M:NAnt.Core.Extensibility.PluginScanner.ScanTypeForPlugins(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)"> 1117 <summary> 1118 Scans a given <see cref="T:System.Type"/> for plugins. 1119 </summary> 1120 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param> 1121 <param name="type">The <see cref="T:System.Type"/> to scan.</param> 1122 <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param> 1123 <returns> 1124 <see langword="true"/> if <paramref name="type"/> represents a 1125 <see cref="T:NAnt.Core.Extensibility.IPlugin"/>; otherwise, <see langword="false"/>. 1126 </returns> 1127 </member> 1128 <member name="M:NAnt.Core.Extensibility.PluginScanner.RegisterPlugins(NAnt.Core.Extensibility.IPluginConsumer)"> 1129 <summary> 1130 Registers matching plugins for the specified <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/>. 1131 </summary> 1132 <param name="consumer">The <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/> which plugins must be registered for.</param> 1133 <exception cref="T:System.ArgumentNullException"><paramref name="consumer"/> is <see langword="null"/>.</exception> 1134 </member> 1135 <member name="T:NAnt.Core.Filters.ChainableReader"> 1136 <summary> 1137 Functions as a chainable TextReader 1138 </summary> 1139 <remarks> 1140 Implements a abstraction over a TextReader that allows the class to represent 1141 either a TextReader or another ChainableReader to which it is chained. 1142 By passing a ChainableReader as a constructor paramater it is possiable to 1143 chain many ChainableReaders together. The last ChainableReader in the chain must 1144 be based on a TextReader. 1145 </remarks> 1146 </member> 1147 <member name="M:NAnt.Core.Filters.ChainableReader.Chain(NAnt.Core.Filters.ChainableReader)"> 1148 <summary> 1149 Makes it so all calls to Read and Peek are passed the ChainableReader 1150 passed as a parameter. 1151 </summary> 1152 <param name="parentChainedReader">ChainableReader to forward calls to</param> 1153 </member> 1154 <member name="M:NAnt.Core.Filters.ChainableReader.Chain(System.IO.TextReader)"> 1155 <summary> 1156 Makes it so all calls to Read and Peek are passed the TextReader 1157 passed as a parameter. 1158 </summary> 1159 <param name="baseReader">TextReader to forward calls to</param> 1160 </member> 1161 <member name="M:NAnt.Core.Filters.ChainableReader.Peek"> 1162 <summary> 1163 Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor. 1164 </summary> 1165 <returns>Character or -1 if end of stream</returns> 1166 </member> 1167 <member name="M:NAnt.Core.Filters.ChainableReader.Read"> 1168 <summary> 1169 Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor. 1170 </summary> 1171 <returns> 1172 Character or -1 if end of stream. 1173 </returns> 1174 </member> 1175 <member name="M:NAnt.Core.Filters.ChainableReader.Close"> 1176 <summary> 1177 Closes the reader. 1178 </summary> 1179 </member> 1180 <member name="M:NAnt.Core.Filters.ChainableReader.Dispose"> 1181 <summary> 1182 Calls close and supresses the finalizer for the object. 1183 </summary> 1184 </member> 1185 <member name="P:NAnt.Core.Filters.ChainableReader.Base"> 1186 <summary> 1187 Gets a value indicating if the reader is backed by a stream in the 1188 chain. 1189 </summary> 1190 <value> 1191 <see langword="true" /> if the reader is backed by a stream; 1192 otherwise, <see langword="false" />. 1193 </value> 1194 </member> 1195 <member name="T:NAnt.Core.Filters.Filter"> 1196 <summary> 1197 Allows a file's content to be modified while performing an operation. 1198 </summary> 1199 </member> 1200 <member name="M:NAnt.Core.Filters.Filter.InitializeFilter"> 1201 <summary> 1202 Called after construction and after properties are set. Allows 1203 for filter initialization. 1204 </summary> 1205 </member> 1206 <member name="P:NAnt.Core.Filters.Filter.IfDefined"> 1207 <summary> 1208 If <see langword="true" /> then the filter will be used; otherwise, 1209 skipped. The default is <see langword="true" />. 1210 </summary> 1211 </member> 1212 <member name="P:NAnt.Core.Filters.Filter.UnlessDefined"> 1213 <summary> 1214 Opposite of <see cref="P:NAnt.Core.Filters.Filter.IfDefined"/>. If <see langword="false"/> 1215 then the filter will be executed; otherwise, skipped. The default 1216 is <see langword="false"/>. 1217 </summary> 1218 </member> 1219 <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(System.Reflection.Assembly,System.String)"> 1220 <summary> 1221 Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class 1222 for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified 1223 <see cref="T:System.Reflection.Assembly"/>. 1224 </summary> 1225 <remarks> 1226 An <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> for the specified <see cref="T:System.Reflection.Assembly"/> 1227 is cached for future use. 1228 </remarks> 1229 <param name="assembly">The <see cref="T:System.Reflection.Assembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param> 1230 <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param> 1231 </member> 1232 <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)"> 1233 <summary> 1234 Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class 1235 for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified 1236 <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>. 1237 </summary> 1238 <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param> 1239 <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param> 1240 </member> 1241 <member name="P:NAnt.Core.Filters.FilterBuilder.ClassName"> 1242 <summary> 1243 Gets the name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created 1244 using this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>. 1245 </summary> 1246 <value> 1247 The name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created using 1248 this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>. 1249 </value> 1250 </member> 1251 <member name="P:NAnt.Core.Filters.FilterBuilder.FilterName"> 1252 <summary> 1253 Gets the name of the filter which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> 1254 can create. 1255 </summary> 1256 <value> 1257 The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can 1258 create. 1259 </value> 1260 </member> 1261 <member name="T:NAnt.Core.Filters.FilterBuilderCollection"> 1262 <summary> 1263 Contains a strongly typed collection of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> objects. 1264 </summary> 1265 </member> 1266 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor"> 1267 <summary> 1268 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class. 1269 </summary> 1270 </member> 1271 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilderCollection)"> 1272 <summary> 1273 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class 1274 with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> instance. 1275 </summary> 1276 </member> 1277 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilder[])"> 1278 <summary> 1279 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class 1280 with the specified array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances. 1281 </summary> 1282 </member> 1283 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Add(NAnt.Core.Filters.FilterBuilder)"> 1284 <summary> 1285 Adds a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to the end of the collection. 1286 </summary> 1287 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to be added to the end of the collection.</param> 1288 <returns>The position into which the new element was inserted.</returns> 1289 </member> 1290 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilder[])"> 1291 <summary> 1292 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> array to the end of the collection. 1293 </summary> 1294 <param name="items">The array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements to be added to the end of the collection.</param> 1295 </member> 1296 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilderCollection)"> 1297 <summary> 1298 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to the end of the collection. 1299 </summary> 1300 <param name="items">The <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to be added to the end of the collection.</param> 1301 </member> 1302 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(NAnt.Core.Filters.FilterBuilder)"> 1303 <summary> 1304 Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is in the collection. 1305 </summary> 1306 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to locate in the collection.</param> 1307 <returns> 1308 <see langword="true"/> if <paramref name="item"/> is found in the 1309 collection; otherwise, <see langword="false"/>. 1310 </returns> 1311 </member> 1312 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(System.String)"> 1313 <summary> 1314 Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified 1315 task is in the collection. 1316 </summary> 1317 <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param> 1318 <returns> 1319 <see langword="true"/> if a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for 1320 the specified task is found in the collection; otherwise, 1321 <see langword="false"/>. 1322 </returns> 1323 </member> 1324 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.CopyTo(NAnt.Core.Filters.FilterBuilder[],System.Int32)"> 1325 <summary> 1326 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. 1327 </summary> 1328 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param> 1329 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param> 1330 </member> 1331 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.IndexOf(NAnt.Core.Filters.FilterBuilder)"> 1332 <summary> 1333 Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object in the collection. 1334 </summary> 1335 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object for which the index is returned.</param> 1336 <returns> 1337 The index of the specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/>. If the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is not currently a member of the collection, it returns -1. 1338 </returns> 1339 </member> 1340 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Insert(System.Int32,NAnt.Core.Filters.FilterBuilder)"> 1341 <summary> 1342 Inserts a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> into the collection at the specified index. 1343 </summary> 1344 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> 1345 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to insert.</param> 1346 </member> 1347 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.GetEnumerator"> 1348 <summary> 1349 Returns an enumerator that can iterate through the collection. 1350 </summary> 1351 <returns> 1352 A <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> for the entire collection. 1353 </returns> 1354 </member> 1355 <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Remove(NAnt.Core.Filters.FilterBuilder)"> 1356 <summary> 1357 Removes a member from the collection. 1358 </summary> 1359 <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to remove from the collection.</param> 1360 </member> 1361 <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.Int32)"> 1362 <summary> 1363 Gets or sets the element at the specified index. 1364 </summary> 1365 <param name="index">The zero-based index of the element to get or set.</param> 1366 </member> 1367 <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.String)"> 1368 <summary> 1369 Gets the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified task. 1370 </summary> 1371 <param name="filterName">The name of the filter for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param> 1372 </member> 1373 <member name="T:NAnt.Core.Filters.FilterBuilderEnumerator"> 1374 <summary> 1375 Enumerates the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>. 1376 </summary> 1377 </member> 1378 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.#ctor(NAnt.Core.Filters.FilterBuilderCollection)"> 1379 <summary> 1380 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> class 1381 with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>. 1382 </summary> 1383 <param name="arguments">The collection that should be enumerated.</param> 1384 </member> 1385 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.MoveNext"> 1386 <summary> 1387 Advances the enumerator to the next element of the collection. 1388 </summary> 1389 <returns> 1390 <see langword="true" /> if the enumerator was successfully advanced 1391 to the next element; <see langword="false" /> if the enumerator has 1392 passed the end of the collection. 1393 </returns> 1394 </member> 1395 <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.Reset"> 1396 <summary> 1397 Sets the enumerator to its initial position, which is before the 1398 first element in the collection. 1399 </summary> 1400 </member> 1401 <member name="P:NAnt.Core.Filters.FilterBuilderEnumerator.Current"> 1402 <summary> 1403 Gets the current element in the collection. 1404 </summary> 1405 <returns> 1406 The current element in the collection. 1407 </returns> 1408 </member> 1409 <member name="T:NAnt.Core.Filters.FilterChain"> 1410 <summary> 1411 Represent a chain of NAnt filters that can be applied to a <see cref="T:NAnt.Core.Task"/>. 1412 </summary> 1413 <remarks> 1414 <para> 1415 A FilterChain represents a collection of one or more filters that can 1416 be appled to a <see cref="T:NAnt.Core.Task"/> such as the <see cref="T:NAnt.Core.Tasks.CopyTask"/>. 1417 In the case of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>, the contents of the copied 1418 files are filtered through each filter specified in the filter chain. 1419 Filtering occurs in the order the filters are specified with filtered 1420 output of one filter feeding into another. 1421 </para> 1422 <para> 1423 :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/> 1424 :.Source.:--->:.Filter 1.:--->:.Filter 2.: ... :.Filter n.:--->:.target.:<br/> 1425 :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/> 1426 </para> 1427 <para> 1428 A list of all filters that come with NAnt is available <see href="../filters/index.html">here</see>. 1429 </para> 1430 <para> 1431 The following tasks support filtering with a FilterChain: 1432 </para> 1433 <list type="bullet"> 1434 <item> 1435 <description><see cref="T:NAnt.Core.Tasks.CopyTask"/></description> 1436 </item> 1437 <item> 1438 <description><see cref="T:NAnt.Core.Tasks.MoveTask"/></description> 1439 </item> 1440 </list> 1441 </remarks> 1442 <example> 1443 <para> 1444 Replace all occurrences of @NOW@ with the current date/time and 1445 replace tabs with spaces in all copied files. 1446 </para> 1447 <code> 1448 <![CDATA[ 1449 <property name="NOW" value="${datetime::now()}" /> 1450 <copy todir="out"> 1451 <fileset basedir="in"> 1452 <include name="**/*" /> 1453 </fileset> 1454 <filterchain> 1455 <replacetokens> 1456 <token key="NOW" value="${TODAY}" /> 1457 </replacetokens> 1458 <tabstospaces /> 1459 </filterchain> 1460 </copy> 1461 ]]> 1462 </code> 1463 </example> 1464 </member> 1465 <member name="T:NAnt.Core.DataTypeBase"> 1466 <summary> 1467 Provides the abstract base class for types. 1468 </summary> 1469 </member> 1470 <member name="M:NAnt.Core.DataTypeBase.Reset"> 1471 <summary> 1472 Should be overridden by derived classes. clones the referenced types 1473 data into the current instance. 1474 </summary> 1475 </member> 1476 <member name="M:NAnt.Core.DataTypeBase.CopyTo(NAnt.Core.DataTypeBase)"> 1477 <summary> 1478 Copies all instance data of the <see cref="T:NAnt.Core.DataTypeBase"/> to a given 1479 <see cref="T:NAnt.Core.DataTypeBase"/>. 1480 </summary> 1481 </member> 1482 <member name="P:NAnt.Core.DataTypeBase.ID"> 1483 <summary> 1484 The ID used to be referenced later. 1485 </summary> 1486 </member> 1487 <member name="P:NAnt.Core.DataTypeBase.RefID"> 1488 <summary> 1489 The ID to use as the reference. 1490 </summary> 1491 </member> 1492 <member name="P:NAnt.Core.DataTypeBase.CanBeReferenced"> 1493 <summary> 1494 Gets a value indicating whether a reference to the type can be 1495 defined. 1496 </summary> 1497 <remarks> 1498 Only types with an <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned 1499 to it, can be referenced. 1500 </remarks> 1501 </member> 1502 <member name="P:NAnt.Core.DataTypeBase.Name"> 1503 <summary> 1504 Gets the name of the datatype. 1505 </summary> 1506 <value> 1507 The name of the datatype. 1508 </value> 1509 </member> 1510 <member name="M:NAnt.Core.Filters.FilterChain.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)"> 1511 <summary> 1512 Initializes all build attributes and child elements. 1513 </summary> 1514 <remarks> 1515 <see cref="T:NAnt.Core.Filters.FilterChain"/> needs to maintain the order in which the 1516 filters are specified in the build file. 1517 </remarks> 1518 </member> 1519 <member name="M:NAnt.Core.Filters.FilterChain.GetBaseFilter(NAnt.Core.Filters.PhysicalTextReader)"> 1520 <summary> 1521 Used to to instantiate and return the chain of stream based filters. 1522 </summary> 1523 <param name="physicalTextReader">The <see cref="T:NAnt.Core.Filters.PhysicalTextReader"/> that is the source of input to the filter chain.</param> 1524 <remarks> 1525 The <paramref name="physicalTextReader"/> is the first <see cref="T:NAnt.Core.Filters.Filter"/> 1526 in the chain, which is based on a physical stream that feeds the chain. 1527 </remarks> 1528 <returns> 1529 The last <see cref="T:NAnt.Core.Filters.Filter"/> in the chain. 1530 </returns> 1531 </member> 1532 <member name="P:NAnt.Core.Filters.FilterChain.Filters"> 1533 <summary> 1534 The filters to apply. 1535 </summary> 1536 </member> 1537 <member name="P:NAnt.Core.Filters.FilterChain.InputEncoding"> 1538 <summary> 1539 The encoding to assume when filter-copying files. The default is 1540 system's current ANSI code page. 1541 </summary> 1542 </member> 1543 <member name="T:NAnt.Core.Filters.FilterChain.FilterChainConfigurator"> 1544 <summary> 1545 Configurator that initializes filters in the order in which they've 1546 been specified in the build file. 1547 </summary> 1548 </member> 1549 <member name="T:NAnt.Core.Filters.FilterCollection"> 1550 <summary> 1551 Contains a collection of <see cref="T:NAnt.Core.Filters.Filter"/> elements. 1552 </summary> 1553 </member> 1554 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor"> 1555 <summary> 1556 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class. 1557 </summary> 1558 </member> 1559 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.FilterCollection)"> 1560 <summary> 1561 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class 1562 with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/> instance. 1563 </summary> 1564 </member> 1565 <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.Filter[])"> 1566 <summary> 1567 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class 1568 with the specified array of <see cref="T:NAnt.Core.Filters.Filter"/> instances. 1569 </summary> 1570 </member> 1571 <member name="M:NAnt.Core.Filters.FilterCollection.Add(NAnt.Core.Filters.Filter)"> 1572 <summary> 1573 Adds a <see cref="T:NAnt.Core.Filters.Filter"/> to the end of the collection. 1574 </summary> 1575 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to be added to the end of the collection.</param> 1576 <returns>The position into which the new element was inserted.</returns> 1577 </member> 1578 <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.Filter[])"> 1579 <summary> 1580 Adds the elements of a <see cref="T:NAnt.Core.Filters.Filter"/> array to the end of the collection. 1581 </summary> 1582 <param name="items">The array of <see cref="T:NAnt.Core.Filters.Filter"/> elements to be added to the end of the collection.</param> 1583 </member> 1584 <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.FilterCollection)"> 1585 <summary> 1586 Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/> to the end of the collection. 1587 </summary> 1588 <param name="items">The <see cref="T:NAnt.Core.Filters.FilterCollection"/> to be added to the end of the collection.</param> 1589 </member> 1590 <member name="M:NAnt.Core.Filters.FilterCollection.Contains(NAnt.Core.Filters.Filter)"> 1591 <summary> 1592 Determines whether a <see cref="T:NAnt.Core.Filters.Filter"/> is in the collection. 1593 </summary> 1594 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to locate in the collection.</param> 1595 <returns> 1596 <see langword="true"/> if <paramref name="item"/> is found in the 1597 collection; otherwise, <see langword="false"/>. 1598 </returns> 1599 </member> 1600 <member name="M:NAnt.Core.Filters.FilterCollection.CopyTo(NAnt.Core.Filters.Filter[],System.Int32)"> 1601 <summary> 1602 Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. 1603 </summary> 1604 <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param> 1605 <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param> 1606 </member> 1607 <member name="M:NAnt.Core.Filters.FilterCollection.IndexOf(NAnt.Core.Filters.Filter)"> 1608 <summary> 1609 Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.Filter"/> object in the collection. 1610 </summary> 1611 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> object for which the index is returned.</param> 1612 <returns> 1613 The index of the specified <see cref="T:NAnt.Core.Filters.Filter"/>. If the <see cref="T:NAnt.Core.Filters.Filter"/> is not currently a member of the collection, it returns -1. 1614 </returns> 1615 </member> 1616 <member name="M:NAnt.Core.Filters.FilterCollection.Insert(System.Int32,NAnt.Core.Filters.Filter)"> 1617 <summary> 1618 Inserts a <see cref="T:NAnt.Core.Filters.Filter"/> into the collection at the specified index. 1619 </summary> 1620 <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> 1621 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to insert.</param> 1622 </member> 1623 <member name="M:NAnt.Core.Filters.FilterCollection.GetEnumerator"> 1624 <summary> 1625 Returns an enumerator that can iterate through the collection. 1626 </summary> 1627 <returns> 1628 A <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> for the entire collection. 1629 </returns> 1630 </member> 1631 <member name="M:NAnt.Core.Filters.FilterCollection.Remove(NAnt.Core.Filters.Filter)"> 1632 <summary> 1633 Removes a member from the collection. 1634 </summary> 1635 <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to remove from the collection.</param> 1636 </member> 1637 <member name="P:NAnt.Core.Filters.FilterCollection.Item(System.Int32)"> 1638 <summary> 1639 Gets or sets the element at the specified index. 1640 </summary> 1641 <param name="index">The zero-based index of the element to get or set.</param> 1642 </member> 1643 <member name="T:NAnt.Core.Filters.FilterEnumerator"> 1644 <summary> 1645 Enumerates the <see cref="T:NAnt.Core.Filters.Filter"/> elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/>. 1646 </summary> 1647 </member> 1648 <member name="M:NAnt.Core.Filters.FilterEnumerator.#ctor(NAnt.Core.Filters.FilterCollection)"> 1649 <summary> 1650 Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> class 1651 with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/>. 1652 </summary> 1653 <param name="arguments">The collection that should be enumerated.</param> 1654 </member> 1655 <member name="M:NAnt.Core.Filters.FilterEnumerator.MoveNext"> 1656 <summary> 1657 Advances the enumerator to the next element of the collection. 1658 </summary> 1659 <returns> 1660 <see langword="true" /> if the enumerator was successfully advanced 1661 to the next element; <see langword="false" /> if the enumerator has 1662 passed the end of the collection. 1663 </returns> 1664 </member> 1665 <member name="M:NAnt.Core.Filters.FilterEnumerator.Reset"> 1666 <summary> 1667 Sets the enumerator to its initial position, which is before the 1668 first element in the collection. 1669 </summary> 1670 </member> 1671 <member name="P:NAnt.Core.Filters.FilterEnumerator.Current"> 1672 <summary> 1673 Gets the current element in the collection. 1674 </summary> 1675 <returns> 1676 The current element in the collection. 1677 </returns> 1678 </member> 1679 <member name="T:NAnt.Core.Filters.PhysicalTextReader"> 1680 <summary> 1681 Represents a physical <see cref="T:System.IO.TextReader"/>. That is a reader based 1682 on a stream. 1683 </summary> 1684 <remarks> 1685 Used by <see cref="T:NAnt.Core.Filters.ChainableReader"/> to represent a <see cref="T:NAnt.Core.Filters.Filter"/> 1686 based on a <see cref="T:System.IO.TextReader"/> in the chain. 1687 </remarks> 1688 </member> 1689 <member name="T:NAnt.Core.Filters.ExpandProperties"> 1690 <summary> 1691 Parses NAnt properties and expressions 1692 </summary> 1693 <remarks> 1694 <para> 1695 This filter parses any NAnt properties or expressions found in its input, 1696 inlining their values in its output. 1697 </para> 1698 <para> 1699 Note: Due to limitations on buffering, expressions longer than 2048 1700 characters are not guaranteed to be expanded. 1701 </para> 1702 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>. 1703 </remarks> 1704 <example> 1705 <para>Replace all properties with their corresponding values.</para> 1706 <code> 1707 <![CDATA[ 1708 <expandproperties /> 1709 ]]> 1710 </code> 1711 </example> 1712 </member> 1713 <member name="F:NAnt.Core.Filters.ExpandProperties._buffer"> 1714 <summary> 1715 Holds data for expression expansion between input and output. 1716 </summary> 1717 </member> 1718 <member name="M:NAnt.Core.Filters.ExpandProperties.InitializeFilter"> 1719 <summary> 1720 Called after construction and after properties are set. Allows 1721 for filter initialization. 1722 </summary> 1723 </member> 1724 <member name="M:NAnt.Core.Filters.ExpandProperties.Read"> 1725 <summary> 1726 Reads the next character applying the filter logic. 1727 </summary> 1728 <returns>Char as an int or -1 if at the end of the stream</returns> 1729 </member> 1730 <member name="M:NAnt.Core.Filters.ExpandProperties.Peek"> 1731 <summary> 1732 Reads the next character applying the filter logic without advancing the current position in the stream. 1733 </summary> 1734 <returns>Char as an int or -1 if at the end of the stream</returns> 1735 </member> 1736 <member name="M:NAnt.Core.Filters.ExpandProperties.Advance"> 1737 <summary> 1738 Moves to the next character. 1739 </summary> 1740 </member> 1741 <member name="M:NAnt.Core.Filters.ExpandProperties.ReplenishBuffer"> 1742 <summary> 1743 Refills the buffer, running our input through 1744 <see cref="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)"/>.) 1745 </summary> 1746 </member> 1747 <member name="P:NAnt.Core.Filters.ExpandProperties.AtEnd"> 1748 <summary> 1749 Determines whether we've passed the end of our data. 1750 </summary> 1751 </member> 1752 <member name="T:NAnt.Core.Filters.ReplaceString"> 1753 <summary> 1754 Replaces all occurrences of a given string in the original input with 1755 user-supplied replacement string. 1756 </summary> 1757 <remarks> 1758 <para> 1759 This filter replaces all occurrences of a given string in the original 1760 input stream with a user-supplied replacement string. By default string 1761 comparisons are case sensitive but this can be changed by setting the 1762 optional <see cref="P:NAnt.Core.Filters.ReplaceString.IgnoreCase"/> attribute to <see langword="true"/>. 1763 </para> 1764 <para> 1765 To use this filter specify the string to be replaced with the 1766 <see cref="P:NAnt.Core.Filters.ReplaceString.From"/> attribute and the string to replace it with using the 1767 <see cref="P:NAnt.Core.Filters.ReplaceString.To"/> attribute. 1768 </para> 1769 <para> 1770 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>. 1771 </para> 1772 </remarks> 1773 <example> 1774 <para> 1775 Replace all occurrences of "3.14" with "PI". 1776 </para> 1777 <code> 1778 <![CDATA[ 1779 <replacestring from="3.14" to="PI" /> 1780 ]]> 1781 </code> 1782 </example> 1783 <example> 1784 <para> 1785 Replace all occurrences of "string", "String", etc. with "System.String". 1786 </para> 1787 <code> 1788 <![CDATA[ 1789 <replacestring from="String" to="System.String" ignorecase="true" /> 1790 ]]> 1791 </code> 1792 </example> 1793 </member> 1794 <member name="M:NAnt.Core.Filters.ReplaceString.Chain(NAnt.Core.Filters.ChainableReader)"> 1795 <summary> 1796 Construct that allows this filter to be chained to the one 1797 in the parameter chainedReader. 1798 </summary> 1799 <param name="chainedReader">Filter that the filter will be chained to</param> 1800 </member> 1801 <member name="M:NAnt.Core.Filters.ReplaceString.Read"> 1802 <summary> 1803 Reads the next character applying the filter logic. 1804 </summary> 1805 <returns>Char as an int or -1 if at the end of the stream</returns> 1806 </member> 1807 <member name="M:NAnt.Core.Filters.ReplaceString.Peek"> 1808 <summary> 1809 Reads the next character applying the filter logic without 1810 advancing the current position in the stream. 1811 Peek currently is not supported. 1812 </summary> 1813 <returns> 1814 Char as an int or -1 if at the end of the stream. 1815 </returns> 1816 </member> 1817 <member name="M:NAnt.Core.Filters.ReplaceString.FindString(System.Int32,System.Boolean@,System.String@)"> 1818 <summary> 1819 <para> 1820 Helper function used to search for the filter's traget string. If the string 1821 is found the result is true. If the string was not found false is returned and 1822 nonMatchingChars contains the characters that were read to determine if the 1823 string is present. 1824 </para> 1825 1826 <para> 1827 It is assumed the stream is positioned at the character after the first character 1828 in the target string. 1829 </para> 1830 </summary> 1831 <param name="startChar">First character in target string</param> 1832 <param name="streamEnded">Ture if the stream ended while search for the string.</param> 1833 <param name="nonMatchingChars">Characters that were read while searching for the string.</param> 1834 <returns></returns> 1835 </member> 1836 <member name="M:NAnt.Core.Filters.ReplaceString.GetNextCharacter(NAnt.Core.Filters.ReplaceString.AcquireCharDelegate)"> 1837 <summary> 1838 Returns the next character in the stream replacing the specified character. Using the 1839 <see cref="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate"/> allows for the same implementation for Read and Peek 1840 </summary> 1841 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param> 1842 <returns>Char as an int or -1 if at the end of the stream</returns> 1843 </member> 1844 <member name="M:NAnt.Core.Filters.ReplaceString.CompareCharacters(System.Int32,System.Int32)"> 1845 <summary> 1846 Compares to characters taking into account the _ignoreCase flag. 1847 </summary> 1848 <param name="char1"></param> 1849 <param name="char2"></param> 1850 <returns></returns> 1851 </member> 1852 <member name="P:NAnt.Core.Filters.ReplaceString.From"> 1853 <summary> 1854 The string to be replaced. 1855 </summary> 1856 </member> 1857 <member name="P:NAnt.Core.Filters.ReplaceString.To"> 1858 <summary> 1859 The new value for the replaced string. 1860 Am empty string is permissible. 1861 </summary> 1862 </member> 1863 <member name="P:NAnt.Core.Filters.ReplaceString.IgnoreCase"> 1864 <summary> 1865 Determines if case will be ignored. 1866 The default is <see langword="false" />. 1867 </summary> 1868 </member> 1869 <member name="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate"> 1870 <summary> 1871 Delegate for Read and Peek. Allows the same implementation 1872 to be used for both methods. 1873 </summary> 1874 </member> 1875 <member name="T:NAnt.Core.Filters.ReplaceTokens"> 1876 <summary> 1877 Replaces tokens in the original input with user-supplied values. 1878 </summary> 1879 <remarks> 1880 <para> 1881 This filter replaces all token surrounded by a beginning and ending 1882 token. The default beginning and ending tokens both default to '@'. The 1883 optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.BeginToken"/> and <see cref="P:NAnt.Core.Filters.ReplaceTokens.EndToken"/> attributes 1884 can be specified to change either token. By default string 1885 comparisons are case sensitive but this can be changed by setting the 1886 optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> attribute to <see langword="true"/>. 1887 </para> 1888 <para> 1889 Tokens are specified by using the <see cref="T:NAnt.Core.Types.Token"/> element. It is 1890 possible to specify from 1 to n tokens and replacement values. Values can 1891 be any valid NAnt expression. 1892 </para> 1893 <para> 1894 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>. 1895 </para> 1896 </remarks> 1897 <example> 1898 <para> 1899 Replace all occurrences of the string @DATE@ with the value of property 1900 "TODAY". 1901 </para> 1902 <code> 1903 <![CDATA[ 1904 <replacetokens> 1905 <token key="DATE" value="${TODAY}" /> 1906 </replacetokens> 1907 ]]> 1908 </code> 1909 </example> 1910 <example> 1911 <para> 1912 Replace all occurrences of the string <DATE> with the value of 1913 property "TODAY". 1914 </para> 1915 <code> 1916 <![CDATA[ 1917 <replacetokens begintoken="<" endtoken=">"> 1918 <token key="DATE" value="${TODAY}" /> 1919 </replacetokens> 1920 ]]> 1921 </code> 1922 </example> 1923 </member> 1924 <member name="M:NAnt.Core.Filters.ReplaceTokens.Chain(NAnt.Core.Filters.ChainableReader)"> 1925 <summary> 1926 Construct that allows this filter to be chained to the one 1927 in the parameter chainedReader. 1928 </summary> 1929 <param name="chainedReader">Filter that the filter will be chained to</param> 1930 </member> 1931 <member name="M:NAnt.Core.Filters.ReplaceTokens.Read"> 1932 <summary> 1933 Reads the next character applying the filter logic. 1934 </summary> 1935 <returns>Char as an int or -1 if at the end of the stream</returns> 1936 </member> 1937 <member name="M:NAnt.Core.Filters.ReplaceTokens.Peek"> 1938 <summary> 1939 Reads the next character applying the filter logic without 1940 advancing the current position in the stream. 1941 Peek currently is not supported. 1942 </summary> 1943 <returns> 1944 Char as an int or -1 if at the end of the stream. 1945 </returns> 1946 </member> 1947 <member name="M:NAnt.Core.Filters.ReplaceTokens.Initialize"> 1948 <summary> 1949 Initialize the filter by setting its parameters. 1950 </summary> 1951 </member> 1952 <member name="M:NAnt.Core.Filters.ReplaceTokens.FindTokenContents(System.Boolean@,System.Boolean@,System.Boolean@)"> 1953 <summary> 1954 Finds a token give that we are positioned at a beginning token character. Either a 1955 token replacement is returned or the characters that were read looking for the token. 1956 </summary> 1957 <param name="tokenNotFound">A token was not found</param> 1958 <param name="unknownToken">A token was found by there is no replacement</param> 1959 <param name="streamEnded">The stream ended while looking for the token</param> 1960 <returns>Either the replacement token or the characters that were read looking for the token</returns> 1961 </member> 1962 <member name="M:NAnt.Core.Filters.ReplaceTokens.GetNextCharacter(NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate)"> 1963 <summary> 1964 Returns the next character in the stream replacing the specified character. Using the 1965 <see cref="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate"/> allows for the same implementation for Read and Peek 1966 </summary> 1967 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param> 1968 <returns>Char as an int or -1 if at the end of the stream</returns> 1969 </member> 1970 <member name="M:NAnt.Core.Filters.ReplaceTokens.CompareCharacters(System.Int32,System.Int32)"> 1971 <summary> 1972 Compares to characters taking <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> into account. 1973 </summary> 1974 <param name="char1"></param> 1975 <param name="char2"></param> 1976 <returns> 1977 </returns> 1978 </member> 1979 <member name="P:NAnt.Core.Filters.ReplaceTokens.BeginToken"> 1980 <summary> 1981 Marks the beginning of a token. The default is "@". 1982 </summary> 1983 </member> 1984 <member name="P:NAnt.Core.Filters.ReplaceTokens.EndToken"> 1985 <summary> 1986 Marks the end of a token. The default is "@". 1987 </summary> 1988 </member> 1989 <member name="P:NAnt.Core.Filters.ReplaceTokens.Tokens"> 1990 <summary> 1991 Tokens and replacement values. 1992 </summary> 1993 </member> 1994 <member name="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"> 1995 <summary> 1996 Determines if case will be ignored. 1997 The default is <see langword="false" />. 1998 </summary> 1999 </member> 2000 <member name="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate"> 2001 <summary> 2002 Delegate for Read and Peek. Allows the same implementation 2003 to be used for both methods. 2004 </summary> 2005 </member> 2006 <member name="T:NAnt.Core.Filters.TabsToSpaces"> 2007 <summary> 2008 Converts tabs to spaces. 2009 </summary> 2010 <remarks> 2011 <para> 2012 The <see cref="T:NAnt.Core.Filters.TabsToSpaces"/> filter replaces tabs in a text file 2013 with spaces. 2014 </para> 2015 <para> 2016 Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>. 2017 </para> 2018 </remarks> 2019 <example> 2020 <para>Replace all tabs with four spaces.</para> 2021 <code> 2022 <![CDATA[ 2023 <tabtospaces tablength="4" /> 2024 ]]> 2025 </code> 2026 </example> 2027 </member> 2028 <member name="M:NAnt.Core.Filters.TabsToSpaces.Chain(NAnt.Core.Filters.ChainableReader)"> 2029 <summary> 2030 Construct that allows this filter to be chained to the one 2031 in the parameter chainedReader. 2032 </summary> 2033 <param name="chainedReader">Filter that the filter will be chained to</param> 2034 </member> 2035 <member name="M:NAnt.Core.Filters.TabsToSpaces.Peek"> 2036 <summary> 2037 <para>Retrieves the next character with moving the position in the stream.</para> 2038 <note>This method is not implemented</note> 2039 </summary> 2040 <returns>-1 if end of stream otherwise a character</returns> 2041 </member> 2042 <member name="M:NAnt.Core.Filters.TabsToSpaces.Read"> 2043 <summary> 2044 <para>Retrieves the next character in the stream.</para> 2045 </summary> 2046 <returns>-1 if end of stream otherwise a character</returns> 2047 </member> 2048 <member name="M:NAnt.Core.Filters.TabsToSpaces.GetNextCharacter(NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate)"> 2049 <summary> 2050 Returns the next character in the stream replacing the specified character. Using the 2051 <see cref="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate"/> allows for the same implementation for Read and Peek 2052 </summary> 2053 <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param> 2054 <returns>Char as an int or -1 if at the end of the stream</returns> 2055 </member> 2056 <member name="P:NAnt.Core.Filters.TabsToSpaces.TabLength"> 2057 <summary> 2058 The number of spaces used when converting a tab. The default is 2059 "8". 2060 </summary> 2061 </member> 2062 <member name="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate"> 2063 <summary> 2064 Delegate for Read and Peek. Allows the same implementation 2065 to be used for both methods. 2066 </summary> 2067 </member> 2068 <member name="T:NAnt.Core.Functions.AssemblyFunctions"> 2069 <summary> 2070 Functions to return information for a given assembly. 2071 </summary> 2072 </member> 2073 <member name="P:NAnt.Core.FunctionSetBase.Project"> 2074 <summary> 2075 Gets or sets the <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will 2076 reference. 2077 </summary> 2078 <value> 2079 The <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will reference. 2080 </value> 2081 </member> 2082 <member name="M:NAnt.Core.Functions.AssemblyFunctions.LoadFromFile(System.String)"> 2083 <summary> 2084 Loads an assembly given its file name or path. 2085 </summary> 2086 <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param> 2087 <returns> 2088 The loaded assembly. 2089 </returns> 2090 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception> 2091 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> is not found, or the module you are trying to load does not specify a filename extension.</exception> 2092 <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception> 2093 <exception cref="T:System.IO.PathTooLongException">An assembly or module was loaded twice with two different evidences, or the assembly name is longer than MAX_PATH characters.</exception> 2094 </member> 2095 <member name="M:NAnt.Core.Functions.AssemblyFunctions.Load(System.String)"> 2096 <summary> 2097 Loads an assembly given the long form of its name. 2098 </summary> 2099 <param name="assemblyString">The long form of the assembly name.</param> 2100 <returns> 2101 The loaded assembly. 2102 </returns> 2103 <exception cref="T:System.ArgumentNullException"><paramref name="assemblyString"/> is a <see langword="null"/>.</exception> 2104 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyString"/> is not found.</exception> 2105 <example> 2106 <para> 2107 Determine the location of the Microsoft Access 11 Primary Interop 2108 Assembly by loading it using its fully qualified name, and copy it 2109 to the build directory. 2110 </para> 2111 <code> 2112 <![CDATA[ 2113 <property name="access.pia.path" value="${assembly::get-location(assembly::load('Microsoft.Office.Interop.Access, Version=11.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c'))}" /> 2114 <copy file="${access.pia.path}" todir="${build.dir}" /> 2115 ]]> 2116 </code> 2117 </example> 2118 </member> 2119 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetFullName(System.Reflection.Assembly)"> 2120 <summary> 2121 Gets the full name of the assembly, also known as the display name. 2122 </summary> 2123 <param name="assembly">The assembly to get the full name for.</param> 2124 <returns> 2125 The full name of the assembly, also known as the display name. 2126 </returns> 2127 </member> 2128 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"> 2129 <summary> 2130 Gets an <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly. 2131 </summary> 2132 <param name="assembly">The assembly to get an <see cref="T:System.Reflection.AssemblyName"/> for.</param> 2133 <returns> 2134 An <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly. 2135 </returns> 2136 <seealso cref="T:NAnt.Core.Functions.AssemblyNameFunctions"/> 2137 </member> 2138 <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetLocation(System.Reflection.Assembly)"> 2139 <summary> 2140 Gets the physical location, in codebase format, of the loaded file 2141 that contains the manifest. 2142 </summary> 2143 <param name="assembly">The assembly to get the location for.</param> 2144 <returns> 2145 The location of the specified assembly. 2146 </returns> 2147 </member> 2148 <member name="T:NAnt.Core.Functions.AssemblyNameFunctions"> 2149 <summary> 2150 Functions that return information about an assembly's identity. 2151 </summary> 2152 </member> 2153 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetCodeBase(System.Reflection.AssemblyName)"> 2154 <summary> 2155 Gets the location of the assembly as a URL. 2156 </summary> 2157 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param> 2158 <returns> 2159 The location of the assembly as a URL. 2160 </returns> 2161 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/> 2162 </member> 2163 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetEscapedCodeBase(System.Reflection.AssemblyName)"> 2164 <summary> 2165 Gets the URI, including escape characters, that represents the codebase. 2166 </summary> 2167 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param> 2168 <returns> 2169 The URI, including escape characters, that represents the codebase. 2170 </returns> 2171 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/> 2172 </member> 2173 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetFullName(System.Reflection.AssemblyName)"> 2174 <summary> 2175 Gets the full name of the assembly, also known as the display name. 2176 </summary> 2177 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param> 2178 <returns> 2179 The full name of the assembly, also known as the display name. 2180 </returns> 2181 <example> 2182 <para> 2183 Output the full name of the <c>nunit.framework</c> assembly to the 2184 build log. 2185 </para> 2186 <code> 2187 <![CDATA[ 2188 <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" /> 2189 ]]> 2190 </code> 2191 </example> 2192 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/> 2193 </member> 2194 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetName(System.Reflection.AssemblyName)"> 2195 <summary> 2196 Gets the simple, unencrypted name of the assembly. 2197 </summary> 2198 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param> 2199 <returns> 2200 The simple, unencrypted name of the assembly. 2201 </returns> 2202 <example> 2203 <para> 2204 Output the simple name of the <c>nunit.framework</c> assembly to 2205 the build log. 2206 </para> 2207 <code> 2208 <![CDATA[ 2209 <echo message="${assemblyname::get-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" /> 2210 ]]> 2211 </code> 2212 </example> 2213 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/> 2214 </member> 2215 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"> 2216 <summary> 2217 Gets the version of the assembly. 2218 </summary> 2219 <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param> 2220 <returns> 2221 The version of the assembly. 2222 </returns> 2223 <example> 2224 <para> 2225 Output the major version of the <c>nunit.framework</c> assembly 2226 to the build log. 2227 </para> 2228 <code> 2229 <![CDATA[ 2230 <echo message="${version::get-major-version(assemblyname::get-version(assemblyname::get-assembly-name('nunit.framework.dll')))}" /> 2231 ]]> 2232 </code> 2233 </example> 2234 <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/> 2235 <seealso cref="T:NAnt.Core.Functions.VersionFunctions"/> 2236 </member> 2237 <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetAssemblyName(System.String)"> 2238 <summary> 2239 Gets the <see cref="T:System.Reflection.AssemblyName"/> for a given file. 2240 </summary> 2241 <param name="assemblyFile">The assembly file for which to get the <see cref="T:System.Reflection.AssemblyName"/>.</param> 2242 <returns> 2243 An <see cref="T:System.Reflection.AssemblyName"/> object representing the given file. 2244 </returns> 2245 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception> 2246 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> does not exist.</exception> 2247 <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception> 2248 <remarks> 2249 The assembly is not added to this domain. 2250 </remarks> 2251 <example> 2252 <para> 2253 Output the full name of the <c>nunit.framework</c> assembly to the 2254 build log. 2255 </para> 2256 <code> 2257 <![CDATA[ 2258 <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" /> 2259 ]]> 2260 </code> 2261 </example> 2262 </member> 2263 <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.Parse(System.String)"> 2264 <summary> 2265 Converts the specified string representation of a logical value to 2266 its <see cref="T:System.Boolean"/> equivalent. 2267 </summary> 2268 <param name="s">A string containing the value to convert.</param> 2269 <returns> 2270 <see langword="true"/> if <paramref name="s"/> is equivalent to 2271 "True"; otherwise, <see langword="false"/>. 2272 </returns> 2273 <exception cref="T:System.FormatException"><paramref name="s"/> is not equivalent to <see cref="F:System.Boolean.TrueString"/> or <see cref="F:System.Boolean.FalseString"/>.</exception> 2274 </member> 2275 <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.ToString(System.Boolean)"> 2276 <summary> 2277 Converts the specified <see cref="T:System.Boolean"/> to its equivalent string 2278 representation. 2279 </summary> 2280 <param name="value">A <see cref="T:System.Boolean"/> to convert.</param> 2281 <returns> 2282 "True" if <paramref name="value"/> is <see langword="true"/>, or 2283 "False" if <paramref name="value"/> is <see langword="false"/>. 2284 </returns> 2285 </member> 2286 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToInt(System.Int32)"> 2287 <summary> 2288 Converts the argument to an integer. 2289 </summary> 2290 <param name="value">value to be converted</param> 2291 <returns><paramref name="value" /> converted to integer. The function fails with an exception when the conversion is not possible.</returns> 2292 </member> 2293 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDouble(System.Double)"> 2294 <summary> 2295 Converts the argument to double 2296 </summary> 2297 <param name="value">The value to be converted.</param> 2298 <returns><paramref name="value" /> converted to double. The function fails with an exception when the conversion is not possible.</returns> 2299 </member> 2300 <member name="M:NAnt.Core.Functions.ConversionFunctions.ConvertToString(System.String)"> 2301 <summary> 2302 Converts the argument to a string. 2303 </summary> 2304 <param name="value">The value to be converted.</param> 2305 <returns> 2306 <paramref name="value" /> converted to string. The function fails 2307 with an exception when the conversion is not possible. 2308 </returns> 2309 <remarks> 2310 Named method ConvertToString as a static ToString method would break 2311 CLS compliance. 2312 </remarks> 2313 </member> 2314 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDateTime(System.DateTime)"> 2315 <summary> 2316 Converts the argument to a datetime. 2317 </summary> 2318 <param name="value">value to be converted</param> 2319 <returns><paramref name="value" /> converted to datetime. The function fails with an exception when the conversion is not possible.</returns> 2320 </member> 2321 <member name="M:NAnt.Core.Functions.ConversionFunctions.ToBoolean(System.Boolean)"> 2322 <summary> 2323 Converts the argument to a boolean 2324 </summary> 2325 <param name="value">The string value to be converted to boolean. Must be 'true' or 'false'.</param> 2326 <returns> 2327 <paramref name="value" /> converted to boolean. The function fails 2328 with an exception when the conversion is not possible. 2329 </returns> 2330 </member> 2331 <member name="M:NAnt.Core.Functions.DateTimeFunctions.Now"> 2332 <summary> 2333 Gets a <see cref="T:System.DateTime"/> that is the current local date and 2334 time on this computer. 2335 </summary> 2336 <returns> 2337 A <see cref="T:System.DateTime"/> whose value is the current date and time. 2338 </returns> 2339 </member> 2340 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetYear(System.DateTime)"> 2341 <summary> 2342 Gets the year component of the specified date. 2343 </summary> 2344 <param name="date">The date of which to get the year component.</param> 2345 <returns> 2346 The year, between 1 and 9999. 2347 </returns> 2348 </member> 2349 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMonth(System.DateTime)"> 2350 <summary> 2351 Gets the month component of the specified date. 2352 </summary> 2353 <param name="date">The date of which to get the month component.</param> 2354 <returns> 2355 The month, between 1 and 12. 2356 </returns> 2357 </member> 2358 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDay(System.DateTime)"> 2359 <summary> 2360 Gets the day of the month represented by the specified date. 2361 </summary> 2362 <param name="date">The date of which to get the day of the month.</param> 2363 <returns> 2364 The day value, between 1 and 31. 2365 </returns> 2366 </member> 2367 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetHour(System.DateTime)"> 2368 <summary> 2369 Gets the hour component of the specified date. 2370 </summary> 2371 <param name="date">The date of which to get the hour component.</param> 2372 <returns> 2373 The hour, between 0 and 23. 2374 </returns> 2375 </member> 2376 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMinute(System.DateTime)"> 2377 <summary> 2378 Gets the minute component of the specified date. 2379 </summary> 2380 <param name="date">The date of which to get the minute component.</param> 2381 <returns> 2382 The minute, between 0 and 59. 2383 </returns> 2384 </member> 2385 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetSecond(System.DateTime)"> 2386 <summary> 2387 Gets the seconds component of the specified date. 2388 </summary> 2389 <param name="date">The date of which to get the seconds component.</param> 2390 <returns> 2391 The seconds, between 0 and 59. 2392 </returns> 2393 </member> 2394 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMillisecond(System.DateTime)"> 2395 <summary> 2396 Gets the milliseconds component of the specified date. 2397 </summary> 2398 <param name="date">The date of which to get the milliseconds component.</param> 2399 <returns> 2400 The millisecond, between 0 and 999. 2401 </returns> 2402 </member> 2403 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetTicks(System.DateTime)"> 2404 <summary> 2405 Gets the number of ticks that represent the specified date. 2406 </summary> 2407 <param name="date">The date of which to get the number of ticks.</param> 2408 <returns> 2409 The number of ticks that represent the date and time of the 2410 specified date. 2411 </returns> 2412 </member> 2413 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfWeek(System.DateTime)"> 2414 <summary> 2415 Gets the day of the week represented by the specified date. 2416 </summary> 2417 <param name="date">The date of which to get the day of the week.</param> 2418 <returns> 2419 The day of the week, ranging from zero, indicating Sunday, to six, 2420 indicating Saturday. 2421 </returns> 2422 </member> 2423 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfYear(System.DateTime)"> 2424 <summary> 2425 Gets the day of the year represented by the specified date. 2426 </summary> 2427 <param name="date">The date of which to get the day of the year.</param> 2428 <returns> 2429 The day of the year, between 1 and 366. 2430 </returns> 2431 </member> 2432 <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDaysInMonth(System.Int32,System.Int32)"> 2433 <summary> 2434 Returns the number of days in the specified month of the specified 2435 year. 2436 </summary> 2437 <param name="year">The year.</param> 2438 <param name="month">The month (a number ranging from 1 to 12).</param> 2439 <returns> 2440 The number of days in <paramref name="month"/> for the specified 2441 <paramref name="year"/>. 2442 </returns> 2443 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="month"/> is less than 1 or greater than 12.</exception> 2444 </member> 2445 <member name="M:NAnt.Core.Functions.DateTimeFunctions.IsLeapYear(System.Int32)"> 2446 <summary> 2447 Returns an indication whether the specified year is a leap year. 2448 </summary> 2449 <param name="year">A 4-digit year.</param> 2450 <returns> 2451 <see langword="true" /> if <paramref name="year" /> is a leap year; 2452 otherwise, <see langword="false" />. 2453 </returns> 2454 </member> 2455 <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.Parse(System.String)"> 2456 <summary> 2457 Converts the specified string representation of a date and time to 2458 its <see cref="T:System.DateTime"/> equivalent. 2459 </summary> 2460 <param name="s">A string containing a date and time to convert.</param> 2461 <returns> 2462 A <see cref="T:System.DateTime"/> equivalent to the date and time contained 2463 in <paramref name="s"/>. 2464 </returns> 2465 <exception cref="T:System.FormatException"><paramref name="s"/> does not contain a valid string representation of a date and time.</exception> 2466 <remarks> 2467 The <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture is 2468 used to supply formatting information about <paramref name="s"/>. 2469 </remarks> 2470 </member> 2471 <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.ToString(System.DateTime)"> 2472 <summary> 2473 Converts the specified <see cref="T:System.DateTime"/> to its equivalent 2474 string representation. 2475 </summary> 2476 <param name="value">A <see cref="T:System.DateTime"/> to convert.</param> 2477 <returns> 2478 A string representation of <paramref name="value"/> formatted using 2479 the general format specifier ("G"). 2480 </returns> 2481 <remarks> 2482 <paramref name="value"/> is formatted with the 2483 <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture. 2484 </remarks> 2485 </member> 2486 <member name="T:NAnt.Core.Functions.DirectoryFunctions"> 2487 <summary> 2488 Groups a set of functions for dealing with directories. 2489 </summary> 2490 </member> 2491 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCreationTime(System.String)"> 2492 <summary> 2493 Returns the creation date and time of the specified directory. 2494 </summary> 2495 <param name="path">The directory for which to obtain creation date and time information.</param> 2496 <returns> 2497 The creation date and time of the specified directory. 2498 </returns> 2499 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception> 2500 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2501 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 2502 </member> 2503 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastWriteTime(System.String)"> 2504 <summary> 2505 Returns the date and time the specified directory was last written to. 2506 </summary> 2507 <param name="path">The directory for which to obtain write date and time information.</param> 2508 <returns> 2509 The date and time the specified directory was last written to. 2510 </returns> 2511 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception> 2512 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2513 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 2514 </member> 2515 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastAccessTime(System.String)"> 2516 <summary> 2517 Returns the date and time the specified directory was last accessed. 2518 </summary> 2519 <param name="path">The directory for which to obtain access date and time information.</param> 2520 <returns> 2521 The date and time the specified directory was last accessed. 2522 </returns> 2523 <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception> 2524 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2525 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 2526 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception> 2527 </member> 2528 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCurrentDirectory"> 2529 <summary> 2530 Gets the current working directory. 2531 </summary> 2532 <returns> 2533 A <see cref="T:System.String"/> containing the path of the current working 2534 directory. 2535 </returns> 2536 </member> 2537 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetParentDirectory(System.String)"> 2538 <summary> 2539 Retrieves the parent directory of the specified path. 2540 </summary> 2541 <param name="path">The path for which to retrieve the parent directory.</param> 2542 <returns> 2543 The parent directory, or an empty <see cref="T:System.String"/> if 2544 <paramref name="path"/> is the root directory, including the root 2545 of a UNC server or share name. 2546 </returns> 2547 <exception cref="T:System.IO.IOException">The directory specified by <paramref name="path"/> is read-only.</exception> 2548 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2549 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 2550 <exception cref="T:System.IO.DirectoryNotFoundException">The specified path was not found.</exception> 2551 <example> 2552 <para> 2553 Copy "readme.txt" from the current working directory to 2554 its parent directory. 2555 </para> 2556 <code> 2557 <![CDATA[ 2558 <property name="current.dir" value="${directory::get-current-directory()}" /> 2559 <property name="current.dir.parent" value="${directory::get-parent-directory(current.dir)}" /> 2560 <copy file="${path::combine(current.dir, 'readme.txt')} todir="${current.dir.parent}" /> 2561 ]]> 2562 </code> 2563 </example> 2564 </member> 2565 <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetDirectoryRoot(System.String)"> 2566 <summary> 2567 Returns the volume information, root information, or both for the 2568 specified path. 2569 </summary> 2570 <param name="path">The path for which to retrieve the parent directory.</param> 2571 <returns> 2572 A string containing the volume information, root information, or 2573 both for the specified path. 2574 </returns> 2575 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2576 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 2577 </member> 2578 <member name="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)"> 2579 <summary> 2580 Determines whether the given path refers to an existing directory 2581 on disk. 2582 </summary> 2583 <param name="path">The path to test.</param> 2584 <returns> 2585 <see langword="true" /> if <paramref name="path" /> refers to an 2586 existing directory; otherwise, <see langword="false" />. 2587 </returns> 2588 <example> 2589 <para>Remove directory "test", if it exists.</para> 2590 <code> 2591 <![CDATA[ 2592 <delete dir="test" if="${directory::exists('test')}" /> 2593 ]]> 2594 </code> 2595 </example> 2596 </member> 2597 <member name="T:NAnt.Core.Functions.DnsFunctions"> 2598 <summary> 2599 Functions for requesting information from DNS. 2600 </summary> 2601 </member> 2602 <member name="M:NAnt.Core.Functions.DnsFunctions.GetHostName"> 2603 <summary> 2604 Gets the host name of the local computer. 2605 </summary> 2606 <returns> 2607 A string that contains the DNS host name of the local computer. 2608 </returns> 2609 <exception cref="T:System.Net.Sockets.SocketException">An error is encountered when resolving the local host name.</exception> 2610 </member> 2611 <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.Parse(System.String)"> 2612 <summary> 2613 Converts the specified string representation of a number to its 2614 double-precision floating point number equivalent. 2615 </summary> 2616 <param name="s">A string containing a number to convert.</param> 2617 <returns> 2618 A double-precision floating point number equivalent to the numeric 2619 value or symbol specified in <paramref name="s"/>. 2620 </returns> 2621 <exception cref="T:System.FormatException"><paramref name="s"/> is not a number in a valid format.</exception> 2622 <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Double.MinValue"/> or greater than <see cref="F:System.Double.MaxValue"/>.</exception> 2623 <remarks> 2624 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is 2625 used to supply formatting information about <paramref name="s"/>. 2626 </remarks> 2627 </member> 2628 <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.ToString(System.Double)"> 2629 <summary> 2630 Converts the specified <see cref="T:System.Double"/> to its equivalent 2631 string representation. 2632 </summary> 2633 <param name="value">A <see cref="T:System.Double"/> to convert.</param> 2634 <returns> 2635 The string representation of <paramref name="value"/> formatted 2636 using the general format specifier ("G"). 2637 </returns> 2638 <remarks> 2639 <paramref name="value"/> is formatted with the 2640 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture. 2641 </remarks> 2642 </member> 2643 <member name="T:NAnt.Core.Functions.EnvironmentFunctions"> 2644 <summary> 2645 Provide information about the current environment and platform. 2646 </summary> 2647 </member> 2648 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)"> 2649 <summary> 2650 Gets the path to the system special folder identified by the 2651 specified enumeration. 2652 </summary> 2653 <param name="folder">An enumerated constant that identifies a system special folder.</param> 2654 <returns> 2655 The path to the specified system special folder, if that folder 2656 physically exists on your computer; otherwise, the empty string (""). 2657 </returns> 2658 <exception cref="T:System.ArgumentException"><paramref name="folder"/> is not a member of <see cref="T:System.Environment.SpecialFolder"/>.</exception> 2659 <example> 2660 <para> 2661 Copy "out.log" from the project base directory to the 2662 program files directory. 2663 </para> 2664 <code> 2665 <![CDATA[ 2666 <copy file="out.log" todir="${environment::get-folder-path('ProgramFiles')}" /> 2667 ]]> 2668 </code> 2669 </example> 2670 </member> 2671 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetMachineName"> 2672 <summary> 2673 Gets the NetBIOS name of this local computer. 2674 </summary> 2675 <returns> 2676 The NetBIOS name of this local computer. 2677 </returns> 2678 <exception cref="T:System.InvalidOperationException">The name of this computer cannot be obtained.</exception> 2679 </member> 2680 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"> 2681 <summary> 2682 Gets an <see cref="T:System.OperatingSystem"/> object that represents the 2683 current operating system. 2684 </summary> 2685 <returns> 2686 An <see cref="T:System.OperatingSystem"/> object that contains the current 2687 platform identifier and version number. 2688 </returns> 2689 <example> 2690 <para> 2691 Output string representation of the current operating system. 2692 </para> 2693 <code> 2694 <![CDATA[ 2695 <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" /> 2696 ]]> 2697 </code> 2698 <para>If the operating system is Windows 2000, the output is:</para> 2699 <code> 2700 Microsoft Windows NT 5.0.2195.0 2701 </code> 2702 </example> 2703 <seealso cref="T:NAnt.Core.Functions.OperatingSystemFunctions"/> 2704 </member> 2705 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetUserName"> 2706 <summary> 2707 Gets the user name of the person who started the current thread. 2708 </summary> 2709 <returns> 2710 The name of the person logged on to the system who started the 2711 current thread. 2712 </returns> 2713 <example> 2714 <para> 2715 Modify the home directory of the current user on unix-based systems. 2716 </para> 2717 <code> 2718 <![CDATA[ 2719 <exec program="usermod"> 2720 <arg value="-d" /> 2721 <arg value="/home/temp" /> 2722 <arg value="${environment::get-user-name()}" /> 2723 </exec> 2724 ]]> 2725 </code> 2726 </example> 2727 </member> 2728 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)"> 2729 <summary> 2730 Returns the value of the specified environment variable. 2731 </summary> 2732 <param name="name">The environment variable of which the value should be returned.</param> 2733 <returns> 2734 The value of the specified environment variable. 2735 </returns> 2736 <exception cref="T:System.ArgumentException">Environment variable <paramref name="name"/> does not exist.</exception> 2737 </member> 2738 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.VariableExists(System.String)"> 2739 <summary> 2740 Gets a value indicating whether the specified environment variable 2741 exists. 2742 </summary> 2743 <param name="name">The environment variable that should be checked.</param> 2744 <returns> 2745 <see langword="true" /> if the environment variable exists; otherwise, 2746 <see langword="false" />. 2747 </returns> 2748 <example> 2749 <para> 2750 Execute a set of tasks only if the "BUILD_DEBUG" environment 2751 variable is set. 2752 </para> 2753 <code> 2754 <![CDATA[ 2755 <if test="${environment::variable-exists('BUILD_DEBUG')}"> 2756 ... 2757 </if> 2758 ]]> 2759 </code> 2760 </example> 2761 </member> 2762 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"> 2763 <summary> 2764 Gets a <see cref="T:System.Version"/> object that describes the major, 2765 minor, build, and revision numbers of the Common Language Runtime. 2766 </summary> 2767 <returns> 2768 A Version object. 2769 </returns> 2770 <example> 2771 <para>Output the major version of the CLR.</para> 2772 <code> 2773 <![CDATA[ 2774 <echo message="Major version=${version::get-major(environment::get-version())}" /> 2775 ]]> 2776 </code> 2777 </example> 2778 </member> 2779 <member name="M:NAnt.Core.Functions.EnvironmentFunctions.NewLine"> 2780 <summary> 2781 Gets the newline string defined for this environment. 2782 </summary> 2783 <returns> 2784 A string containing CRLF for non-Unix platforms, or LF for Unix 2785 platforms. 2786 </returns> 2787 <example> 2788 <para>Output two lines in a log file.</para> 2789 <code> 2790 <![CDATA[ 2791 <echo file="build.log" message="First line${environment::newline()}Second line" /> 2792 ]]> 2793 </code> 2794 </example> 2795 </member> 2796 <member name="T:NAnt.Core.Functions.FileFunctions"> 2797 <summary> 2798 Groups a set of functions for dealing with files. 2799 </summary> 2800 </member> 2801 <member name="M:NAnt.Core.Functions.FileFunctions.GetCreationTime(System.String)"> 2802 <summary> 2803 Returns the creation date and time of the specified file. 2804 </summary> 2805 <param name="path">The file for which to obtain creation date and time information.</param> 2806 <returns> 2807 The creation date and time of the specified file. 2808 </returns> 2809 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception> 2810 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2811 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 2812 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception> 2813 </member> 2814 <member name="M:NAnt.Core.Functions.FileFunctions.GetLastWriteTime(System.String)"> 2815 <summary> 2816 Returns the date and time the specified file was last written to. 2817 </summary> 2818 <param name="path">The file for which to obtain write date and time information.</param> 2819 <returns> 2820 The date and time the specified file was last written to. 2821 </returns> 2822 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception> 2823 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2824 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 2825 </member> 2826 <member name="M:NAnt.Core.Functions.FileFunctions.GetLastAccessTime(System.String)"> 2827 <summary> 2828 Returns the date and time the specified file was last accessed. 2829 </summary> 2830 <param name="path">The file for which to obtain access date and time information.</param> 2831 <returns> 2832 The date and time the specified file was last accessed. 2833 </returns> 2834 <exception cref="T:System.IO.IOException">The specified file does not exist.</exception> 2835 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2836 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 2837 <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception> 2838 </member> 2839 <member name="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)"> 2840 <summary> 2841 Determines whether the specified file exists. 2842 </summary> 2843 <param name="file">The file to check.</param> 2844 <returns> 2845 <see langword="true" /> if <paramref name="file" /> refers to an 2846 existing file; otherwise, <see langword="false" />. 2847 </returns> 2848 <example> 2849 <para>Execute a set of tasks, if file "output.xml" does not exist.</para> 2850 <code> 2851 <![CDATA[ 2852 <if test="${not file::exists('output.xml')}"> 2853 ... 2854 </if> 2855 ]]> 2856 </code> 2857 </example> 2858 </member> 2859 <member name="M:NAnt.Core.Functions.FileFunctions.UpToDate(System.String,System.String)"> 2860 <summary> 2861 Determines whether <paramref name="targetFile"/> is more or equal 2862 up-to-date than <paramref name="srcFile"/>. 2863 </summary> 2864 <param name="srcFile">The file to check against the target file.</param> 2865 <param name="targetFile">The file for which we want to determine the status.</param> 2866 <returns> 2867 <see langword="true"/> if <paramref name="targetFile"/> is more 2868 or equal up-to-date than <paramref name="srcFile"/>; otherwise, 2869 <see langword="false"/>. 2870 </returns> 2871 <exception cref="T:System.ArgumentException"><paramref name="srcFile"/> or <paramref name="targetFile"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 2872 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both of either <paramref name="srcFile"/> or <paramref name="targetFile"/> exceed the system-defined maximum length.</exception> 2873 </member> 2874 <member name="M:NAnt.Core.Functions.FileFunctions.GetLength(System.String)"> 2875 <summary> 2876 Gets the length of the file. 2877 </summary> 2878 <param name="file">filename</param> 2879 <returns> 2880 Length in bytes, of the file named <paramref name="file"/>. 2881 </returns> 2882 <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception> 2883 </member> 2884 <member name="M:NAnt.Core.Functions.FileFunctions.IsAssembly(System.String)"> 2885 <summary> 2886 Checks if a given file is an assembly. 2887 </summary> 2888 <param name="assemblyFile">The name or path of the file to be checked.</param> 2889 <returns>True if the file is a valid assembly, false if it's not or if the assembly seems corrupted (invalid headers or metadata).</returns> 2890 <exception cref="T:System.ArgumentNullException"><paramref name="assemblyFile"/> is a null <see cref="T:System.String"/>.</exception> 2891 <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception> 2892 <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> is not found, or the file you are trying to check does not specify a filename extension.</exception> 2893 <exception cref="T:System.Security.SecurityException">The caller does not have path discovery permission.</exception> 2894 </member> 2895 <member name="T:NAnt.Core.Functions.FileVersionInfoFunctions"> 2896 <summary> 2897 Functions that provide version information for a physical file on disk. 2898 </summary> 2899 </member> 2900 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetVersionInfo(System.String)"> 2901 <summary> 2902 Returns a <see cref="T:System.Diagnostics.FileVersionInfo"/> representing the version 2903 information associated with the specified file. 2904 </summary> 2905 <param name="fileName">The file to retrieve the version information for.</param> 2906 <returns> 2907 A <see cref="T:System.Diagnostics.FileVersionInfo"/> containing information about the file. 2908 </returns> 2909 <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception> 2910 </member> 2911 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetCompanyName(System.Diagnostics.FileVersionInfo)"> 2912 <summary> 2913 Gets the name of the company that produced the file. 2914 </summary> 2915 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param> 2916 <returns> 2917 The name of the company that produced the file. 2918 </returns> 2919 </member> 2920 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetFileVersion(System.Diagnostics.FileVersionInfo)"> 2921 <summary> 2922 Gets the file version of a file. 2923 </summary> 2924 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param> 2925 <returns> 2926 The file version of a file. 2927 </returns> 2928 <see cref="T:NAnt.Core.Functions.VersionFunctions"/> 2929 </member> 2930 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductName(System.Diagnostics.FileVersionInfo)"> 2931 <summary> 2932 Gets the name of the product the file is distributed with. 2933 </summary> 2934 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param> 2935 <returns> 2936 The name of the product the file is distributed with. 2937 </returns> 2938 </member> 2939 <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductVersion(System.Diagnostics.FileVersionInfo)"> 2940 <summary> 2941 Gets the product version of a file. 2942 </summary> 2943 <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param> 2944 <returns> 2945 The product version of a file. 2946 </returns> 2947 <see cref="T:NAnt.Core.Functions.VersionFunctions"/> 2948 </member> 2949 <member name="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)"> 2950 <summary> 2951 Checks whether the specified framework exists, and is valid. 2952 </summary> 2953 <param name="framework">The framework to test.</param> 2954 <returns> 2955 <see langword="true" /> if the specified framework exists ; otherwise, 2956 <see langword="false" />. 2957 </returns> 2958 </member> 2959 <member name="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)"> 2960 <summary> 2961 Checks whether the SDK for the specified framework is installed. 2962 </summary> 2963 <param name="framework">The framework to test.</param> 2964 <returns> 2965 <see langword="true"/> if the SDK for specified framework is installed; 2966 otherwise, <see langword="false"/>. 2967 </returns> 2968 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 2969 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 2970 </member> 2971 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"> 2972 <summary> 2973 Gets the identifier of the current target framework. 2974 </summary> 2975 <returns> 2976 The identifier of the current target framework. 2977 </returns> 2978 </member> 2979 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"> 2980 <summary> 2981 Gets the identifier of the runtime framework. 2982 </summary> 2983 <returns> 2984 The identifier of the runtime framework. 2985 </returns> 2986 </member> 2987 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFamily(System.String)"> 2988 <summary> 2989 Gets the family of the specified framework. 2990 </summary> 2991 <param name="framework">The framework of which the family should be returned.</param> 2992 <returns> 2993 The family of the specified framework. 2994 </returns> 2995 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 2996 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 2997 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 2998 </member> 2999 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion"> 3000 <summary> 3001 Gets the version of the current target framework. 3002 </summary> 3003 <returns> 3004 The version of the current target framework. 3005 </returns> 3006 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3007 </member> 3008 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion(System.String)"> 3009 <summary> 3010 Gets the version of the specified framework. 3011 </summary> 3012 <param name="framework">The framework of which the version should be returned.</param> 3013 <returns> 3014 The version of the specified framework. 3015 </returns> 3016 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 3017 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 3018 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3019 </member> 3020 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription"> 3021 <summary> 3022 Gets the description of the current target framework. 3023 </summary> 3024 <returns> 3025 The description of the current target framework. 3026 </returns> 3027 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3028 </member> 3029 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription(System.String)"> 3030 <summary> 3031 Gets the description of the specified framework. 3032 </summary> 3033 <param name="framework">The framework of which the description should be returned.</param> 3034 <returns> 3035 The description of the specified framework. 3036 </returns> 3037 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 3038 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 3039 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3040 </member> 3041 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion"> 3042 <summary> 3043 Gets the Common Language Runtime version of the current target 3044 framework. 3045 </summary> 3046 <returns> 3047 The Common Language Runtime version of the current target framework. 3048 </returns> 3049 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3050 </member> 3051 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion(System.String)"> 3052 <summary> 3053 Gets the Common Language Runtime version of the specified framework. 3054 </summary> 3055 <param name="framework">The framework of which the Common Language Runtime version should be returned.</param> 3056 <returns> 3057 The Common Language Runtime version of the specified framework. 3058 </returns> 3059 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 3060 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 3061 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3062 </member> 3063 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworkDirectory(System.String)"> 3064 <summary> 3065 Gets the framework directory of the specified framework. 3066 </summary> 3067 <param name="framework">The framework of which the framework directory should be returned.</param> 3068 <returns> 3069 The framework directory of the specified framework. 3070 </returns> 3071 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 3072 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 3073 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3074 </member> 3075 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetAssemblyDirectory(System.String)"> 3076 <summary> 3077 Gets the assembly directory of the specified framework. 3078 </summary> 3079 <param name="framework">The framework of which the assembly directory should be returned.</param> 3080 <returns> 3081 The assembly directory of the specified framework. 3082 </returns> 3083 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 3084 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 3085 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3086 </member> 3087 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetSdkDirectory(System.String)"> 3088 <summary> 3089 Gets the SDK directory of the specified framework. 3090 </summary> 3091 <param name="framework">The framework of which the SDK directory should be returned.</param> 3092 <returns> 3093 The SDK directory of the specified framework, or an empty 3094 <see cref="T:System.String"/> if the SDK of the specified framework is not 3095 installed. 3096 </returns> 3097 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 3098 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 3099 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3100 </member> 3101 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetToolPath(System.String)"> 3102 <summary> 3103 Gets the absolute path of the specified tool for the current 3104 target framework. 3105 </summary> 3106 <param name="tool">The file name of the tool to search for.</param> 3107 <returns> 3108 The absolute path to <paramref name="tool"/> if found in one of the 3109 configured tool paths; otherwise, an error is reported. 3110 </returns> 3111 <exception cref="T:System.IO.FileNotFoundException"><paramref name="tool"/> could not be found in the configured tool paths.</exception> 3112 <remarks> 3113 <para> 3114 The configured tool paths are scanned in the order in which they 3115 are defined in the framework configuration. 3116 </para> 3117 <para> 3118 The file name of the tool to search should include the extension. 3119 </para> 3120 </remarks> 3121 <example> 3122 <para>Use <b>gacutil</b> to install an assembly in the GAC.</para> 3123 <code> 3124 <![CDATA[ 3125 <exec program="${framework::get-tool-path('gacutil.exe')}" managed="strict"> 3126 <arg value="/i" /> 3127 <arg file="Cegeka.HealthFramework.dll" /> 3128 </exec> 3129 ]]> 3130 </code> 3131 </example> 3132 </member> 3133 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeEngine(System.String)"> 3134 <summary> 3135 Gets the runtime engine of the specified framework. 3136 </summary> 3137 <param name="framework">The framework of which the runtime engine should be returned.</param> 3138 <returns> 3139 The full path to the runtime engine of the specified framework, or 3140 an empty <see cref="T:System.String"/> if no runtime engine is defined 3141 for the specified framework. 3142 </returns> 3143 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 3144 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/> 3145 <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/> 3146 </member> 3147 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworks(NAnt.Core.FrameworkTypes)"> 3148 <summary> 3149 Gets a comma-separated list of frameworks filtered by the specified 3150 <see cref="T:NAnt.Core.FrameworkTypes"/>. 3151 </summary> 3152 <param name="types">A bitwise combination of <see cref="T:NAnt.Core.FrameworkTypes"/> values that filter the frameworks to retrieve.</param> 3153 <returns> 3154 A comma-separated list of frameworks filtered by the specified 3155 <see cref="T:NAnt.Core.FrameworkTypes"/>, sorted on name. 3156 </returns> 3157 <example> 3158 <para> 3159 Define a <b>build-all</b> target that executes the <b>build</b> 3160 target once for each installed framework targeting compact 3161 devices. 3162 </para> 3163 <code> 3164 <![CDATA[ 3165 <target name="build-all"> 3166 <foreach item="String" in="${framework::get-frameworks('installed compact')}" delim="," property="framework"> 3167 <property name="nant.settings.currentframework" value="${framework}" /> 3168 <call target="build" /> 3169 </foreach> 3170 </target> 3171 3172 <target name="build"> 3173 ... 3174 </target> 3175 ]]> 3176 </code> 3177 </example> 3178 </member> 3179 <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFramework(System.String)"> 3180 <summary> 3181 Checks whether the specified framework is valid. 3182 </summary> 3183 <param name="framework">The framework to check.</param> 3184 <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception> 3185 </member> 3186 <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.Parse(System.String)"> 3187 <summary> 3188 Converts the specified string representation of a number to its 3189 32-bit signed integer equivalent. 3190 </summary> 3191 <param name="s">A string containing a number to convert.</param> 3192 <returns> 3193 A 32-bit signed integer equivalent to the number contained in 3194 <paramref name="s"/>. 3195 </returns> 3196 <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception> 3197 <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Int32.MinValue"/> or greater than <see cref="F:System.Int32.MaxValue"/>.</exception> 3198 <remarks> 3199 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is 3200 used to supply formatting information about <paramref name="s"/>. 3201 </remarks> 3202 </member> 3203 <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.ToString(System.Int32)"> 3204 <summary> 3205 Converts the specified <see cref="T:System.Int32"/> to its equivalent string 3206 representation. 3207 </summary> 3208 <param name="value">A <see cref="T:System.Int32"/> to convert.</param> 3209 <returns> 3210 The string representation of <paramref name="value"/>, consisting 3211 of a negative sign if the value is negative, and a sequence of 3212 digits ranging from 0 to 9 with no leading zeroes. 3213 </returns> 3214 <remarks> 3215 <paramref name="value"/> is formatted with the 3216 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture. 3217 </remarks> 3218 </member> 3219 <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.Parse(System.String)"> 3220 <summary> 3221 Converts the specified string representation of a number to its 3222 64-bit signed integer equivalent. 3223 </summary> 3224 <param name="s">A string containing a number to convert.</param> 3225 <returns> 3226 A 64-bit signed integer equivalent to the number contained in 3227 <paramref name="s"/>. 3228 </returns> 3229 <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception> 3230 <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Int64.MinValue"/> or greater than <see cref="F:System.Int64.MaxValue"/>.</exception> 3231 <remarks> 3232 The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is 3233 used to supply formatting information about <paramref name="s"/>. 3234 </remarks> 3235 </member> 3236 <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.ToString(System.Int64)"> 3237 <summary> 3238 Converts the specified <see cref="T:System.Int64"/> to its equivalent string 3239 representation. 3240 </summary> 3241 <param name="value">A <see cref="T:System.Int64"/> to convert.</param> 3242 <returns> 3243 The string representation of <paramref name="value"/>, consisting 3244 of a negative sign if the value is negative, and a sequence of 3245 digits ranging from 0 to 9 with no leading zeroes. 3246 </returns> 3247 <remarks> 3248 <paramref name="value"/> is formatted with the 3249 <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture. 3250 </remarks> 3251 </member> 3252 <member name="M:NAnt.Core.Functions.MathFunctions.Round(System.Double)"> 3253 <summary> 3254 Rounds the value to the nearest whole number 3255 </summary> 3256 <param name="value">Number to be rounded, can be anything convertible to a double.</param> 3257 <returns> 3258 Rounded value. 3259 </returns> 3260 </member> 3261 <member name="M:NAnt.Core.Functions.MathFunctions.Floor(System.Double)"> 3262 <summary> 3263 Returns the largest whole number less than or equal to the specified 3264 number. 3265 </summary> 3266 <param name="value">value to be , can be anything convertible to a double</param> 3267 <returns> 3268 The largest whole number less than or equal to the specified number. 3269 </returns> 3270 </member> 3271 <member name="M:NAnt.Core.Functions.MathFunctions.Ceiling(System.Double)"> 3272 <summary> 3273 Returns the smallest whole number greater than or equal to the specified number 3274 </summary> 3275 <param name="value">value</param> 3276 <returns> 3277 The smallest whole number greater than or equal to the specified number. 3278 </returns> 3279 </member> 3280 <member name="M:NAnt.Core.Functions.MathFunctions.Abs(System.Double)"> 3281 <summary> 3282 Returns the absolute value of the specified number 3283 </summary> 3284 <param name="value">value to take the absolute value from</param> 3285 <returns> 3286 <paramref name="value" /> when <paramref name="value" /> is greater 3287 than or equal to zero; otherwise, -<paramref name="value" />. 3288 </returns> 3289 </member> 3290 <member name="M:NAnt.Core.Functions.NAntFunctions.GetBaseDirectory"> 3291 <summary> 3292 Gets the base directory of the appdomain in which NAnt is running. 3293 </summary> 3294 <returns> 3295 The base directory of the appdomain in which NAnt is running. 3296 </returns> 3297 </member> 3298 <member name="M:NAnt.Core.Functions.NAntFunctions.GetAssembly"> 3299 <summary> 3300 Gets the NAnt assembly. 3301 </summary> 3302 <returns> 3303 The NAnt assembly. 3304 </returns> 3305 </member> 3306 <member name="M:NAnt.Core.Functions.NAntFunctions.ScanProbingPaths(System.String)"> 3307 <summary> 3308 Searches the probing paths of the current target framework for the 3309 specified file. 3310 </summary> 3311 <param name="fileName">The name of the file to search for.</param> 3312 <returns> 3313 The absolute path to <paramref name="fileName"/> if found in one of the 3314 configured probing; otherwise, an error is reported. 3315 </returns> 3316 <exception cref="T:System.IO.FileNotFoundException"><paramref name="fileName"/> could not be found in the configured probing paths.</exception> 3317 <remarks> 3318 <para> 3319 The (relative) probing paths are resolved relative to the base 3320 directory of the appdomain in which NAnt is running. 3321 </para> 3322 <para> 3323 The configured probing paths are scanned recursively in the order 3324 in which they are defined in the framework configuration. 3325 </para> 3326 <para> 3327 The file name to search should include the extension. 3328 </para> 3329 </remarks> 3330 <example> 3331 <para> 3332 Compile an assembly referencing the <c>nunit.framework</c> assembly 3333 for the current target framework that is shipped as part of the 3334 NAnt distribution. 3335 </para> 3336 <code> 3337 <![CDATA[ 3338 <csc target="library" output="NAnt.Core.Tests.dll"> 3339 <sources basedir="NAnt.Core"> 3340 <include name="**/*.cs" /> 3341 </sources> 3342 <references> 3343 <include name="NAnt.Core.dll" /> 3344 <include name="${framework::get-lib-path('nunit.framework.dll')}" /> 3345 </references> 3346 </csc> 3347 ]]> 3348 </code> 3349 </example> 3350 </member> 3351 <member name="M:NAnt.Core.Functions.NAntFunctions.ScanProbingPaths(System.String,System.String)"> 3352 <summary> 3353 Searches the probing paths of the current target framework for the 3354 specified file. 3355 </summary> 3356 <param name="baseDirectory">The directory to use a base directory for the probing paths.</param> 3357 <param name="fileName">The name of the file to search for.</param> 3358 <returns> 3359 The absolute path to <paramref name="fileName"/> if found in one of the 3360 configured probing; otherwise, an error is reported. 3361 </returns> 3362 <exception cref="T:System.IO.FileNotFoundException"><paramref name="fileName"/> could not be found in the configured probing paths.</exception> 3363 <remarks> 3364 <para> 3365 The (relative) probing paths are resolved relative to the specified 3366 base directory. 3367 </para> 3368 <para> 3369 The configured probing paths are scanned recursively in the order 3370 in which they are defined in the framework configuration. 3371 </para> 3372 <para> 3373 The file name to search should include the extension. 3374 </para> 3375 </remarks> 3376 <example> 3377 <para> 3378 Compile an assembly referencing the <c>nunit.framework</c> assembly 3379 for the current target framework that is shipped as part of the 3380 NAnt distribution. 3381 </para> 3382 <code> 3383 <![CDATA[ 3384 <csc target="library" output="NAnt.Core.Tests.dll"> 3385 <sources basedir="NAnt.Core"> 3386 <include name="**/*.cs" /> 3387 </sources> 3388 <references> 3389 <include name="NAnt.Core.dll" /> 3390 <include name="${framework::get-lib-path('nunit.framework.dll')}" /> 3391 </references> 3392 </csc> 3393 ]]> 3394 </code> 3395 </example> 3396 </member> 3397 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetName"> 3398 <summary> 3399 Gets the name of the current project. 3400 </summary> 3401 <returns> 3402 The name of the current project, or an empty <see cref="T:System.String"/> 3403 if no name is specified in the build file. 3404 </returns> 3405 </member> 3406 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFileUri"> 3407 <summary> 3408 Gets the <see cref="T:System.Uri"/> form of the build file. 3409 </summary> 3410 <returns> 3411 The <see cref="T:System.Uri"/> form of the build file, or 3412 an empty <see cref="T:System.String"/> if the project is not file backed. 3413 </returns> 3414 </member> 3415 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFilePath"> 3416 <summary> 3417 Gets the local path to the build file. 3418 </summary> 3419 <returns> 3420 The local path of the build file, or an empty <see cref="T:System.String"/> 3421 if the project is not file backed. 3422 </returns> 3423 </member> 3424 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetDefaultTarget"> 3425 <summary> 3426 Gets the name of the target that will be executed when no other 3427 build targets are specified. 3428 </summary> 3429 <returns> 3430 The name of the target that will be executed when no other build 3431 targets are specified, or an empty <see cref="T:System.String"/> if no 3432 default target is defined for the project. 3433 </returns> 3434 </member> 3435 <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBaseDirectory"> 3436 <summary> 3437 Gets the base directory of the current project. 3438 </summary> 3439 <returns> 3440 The base directory of the current project. 3441 </returns> 3442 </member> 3443 <member name="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)"> 3444 <summary> 3445 Checks whether the specified target exists. 3446 </summary> 3447 <param name="name">The target to test.</param> 3448 <returns> 3449 <see langword="true" /> if the specified target exists; otherwise, 3450 <see langword="false" />. 3451 </returns> 3452 <example> 3453 <para> 3454 Execute target "clean", if it exists. 3455 </para> 3456 <code> 3457 <![CDATA[ 3458 <if test="${target::exists('clean')}"> 3459 <call target="clean" /> 3460 </if> 3461 ]]> 3462 </code> 3463 </example> 3464 </member> 3465 <member name="M:NAnt.Core.Functions.TargetFunctions.GetCurrentTarget"> 3466 <summary> 3467 Gets the name of the target being executed. 3468 </summary> 3469 <returns> 3470 A <see cref="T:System.String"/> that contains the name of the target 3471 being executed. 3472 </returns> 3473 <exception cref="T:System.InvalidOperationException">No target is being executed.</exception> 3474 </member> 3475 <member name="M:NAnt.Core.Functions.TargetFunctions.HasExecuted(System.String)"> 3476 <summary> 3477 Checks whether the specified target has already been executed. 3478 </summary> 3479 <param name="name">The target to test.</param> 3480 <returns> 3481 <see langword="true"/> if the specified target has already been 3482 executed; otherwise, <see langword="false"/>. 3483 </returns> 3484 <exception cref="T:System.ArgumentException">Target <paramref name="name"/> does not exist.</exception> 3485 </member> 3486 <member name="M:NAnt.Core.Functions.TaskFunctions.Exists(System.String)"> 3487 <summary> 3488 Checks whether the specified task exists. 3489 </summary> 3490 <param name="name">The task to test.</param> 3491 <returns> 3492 <see langword="true" /> if the specified task exists; otherwise, 3493 <see langword="false" />. 3494 </returns> 3495 </member> 3496 <member name="M:NAnt.Core.Functions.TaskFunctions.GetAssembly(System.String)"> 3497 <summary> 3498 Returns the <see cref="T:System.Reflection.Assembly"/> from which the specified task 3499 was loaded. 3500 </summary> 3501 <param name="name">The name of the task to get the <see cref="T:System.Reflection.Assembly"/> of.</param> 3502 <returns> 3503 The <see cref="T:System.Reflection.Assembly"/> from which the specified task was loaded. 3504 </returns> 3505 <exception cref="T:System.ArgumentException">Task <paramref name="name"/> is not available.</exception> 3506 </member> 3507 <member name="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)"> 3508 <summary> 3509 Checks whether the specified property exists. 3510 </summary> 3511 <param name="name">The property to test.</param> 3512 <returns> 3513 <see langword="true" /> if the specified property exists; otherwise, 3514 <see langword="false" />. 3515 </returns> 3516 <example> 3517 <para> 3518 Execute a set of tasks if the "build.debug" property 3519 exists. 3520 </para> 3521 <code> 3522 <![CDATA[ 3523 <if test="${property::exists('build.debug')}"> 3524 <echo message="Starting debug build" /> 3525 <call target="init-debug" /> 3526 <call target="build" /> 3527 </if> 3528 ]]> 3529 </code> 3530 </example> 3531 </member> 3532 <member name="M:NAnt.Core.Functions.PropertyFunctions.IsReadOnly(System.String)"> 3533 <summary> 3534 Checks whether the specified property is read-only. 3535 </summary> 3536 <param name="name">The property to test.</param> 3537 <returns> 3538 <see langword="true"/> if the specified property is read-only; 3539 otherwise, <see langword="false"/>. 3540 </returns> 3541 <example> 3542 <para>Check whether the "debug" property is read-only.</para> 3543 <code>property::is-readonly('debug')</code> 3544 </example> 3545 <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception> 3546 </member> 3547 <member name="M:NAnt.Core.Functions.PropertyFunctions.IsDynamic(System.String)"> 3548 <summary> 3549 Checks whether the specified property is a dynamic property. 3550 </summary> 3551 <param name="name">The property to test.</param> 3552 <returns> 3553 <see langword="true"/> if the specified property is a dynamic 3554 property; otherwise, <see langword="false"/>. 3555 </returns> 3556 <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception> 3557 <example> 3558 <para> 3559 Check whether the "debug" property is a dynamic property. 3560 </para> 3561 <code>property::is-dynamic('debug')</code> 3562 </example> 3563 </member> 3564 <member name="M:NAnt.Core.Functions.PlatformFunctions.GetName"> 3565 <summary> 3566 Gets the name of the platform on which NAnt is running. 3567 </summary> 3568 <returns> 3569 The name of the platform on which NAnt is running. 3570 </returns> 3571 </member> 3572 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWin32"> 3573 <summary> 3574 Checks whether NAnt is running on Windows (and not just 32-bit Windows 3575 as the name may lead you to believe). 3576 </summary> 3577 <returns> 3578 <see langword="true" /> if NAnt is running on Windows; 3579 otherwise, <see langword="false" />. 3580 </returns> 3581 </member> 3582 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWindows"> 3583 <summary> 3584 Checks whether NAnt is running on Windows. 3585 </summary> 3586 <returns> 3587 <see langword="true" /> if NAnt is running on Windows; 3588 otherwise, <see langword="false" />. 3589 </returns> 3590 </member> 3591 <member name="M:NAnt.Core.Functions.PlatformFunctions.IsUnix"> 3592 <summary> 3593 Checks whether NAnt is running on Unix. 3594 </summary> 3595 <returns> 3596 <see langword="true" /> if NAnt is running on Unix; 3597 otherwise, <see langword="false" />. 3598 </returns> 3599 </member> 3600 <member name="T:NAnt.Core.Functions.OperatingSystemFunctions"> 3601 <summary> 3602 Functions that return information about an operating system. 3603 </summary> 3604 </member> 3605 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetPlatform(System.OperatingSystem)"> 3606 <summary> 3607 Gets a <see cref="T:System.PlatformID"/> value that identifies the operating 3608 system platform. 3609 </summary> 3610 <param name="operatingSystem">The operating system.</param> 3611 <returns> 3612 <see cref="T:System.PlatformID"/> value that identifies the operating system 3613 platform. 3614 </returns> 3615 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/> 3616 </member> 3617 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"> 3618 <summary> 3619 Gets a <see cref="T:System.Version"/> object that identifies this operating 3620 system. 3621 </summary> 3622 <param name="operatingSystem">The operating system.</param> 3623 <returns> 3624 A <see cref="T:System.Version"/> object that describes the major version, 3625 minor version, build, and revision of the operating system. 3626 </returns> 3627 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/> 3628 </member> 3629 <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.ToString(System.OperatingSystem)"> 3630 <summary> 3631 Converts the value of the specified operating system to its equivalent 3632 <see cref="T:System.String"/> representation. 3633 </summary> 3634 <param name="operatingSystem">The operating system.</param> 3635 <returns> 3636 The <see cref="T:System.String"/> representation of 3637 <paramref name="operatingSystem"/>. 3638 </returns> 3639 <example> 3640 <para> 3641 Output string representation of the current operating system. 3642 </para> 3643 <code> 3644 <![CDATA[ 3645 <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" /> 3646 ]]> 3647 </code> 3648 <para>If the operating system is Windows 2000, the output is:</para> 3649 <code> 3650 Microsoft Windows NT 5.0.2195.0 3651 </code> 3652 </example> 3653 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/> 3654 </member> 3655 <member name="M:NAnt.Core.Functions.PathFunctions.GetFullPath(System.String)"> 3656 <summary> 3657 Returns the fully qualified path. 3658 </summary> 3659 <param name="path">The file or directory for which to obtain absolute path information.</param> 3660 <returns> 3661 A string containing the fully qualified location of <paramref name="path"/>, 3662 such as "C:\MyFile.txt". 3663 </returns> 3664 <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception> 3665 <exception cref="T:System.NotSupportedException"><paramref name="path"/> contains a colon (":").</exception> 3666 <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception> 3667 </member> 3668 <member name="M:NAnt.Core.Functions.PathFunctions.Combine(System.String,System.String)"> 3669 <summary> 3670 Combines two paths. 3671 </summary> 3672 <param name="path1">first path</param> 3673 <param name="path2">second path</param> 3674 <returns> 3675 A string containing the combined paths. If one of the specified paths 3676 is a zero-length string, this method returns the other path. If 3677 <paramref name="path2"/> contains an absolute path, this method 3678 returns <paramref name="path2"/>. 3679 </returns> 3680 <exception cref="T:System.ArgumentException"><paramref name="path1"/> or <paramref name="path2"/> contain one or more invalid characters.</exception> 3681 </member> 3682 <member name="M:NAnt.Core.Functions.PathFunctions.ChangeExtension(System.String,System.String)"> 3683 <summary> 3684 Changes the extension of the path string. 3685 </summary> 3686 <param name="path">The path information to modify. The path cannot contain any of the characters 3687 defined in <see cref="F:System.IO.Path.InvalidPathChars"/>InvalidPathChars.</param> 3688 <param name="extension">The new extension (with a leading period). Specify a null reference 3689 to remove an existing extension from <paramref name="path"/>.</param> 3690 <returns> 3691 <para> 3692 A string containing the modified path information. 3693 </para> 3694 <para> 3695 On Windows-based desktop platforms, if <paramref name="path"/> is 3696 an empty <see cref="T:System.String"/>, the path information is returned 3697 unmodified. If <paramref name="path"/> has no extension, the returned 3698 path <see cref="T:System.String"/> contains <paramref name="extension"/> 3699 appended to the end of <paramref name="path"/>. 3700 </para> 3701 </returns> 3702 <remarks> 3703 For more information see the <see cref="T:System.IO.Path"/> documentation. 3704 </remarks> 3705 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception> 3706 </member> 3707 <member name="M:NAnt.Core.Functions.PathFunctions.GetDirectoryName(System.String)"> 3708 <summary> 3709 Returns the directory information for the specified path string. 3710 </summary> 3711 <param name="path">The path of a file or directory.</param> 3712 <returns> 3713 A <see cref="T:System.String"/> containing directory information for 3714 <paramref name="path"/>, or an empty <see cref="T:System.String"/> if 3715 <paramref name="path"/> denotes a root directory, or does not 3716 contain directory information. 3717 </returns> 3718 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, is empty, or contains only white spaces.</exception> 3719 </member> 3720 <member name="M:NAnt.Core.Functions.PathFunctions.GetExtension(System.String)"> 3721 <summary> 3722 Returns the extension for the specified path string. 3723 </summary> 3724 <param name="path">The path string from which to get the extension.</param> 3725 <returns> 3726 A <see cref="T:System.String"/> containing the extension of the specified 3727 <paramref name="path"/> (including the "."), or an empty 3728 <see cref="T:System.String"/> if <paramref name="path"/> does not have 3729 extension information. 3730 </returns> 3731 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception> 3732 </member> 3733 <member name="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)"> 3734 <summary> 3735 Returns the filename for the specified path string. 3736 </summary> 3737 <param name="path">The path string from which to obtain the file name and extension.</param> 3738 <returns> 3739 <para> 3740 A <see cref="T:System.String"/> consisting of the characters after the last 3741 directory character in path. 3742 </para> 3743 <para> 3744 If the last character of <paramref name="path"/> is a directory or 3745 volume separator character, an empty <see cref="T:System.String"/> is returned. 3746 </para> 3747 </returns> 3748 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception> 3749 </member> 3750 <member name="M:NAnt.Core.Functions.PathFunctions.GetFileNameWithoutExtension(System.String)"> 3751 <summary> 3752 Returns the filename without extension for the specified path string. 3753 </summary> 3754 <param name="path">The path of the file.</param> 3755 <returns> 3756 A <see cref="T:System.String"/> containing the <see cref="T:System.String"/> returned 3757 by <see cref="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)"/>, minus the last period (.) and all 3758 characters following it. 3759 </returns> 3760 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception> 3761 </member> 3762 <member name="M:NAnt.Core.Functions.PathFunctions.GetPathRoot(System.String)"> 3763 <summary> 3764 Gets the root directory of the specified path. 3765 </summary> 3766 <param name="path">The path from which to obtain root directory information.</param> 3767 <returns> 3768 A <see cref="T:System.String"/> containing the root directory of 3769 <paramref name="path"/>, such as "C:\", or an empty <see cref="T:System.String"/> 3770 if <paramref name="path"/> does not contain root directory information. 3771 </returns> 3772 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, or is empty.</exception> 3773 </member> 3774 <member name="M:NAnt.Core.Functions.PathFunctions.GetTempFileName"> 3775 <summary> 3776 Returns a uniquely named zero-byte temporary file on disk and returns the full path to that file. 3777 </summary> 3778 <returns> 3779 A <see cref="T:System.String"/> containing the name of the temporary file. 3780 </returns> 3781 </member> 3782 <member name="M:NAnt.Core.Functions.PathFunctions.GetTempPath"> 3783 <summary> 3784 Gets the path to the temporary directory. 3785 </summary> 3786 <returns> 3787 A <see cref="T:System.String"/> containing the path information of a 3788 temporary directory. 3789 </returns> 3790 </member> 3791 <member name="M:NAnt.Core.Functions.PathFunctions.HasExtension(System.String)"> 3792 <summary> 3793 Determines whether a path string includes an extension. 3794 </summary> 3795 <param name="path">The path to search for an extension.</param> 3796 <returns> 3797 <see langword="true"/>. if the characters that follow the last 3798 directory separator or volume separator in the <paramref name="path"/> 3799 include a period (.) followed by one or more characters; 3800 otherwise, <see langword="false"/>. 3801 </returns> 3802 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception> 3803 </member> 3804 <member name="M:NAnt.Core.Functions.PathFunctions.IsPathRooted(System.String)"> 3805 <summary> 3806 Determines whether a path string is absolute. 3807 </summary> 3808 <param name="path">The path to test.</param> 3809 <returns> 3810 <see langword="true"/> if path contains an absolute <paramref name="path"/>; 3811 otherwise, <see langword="false"/>. 3812 </returns> 3813 <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception> 3814 </member> 3815 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetVariable(System.String,System.String)"> 3816 <summary> 3817 Gets the value of a variable for the specified package. 3818 </summary> 3819 <param name="package">The package for which the variable should be retrieved.</param> 3820 <param name="name">The name of the variable.</param> 3821 <returns> 3822 The value of variable <paramref name="name"/> for the specified 3823 package. 3824 </returns> 3825 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3826 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception> 3827 </member> 3828 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetLinkFlags(System.String)"> 3829 <summary> 3830 Gets the link flags required to compile the package, including all 3831 its dependencies. 3832 </summary> 3833 <param name="package">The package for which the link flags should be retrieved.</param> 3834 <returns> 3835 The link flags required to compile the package. 3836 </returns> 3837 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3838 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception> 3839 </member> 3840 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetCompileFlags(System.String)"> 3841 <summary> 3842 Gets the compile flags required to compile the package, including all 3843 its dependencies. 3844 </summary> 3845 <param name="package">The package for which the compile flags should be retrieved.</param> 3846 <returns> 3847 The pre-processor and compile flags required to compile the package. 3848 </returns> 3849 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3850 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception> 3851 </member> 3852 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetModVersion(System.String)"> 3853 <summary> 3854 Determines the version of the given package. 3855 </summary> 3856 <param name="package">The package to get the version of.</param> 3857 <returns> 3858 The version of the given package. 3859 </returns> 3860 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3861 <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception> 3862 </member> 3863 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsAtLeastVersion(System.String,System.String)"> 3864 <summary> 3865 Determines whether the given package is at least version 3866 <paramref name="version"/>. 3867 </summary> 3868 <param name="package">The package to check.</param> 3869 <param name="version">The version the package should at least have.</param> 3870 <returns> 3871 <see langword="true"/> if the given package is at least version 3872 <paramref name="version"/>; otherwise, <see langword="false"/>. 3873 </returns> 3874 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3875 </member> 3876 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsExactVersion(System.String,System.String)"> 3877 <summary> 3878 Determines whether the given package is exactly version 3879 <paramref name="version"/>. 3880 </summary> 3881 <param name="package">The package to check.</param> 3882 <param name="version">The version the package should have.</param> 3883 <returns> 3884 <see langword="true"/> if the given package is exactly version 3885 <paramref name="version"/>; otherwise, <see langword="false"/>. 3886 </returns> 3887 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3888 </member> 3889 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsMaxVersion(System.String,System.String)"> 3890 <summary> 3891 Determines whether the given package is at no newer than version 3892 <paramref name="version"/>. 3893 </summary> 3894 <param name="package">The package to check.</param> 3895 <param name="version">The version the package should maximum have.</param> 3896 <returns> 3897 <see langword="true"/> if the given package is at no newer than 3898 version <paramref name="version"/>; otherwise, <see langword="false"/>. 3899 </returns> 3900 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3901 </member> 3902 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsBetweenVersion(System.String,System.String,System.String)"> 3903 <summary> 3904 Determines whether the given package is between two versions. 3905 </summary> 3906 <param name="package">The package to check.</param> 3907 <param name="minVersion">The version the package should at least have.</param> 3908 <param name="maxVersion">The version the package should maximum have.</param> 3909 <returns> 3910 <see langword="true"/> if the given package is between <paramref name="minVersion"/> 3911 and <paramref name="maxVersion"/>; otherwise, <see langword="false"/>. 3912 </returns> 3913 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3914 </member> 3915 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.Exists(System.String)"> 3916 <summary> 3917 Determines whether the given package exists. 3918 </summary> 3919 <param name="package">The package to check.</param> 3920 <returns> 3921 <see langword="true"/> if the package exists; otherwise, 3922 <see langword="false"/>. 3923 </returns> 3924 <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception> 3925 </member> 3926 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigBool(NAnt.Core.Types.Argument[])"> 3927 <summary> 3928 Runs pkg-config with the specified arguments and returns a 3929 <see cref="T:System.Boolean"/> based on the exit code. 3930 </summary> 3931 <param name="args">The arguments to pass to pkg-config.</param> 3932 <returns> 3933 <see langword="true"/> if pkg-config exited with exit code 0; 3934 otherwise, <see langword="false"/> 3935 </returns> 3936 </member> 3937 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigString(NAnt.Core.Types.Argument[])"> 3938 <summary> 3939 Runs pkg-config with the specified arguments and returns the result 3940 as a <see cref="T:System.String"/>. 3941 </summary> 3942 <param name="args">The arguments to pass to pkg-config.</param> 3943 <returns> 3944 The result of running pkg-config with the specified arguments. 3945 </returns> 3946 </member> 3947 <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetTask(System.IO.Stream)"> 3948 <summary> 3949 Factory method to return a new instance of ExecTask 3950 </summary> 3951 <param name="stream"></param> 3952 <returns></returns> 3953 </member> 3954 <member name="M:NAnt.Core.Functions.StringFunctions.GetLength(System.String)"> 3955 <summary> 3956 Returns the length of the specified string. 3957 </summary> 3958 <param name="s">input string</param> 3959 <returns> 3960 The string's length. 3961 </returns> 3962 <example> 3963 <code>string::get-length('foo') ==> 3</code> 3964 </example> 3965 <example> 3966 <code>string::get-length('') ==> 0</code> 3967 </example> 3968 </member> 3969 <member name="M:NAnt.Core.Functions.StringFunctions.Substring(System.String,System.Int32,System.Int32)"> 3970 <summary> 3971 Returns a substring of the specified string. 3972 </summary> 3973 <param name="str">input string</param> 3974 <param name="startIndex">position of the start of the substring</param> 3975 <param name="length">the length of the substring</param> 3976 <returns> 3977 <para> 3978 If the <paramref name="length"/> is greater than zero, the 3979 function returns a substring starting at character position 3980 <paramref name="startIndex"/> with a length of <paramref name="length"/> 3981 characters. 3982 </para> 3983 <para> 3984 If the <paramref name="length"/> is equal to zero, the function 3985 returns an empty string. 3986 </para> 3987 </returns> 3988 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> or <paramref name="length"/> is less than zero.</exception> 3989 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> is greater than the length of <paramref name="str"/>.</exception> 3990 <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> plus <paramref name="length"/> indicates a position not within <paramref name="str"/>.</exception> 3991 <example> 3992 <code>string::substring('testing string', 0, 4) ==> 'test'</code> 3993 </example> 3994 <example> 3995 <code>string::substring('testing string', 8, 3) ==> 'str'</code> 3996 </example> 3997 <example> 3998 <code>string::substring('testing string', 8, 0) ==> ''</code> 3999 </example> 4000 <example> 4001 <code>string::substring('testing string', -1, 5) ==> ERROR</code> 4002 </example> 4003 <example> 4004 <code>string::substring('testing string', 8, -1) ==> ERROR</code> 4005 </example> 4006 <example> 4007 <code>string::substring('testing string', 5, 17) ==> ERROR</code> 4008 </example> 4009 </member> 4010 <member name="M:NAnt.Core.Functions.StringFunctions.StartsWith(System.String,System.String)"> 4011 <summary> 4012 Tests whether the specified string starts with the specified prefix 4013 string. 4014 </summary> 4015 <param name="s1">test string</param> 4016 <param name="s2">prefix string</param> 4017 <returns> 4018 <see langword="true" /> when <paramref name="s2" /> is a prefix for 4019 the string <paramref name="s1" />. Meaning, the characters at the 4020 beginning of <paramref name="s1" /> are identical to 4021 <paramref name="s2" />; otherwise, <see langword="false" />. 4022 </returns> 4023 <remarks> 4024 This function performs a case-sensitive word search using the 4025 invariant culture. 4026 </remarks> 4027 <example> 4028 <code>string::starts-with('testing string', 'test') ==> true</code> 4029 </example> 4030 <example> 4031 <code>string::starts-with('testing string', 'testing') ==> true</code> 4032 </example> 4033 <example> 4034 <code>string::starts-with('testing string', 'string') ==> false</code> 4035 </example> 4036 <example> 4037 <code>string::starts-with('test', 'testing string') ==> false</code> 4038 </example> 4039 </member> 4040 <member name="M:NAnt.Core.Functions.StringFunctions.EndsWith(System.String,System.String)"> 4041 <summary> 4042 Tests whether the specified string ends with the specified suffix 4043 string. 4044 </summary> 4045 <param name="s1">test string</param> 4046 <param name="s2">suffix string</param> 4047 <returns> 4048 <see langword="true" /> when <paramref name="s2" /> is a suffix for 4049 the string <paramref name="s1" />. Meaning, the characters at the 4050 end of <paramref name="s1" /> are identical to 4051 <paramref name="s2" />; otherwise, <see langword="false" />. 4052 </returns> 4053 <remarks> 4054 This function performs a case-sensitive word search using the 4055 invariant culture. 4056 </remarks> 4057 <example> 4058 <code>string::ends-with('testing string', 'string') ==> true</code> 4059 </example> 4060 <example> 4061 <code>string::ends-with('testing string', '') ==> true</code> 4062 </example> 4063 <example> 4064 <code>string::ends-with('testing string', 'bring') ==> false</code> 4065 </example> 4066 <example> 4067 <code>string::ends-with('string', 'testing string') ==> false</code> 4068 </example> 4069 </member> 4070 <member name="M:NAnt.Core.Functions.StringFunctions.ToLower(System.String)"> 4071 <summary> 4072 Returns the specified string converted to lowercase. 4073 </summary> 4074 <param name="s">input string</param> 4075 <returns> 4076 The string <paramref name="s" /> in lowercase. 4077 </returns> 4078 <remarks> 4079 The casing rules of the invariant culture are used to convert the 4080 <paramref name="s" /> to lowercase. 4081 </remarks> 4082 <example> 4083 <code>string::to-lower('testing string') ==> 'testing string'</code> 4084 </example> 4085 <example> 4086 <code>string::to-lower('Testing String') ==> 'testing string'</code> 4087 </example> 4088 <example> 4089 <code>string::to-lower('Test 123') ==> 'test 123'</code> 4090 </example> 4091 </member> 4092 <member name="M:NAnt.Core.Functions.StringFunctions.ToUpper(System.String)"> 4093 <summary> 4094 Returns the specified string converted to uppercase. 4095 </summary> 4096 <param name="s">input string</param> 4097 <returns> 4098 The string <paramref name="s" /> in uppercase. 4099 </returns> 4100 <remarks> 4101 The casing rules of the invariant culture are used to convert the 4102 <paramref name="s" /> to uppercase. 4103 </remarks> 4104 <example> 4105 <code>string::to-upper('testing string') ==> 'TESTING STRING'</code> 4106 </example> 4107 <example> 4108 <code>string::to-upper('Testing String') ==> 'TESTING STRING'</code> 4109 </example> 4110 <example> 4111 <code>string::to-upper('Test 123') ==> 'TEST 123'</code> 4112 </example> 4113 </member> 4114 <member name="M:NAnt.Core.Functions.StringFunctions.Replace(System.String,System.String,System.String)"> 4115 <summary> 4116 Returns a string corresponding to the replacement of a given string 4117 with another in the specified string. 4118 </summary> 4119 <param name="str">input string</param> 4120 <param name="oldValue">A <see cref="T:System.String"/> to be replaced.</param> 4121 <param name="newValue">A <see cref="T:System.String"/> to replace all occurrences of <paramref name="oldValue"/>.</param> 4122 <returns> 4123 A <see cref="T:System.String"/> equivalent to <paramref name="str"/> but 4124 with all instances of <paramref name="oldValue"/> replaced with 4125 <paramref name="newValue"/>. 4126 </returns> 4127 <exception cref="T:System.ArgumentException"><paramref name="oldValue"/> is an empty string.</exception> 4128 <remarks> 4129 This function performs a word (case-sensitive and culture-sensitive) 4130 search to find <paramref name="oldValue"/>. 4131 </remarks> 4132 <example> 4133 <code>string::replace('testing string', 'test', 'winn') ==> 'winning string'</code> 4134 </example> 4135 <example> 4136 <code>string::replace('testing string', 'foo', 'winn') ==> 'testing string'</code> 4137 </example> 4138 <example> 4139 <code>string::replace('testing string', 'ing', '') ==> 'test str'</code> 4140 </example> 4141 <example> 4142 <code>string::replace('banana', 'ana', 'ana') ==> 'banana'</code> 4143 </example> 4144 </member> 4145 <member name="M:NAnt.Core.Functions.StringFunctions.Contains(System.String,System.String)"> 4146 <summary> 4147 Tests whether the specified string contains the given search string. 4148 </summary> 4149 <param name="source">The string to search.</param> 4150 <param name="value">The string to locate within <paramref name="source" />.</param> 4151 <returns> 4152 <see langword="true" /> if <paramref name="value" /> is found in 4153 <paramref name="source" />; otherwise, <see langword="false" />. 4154 </returns> 4155 <remarks> 4156 This function performs a case-sensitive word search using the 4157 invariant culture. 4158 </remarks> 4159 <example> 4160 <code>string::contains('testing string', 'test') ==> true</code> 4161 </example> 4162 <example> 4163 <code>string::contains('testing string', '') ==> true</code> 4164 </example> 4165 <example> 4166 <code>string::contains('testing string', 'Test') ==> false</code> 4167 </example> 4168 <example> 4169 <code>string::contains('testing string', 'foo') ==> false</code> 4170 </example> 4171 </member> 4172 <member name="M:NAnt.Core.Functions.StringFunctions.IndexOf(System.String,System.String)"> 4173 <summary> 4174 Returns the position of the first occurrence in the specified string 4175 of the given search string. 4176 </summary> 4177 <param name="source">The string to search.</param> 4178 <param name="value">The string to locate within <paramref name="source" />.</param> 4179 <returns> 4180 <para> 4181 The lowest-index position of <paramref name="value" /> in 4182 <paramref name="source" /> if it is found, or -1 if <paramref name="source" /> 4183 does not contain <paramref name="value" />. 4184 </para> 4185 <para> 4186 If <paramref name="value" /> is an empty string, the return value 4187 will always be <c>0</c>. 4188 </para> 4189 </returns> 4190 <remarks> 4191 This function performs a case-sensitive word search using the 4192 invariant culture. 4193 </remarks> 4194 <example> 4195 <code>string::index-of('testing string', 'test') ==> 0</code> 4196 </example> 4197 <example> 4198 <code>string::index-of('testing string', '') ==> 0</code> 4199 </example> 4200 <example> 4201 <code>string::index-of('testing string', 'Test') ==> -1</code> 4202 </example> 4203 <example> 4204 <code>string::index-of('testing string', 'ing') ==> 4</code> 4205 </example> 4206 </member> 4207 <member name="M:NAnt.Core.Functions.StringFunctions.LastIndexOf(System.String,System.String)"> 4208 <summary> 4209 Returns the position of the last occurrence in the specified string 4210 of the given search string. 4211 </summary> 4212 <param name="source">The string to search.</param> 4213 <param name="value">The string to locate within <paramref name="source" />.</param> 4214 <returns> 4215 <para> 4216 The highest-index position of <paramref name="value" /> in 4217 <paramref name="source" /> if it is found, or -1 if <paramref name="source" /> 4218 does not contain <paramref name="value" />. 4219 </para> 4220 <para> 4221 If <paramref name="value" /> is an empty string, the return value 4222 is the last index position in <paramref name="source" />. 4223 </para> 4224 </returns> 4225 <remarks> 4226 This function performs a case-sensitive word search using the 4227 invariant culture. 4228 </remarks> 4229 <example> 4230 <code>string::last-index-of('testing string', 'test') ==> 0</code> 4231 </example> 4232 <example> 4233 <code>string::last-index-of('testing string', '') ==> 13</code> 4234 </example> 4235 <example> 4236 <code>string::last-index-of('testing string', 'Test') ==> -1</code> 4237 </example> 4238 <example> 4239 <code>string::last-index-of('testing string', 'ing') ==> 11</code> 4240 </example> 4241 </member> 4242 <member name="M:NAnt.Core.Functions.StringFunctions.PadLeft(System.String,System.Int32,System.String)"> 4243 <summary> 4244 Returns the given string left-padded to the given length. 4245 </summary> 4246 <param name="s">The <see cref="T:System.String"/> that needs to be left-padded.</param> 4247 <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param> 4248 <param name="paddingChar">A Unicode padding character.</param> 4249 <returns> 4250 If the length of <paramref name="s"/> is at least 4251 <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical 4252 to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/> 4253 will be padded on the left with as many <paramref name="paddingChar"/> 4254 characters as needed to create a length of <paramref name="totalWidth"/>. 4255 </returns> 4256 <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception> 4257 <remarks> 4258 Note that only the first character of <paramref name="paddingChar"/> 4259 will be used when padding the result. 4260 </remarks> 4261 <example> 4262 <code>string::pad-left('test', 10, ' ') ==> ' test'</code> 4263 </example> 4264 <example> 4265 <code>string::pad-left('test', 10, 'test') ==> 'tttttttest'</code> 4266 </example> 4267 <example> 4268 <code>string::pad-left('test', 3, ' ') ==> 'test'</code> 4269 </example> 4270 <example> 4271 <code>string::pad-left('test', -4, ' ') ==> ERROR</code> 4272 </example> 4273 </member> 4274 <member name="M:NAnt.Core.Functions.StringFunctions.PadRight(System.String,System.Int32,System.String)"> 4275 <summary> 4276 Returns the given string right-padded to the given length. 4277 </summary> 4278 <param name="s">The <see cref="T:System.String"/> that needs to be right-padded.</param> 4279 <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param> 4280 <param name="paddingChar">A Unicode padding character.</param> 4281 <returns> 4282 If the length of <paramref name="s"/> is at least 4283 <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical 4284 to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/> 4285 will be padded on the right with as many <paramref name="paddingChar"/> 4286 characters as needed to create a length of <paramref name="totalWidth"/>. 4287 </returns> 4288 <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception> 4289 <remarks> 4290 Note that only the first character of <paramref name="paddingChar"/> 4291 will be used when padding the result. 4292 </remarks> 4293 <example> 4294 <code>string::pad-right('test', 10, ' ') ==> 'test '</code> 4295 </example> 4296 <example> 4297 <code>string::pad-right('test', 10, 'abcd') ==> 'testaaaaaa'</code> 4298 </example> 4299 <example> 4300 <code>string::pad-right('test', 3, ' ') ==> 'test'</code> 4301 </example> 4302 <example> 4303 <code>string::pad-right('test', -3, ' ') ==> ERROR</code> 4304 </example> 4305 </member> 4306 <member name="M:NAnt.Core.Functions.StringFunctions.Trim(System.String)"> 4307 <summary> 4308 Returns the given string trimmed of whitespace. 4309 </summary> 4310 <param name="s">input string</param> 4311 <returns> 4312 The string <paramref name="s" /> with any leading or trailing 4313 white space characters removed. 4314 </returns> 4315 <example> 4316 <code>string::trim(' test ') ==> 'test'</code> 4317 </example> 4318 <example> 4319 <code>string::trim('\t\tfoo \r\n') ==> 'foo'</code> 4320 </example> 4321 </member> 4322 <member name="M:NAnt.Core.Functions.StringFunctions.TrimStart(System.String)"> 4323 <summary> 4324 Returns the given string trimmed of leading whitespace. 4325 </summary> 4326 <param name="s">input string</param> 4327 <returns> 4328 The string <paramref name="s" /> with any leading 4329 whites pace characters removed. 4330 </returns> 4331 <example> 4332 <code>string::trim-start(' test ') ==> 'test '</code> 4333 </example> 4334 <example> 4335 <code>string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n'</code> 4336 </example> 4337 </member> 4338 <member name="M:NAnt.Core.Functions.StringFunctions.TrimEnd(System.String)"> 4339 <summary> 4340 Returns the given string trimmed of trailing whitespace. 4341 </summary> 4342 <param name="s">input string</param> 4343 <returns> 4344 The string <paramref name="s" /> with any trailing 4345 white space characters removed. 4346 </returns> 4347 <example> 4348 <code>string::trim-end(' test ') ==> ' test'</code> 4349 </example> 4350 <example> 4351 <code>string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo'</code> 4352 </example> 4353 </member> 4354 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalDays(System.TimeSpan)"> 4355 <summary> 4356 Returns the total number of days represented by the specified 4357 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional days. 4358 </summary> 4359 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4360 <returns> 4361 The total number of days represented by the given <see cref="T:System.TimeSpan"/>. 4362 </returns> 4363 </member> 4364 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalHours(System.TimeSpan)"> 4365 <summary> 4366 Returns the total number of hours represented by the specified 4367 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional hours. 4368 </summary> 4369 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4370 <returns> 4371 The total number of hours represented by the given <see cref="T:System.TimeSpan"/>. 4372 </returns> 4373 </member> 4374 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMinutes(System.TimeSpan)"> 4375 <summary> 4376 Returns the total number of minutes represented by the specified 4377 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional minutes. 4378 </summary> 4379 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4380 <returns> 4381 The total number of minutes represented by the given <see cref="T:System.TimeSpan"/>. 4382 </returns> 4383 </member> 4384 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalSeconds(System.TimeSpan)"> 4385 <summary> 4386 Returns the total number of seconds represented by the specified 4387 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional seconds. 4388 </summary> 4389 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4390 <returns> 4391 The total number of seconds represented by the given <see cref="T:System.TimeSpan"/>. 4392 </returns> 4393 </member> 4394 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMilliseconds(System.TimeSpan)"> 4395 <summary> 4396 Returns the total number of milliseconds represented by the specified 4397 <see cref="T:System.TimeSpan"/>, expressed in whole and fractional milliseconds. 4398 </summary> 4399 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4400 <returns> 4401 The total number of milliseconds represented by the given 4402 <see cref="T:System.TimeSpan"/>. 4403 </returns> 4404 </member> 4405 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetDays(System.TimeSpan)"> 4406 <summary> 4407 Returns the number of whole days represented by the specified 4408 <see cref="T:System.TimeSpan"/>. 4409 </summary> 4410 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4411 <returns> 4412 The number of whole days represented by the given 4413 <see cref="T:System.TimeSpan"/>. 4414 </returns> 4415 <example> 4416 <para> 4417 Remove all files that have not been modified in the last 7 days from directory "binaries".</para> 4418 <code> 4419 <![CDATA[ 4420 <foreach item="File" in="binaries" property="filename"> 4421 <if test="${timespan::get-days(datetime::now() - file::get-last-write-time(filename)) >= 7}"> 4422 <delete file="${filename}" /> 4423 </if> 4424 </foreach> 4425 ]]> 4426 </code> 4427 </example> 4428 </member> 4429 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetHours(System.TimeSpan)"> 4430 <summary> 4431 Returns the number of whole hours represented by the specified 4432 <see cref="T:System.TimeSpan"/>. 4433 </summary> 4434 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4435 <returns> 4436 The number of whole hours represented by the given 4437 <see cref="T:System.TimeSpan"/>. 4438 </returns> 4439 </member> 4440 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMinutes(System.TimeSpan)"> 4441 <summary> 4442 Returns the number of whole minutes represented by the specified 4443 <see cref="T:System.TimeSpan"/>. 4444 </summary> 4445 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4446 <returns> 4447 The number of whole minutes represented by the given 4448 <see cref="T:System.TimeSpan"/>. 4449 </returns> 4450 </member> 4451 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetSeconds(System.TimeSpan)"> 4452 <summary> 4453 Returns the number of whole seconds represented by the specified 4454 <see cref="T:System.TimeSpan"/>. 4455 </summary> 4456 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4457 <returns> 4458 The number of whole seconds represented by the given 4459 <see cref="T:System.TimeSpan"/>. 4460 </returns> 4461 </member> 4462 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMilliseconds(System.TimeSpan)"> 4463 <summary> 4464 Returns the number of whole milliseconds represented by the specified 4465 <see cref="T:System.TimeSpan"/>. 4466 </summary> 4467 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4468 <returns> 4469 The number of whole milliseconds represented by the given 4470 <see cref="T:System.TimeSpan"/>. 4471 </returns> 4472 </member> 4473 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTicks(System.TimeSpan)"> 4474 <summary> 4475 Returns the number of ticks contained in the specified 4476 <see cref="T:System.TimeSpan"/>. 4477 </summary> 4478 <param name="value">A <see cref="T:System.TimeSpan"/>.</param> 4479 <returns> 4480 The number of ticks contained in the given <see cref="T:System.TimeSpan"/>. 4481 </returns> 4482 </member> 4483 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromDays(System.Double)"> 4484 <summary> 4485 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number 4486 of days, where the specification is accurate to the nearest millisecond. 4487 </summary> 4488 <param name="value">A number of days, accurate to the nearest millisecond.</param> 4489 <returns> 4490 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>. 4491 </returns> 4492 </member> 4493 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromHours(System.Double)"> 4494 <summary> 4495 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number 4496 of hours, where the specification is accurate to the nearest 4497 millisecond. 4498 </summary> 4499 <param name="value">A number of hours, accurate to the nearest millisecond.</param> 4500 <returns> 4501 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>. 4502 </returns> 4503 </member> 4504 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMinutes(System.Double)"> 4505 <summary> 4506 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number 4507 of minutes, where the specification is accurate to the nearest 4508 millisecond. 4509 </summary> 4510 <param name="value">A number of minutes, accurate to the nearest millisecond.</param> 4511 <returns> 4512 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>. 4513 </returns> 4514 </member> 4515 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromSeconds(System.Double)"> 4516 <summary> 4517 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number 4518 of seconds, where the specification is accurate to the nearest 4519 millisecond. 4520 </summary> 4521 <param name="value">A number of seconds, accurate to the nearest millisecond.</param> 4522 <returns> 4523 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>. 4524 </returns> 4525 </member> 4526 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMilliseconds(System.Double)"> 4527 <summary> 4528 Returns a <see cref="T:System.TimeSpan"/> that represents a specified number 4529 of milliseconds. 4530 </summary> 4531 <param name="value">A number of milliseconds.</param> 4532 <returns> 4533 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>. 4534 </returns> 4535 </member> 4536 <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromTicks(System.Int64)"> 4537 <summary> 4538 Returns a <see cref="T:System.TimeSpan"/> that represents a specified time, 4539 where the specification is in units of ticks. 4540 </summary> 4541 <param name="value">A number of ticks that represent a time.</param> 4542 <returns> 4543 A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>. 4544 </returns> 4545 </member> 4546 <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.Parse(System.String)"> 4547 <summary> 4548 Constructs a <see cref="T:System.TimeSpan"/> from a time indicated by a 4549 specified string. 4550 </summary> 4551 <param name="s">A string.</param> 4552 <returns> 4553 A <see cref="T:System.TimeSpan"/> that corresponds to <paramref name="s"/>. 4554 </returns> 4555 <exception cref="T:System.FormatException"><paramref name="s"/> has an invalid format.</exception> 4556 <exception cref="T:System.OverflowException">At least one of the hours, minutes, or seconds components is outside its valid range.</exception> 4557 </member> 4558 <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.ToString(System.TimeSpan)"> 4559 <summary> 4560 Converts the specified <see cref="T:System.TimeSpan"/> to its equivalent 4561 string representation. 4562 </summary> 4563 <param name="value">A <see cref="T:System.TimeSpan"/> to convert.</param> 4564 <returns> 4565 The string representation of <paramref name="value"/>. The format 4566 of the return value is of the form: [-][d.]hh:mm:ss[.ff]. 4567 </returns> 4568 </member> 4569 <member name="M:NAnt.Core.Functions.VersionFunctions.GetMajor(System.Version)"> 4570 <summary> 4571 Gets the value of the major component of a given version. 4572 </summary> 4573 <param name="version">A version.</param> 4574 <returns> 4575 The major version number. 4576 </returns> 4577 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/> 4578 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/> 4579 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/> 4580 </member> 4581 <member name="M:NAnt.Core.Functions.VersionFunctions.GetMinor(System.Version)"> 4582 <summary> 4583 Gets the value of the minor component of a given version. 4584 </summary> 4585 <param name="version">A version.</param> 4586 <returns> 4587 The minor version number. 4588 </returns> 4589 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/> 4590 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/> 4591 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/> 4592 </member> 4593 <member name="M:NAnt.Core.Functions.VersionFunctions.GetBuild(System.Version)"> 4594 <summary> 4595 Gets the value of the build component of a given version. 4596 </summary> 4597 <param name="version">A version.</param> 4598 <returns> 4599 The build number, or -1 if the build number is undefined. 4600 </returns> 4601 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/> 4602 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/> 4603 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/> 4604 </member> 4605 <member name="M:NAnt.Core.Functions.VersionFunctions.GetRevision(System.Version)"> 4606 <summary> 4607 Gets the value of the revision component of a given version. 4608 </summary> 4609 <param name="version">A version.</param> 4610 <returns> 4611 The revision number, or -1 if the revision number is undefined. 4612 </returns> 4613 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/> 4614 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/> 4615 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/> 4616 </member> 4617 <member name="M:NAnt.Core.Functions.VersionConversionFunctions.Parse(System.String)"> 4618 <summary> 4619 Converts the specified string representation of a version to 4620 its <see cref="T:System.Version"/> equivalent. 4621 </summary> 4622 <param name="version">A string containing the major, minor, build, and revision numbers, where each number is delimited with a period character ('.').</param> 4623 <returns> 4624 A <see cref="T:System.Version"/> instance representing the specified 4625 <see cref="T:System.String"/>. 4626 </returns> 4627 <exception cref="T:System.ArgumentException"><paramref name="version"/> has fewer than two components or more than four components.</exception> 4628 <exception cref="T:System.ArgumentOutOfRangeException">A major, minor, build, or revision component is less than zero.</exception> 4629 <exception cref="T:System.FormatException">At least one component of <paramref name="version"/> does not parse to a decimal integer.</exception> 4630 </member> 4631 <member name="M:NAnt.Core.Functions.VersionConversionFunctions.ToString(System.Version)"> 4632 <summary> 4633 Converts the specified <see cref="T:System.Version"/> to its equivalent 4634 string representation. 4635 </summary> 4636 <param name="value">A <see cref="T:System.Version"/> to convert.</param> 4637 <returns> 4638 The string representation of the values of the major, minor, build, 4639 and revision components of the specified <see cref="T:System.Version"/>. 4640 </returns> 4641 <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/> 4642 <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/> 4643 <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/> 4644 </member> 4645 <member name="T:NAnt.Core.Tasks.AttribTask"> 4646 <summary> 4647 Changes the file attributes of a file or set of files and directories. 4648 </summary> 4649 <remarks> 4650 <para> 4651 <see cref="T:NAnt.Core.Tasks.AttribTask"/> does not have the concept of turning 4652 attributes off. Instead you specify all the attributes that you want 4653 turned on and the rest are turned off by default. 4654 </para> 4655 <para> 4656 Refer to the <see cref="T:System.IO.FileAttributes"/> enumeration in the .NET SDK 4657 for more information about file attributes. 4658 </para> 4659 </remarks> 4660 <example> 4661 <para> 4662 Set the <c>read-only</c> file attribute for the specified file in 4663 the project directory. 4664 </para> 4665 <code> 4666 <![CDATA[ 4667 <attrib file="myfile.txt" readonly="true" /> 4668 ]]> 4669 </code> 4670 </example> 4671 <example> 4672 <para> 4673 Set the <c>normal</c> file attribute for the specified file. 4674 </para> 4675 <code> 4676 <![CDATA[ 4677 <attrib file="myfile.txt" normal="true" /> 4678 ]]> 4679 </code> 4680 </example> 4681 <example> 4682 <para> 4683 Set the <c>normal</c> file attribute for all executable files in 4684 the current project directory and sub-directories. 4685 </para> 4686 <code> 4687 <![CDATA[ 4688 <attrib normal="true"> 4689 <fileset> 4690 <include name="**/*.exe" /> 4691 <include name="bin" /> 4692 </fileset> 4693 </attrib> 4694 ]]> 4695 </code> 4696 </example> 4697 </member> 4698 <member name="T:NAnt.Core.Task"> 4699 <summary> 4700 Provides the abstract base class for tasks. 4701 </summary> 4702 <remarks> 4703 A task is a piece of code that can be executed. 4704 </remarks> 4705 </member> 4706 <member name="M:NAnt.Core.Task.Execute"> 4707 <summary> 4708 Executes the task unless it is skipped. 4709 </summary> 4710 </member> 4711 <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String)"> 4712 <summary> 4713 Logs a message with the given priority. 4714 </summary> 4715 <param name="messageLevel">The message priority at which the specified message is to be logged.</param> 4716 <param name="message">The message to be logged.</param> 4717 <remarks> 4718 <para> 4719 The actual logging is delegated to the project. 4720 </para> 4721 <para> 4722 If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a 4723 message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the 4724 priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/> 4725 when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>. 4726 </para> 4727 <para> 4728 This will allow individual tasks to run in verbose mode while 4729 the build log itself is still configured with threshold 4730 <see cref="F:NAnt.Core.Level.Info"/>. 4731 </para> 4732 <para> 4733 The threshold of the project is not taken into account to determine 4734 whether a message should be passed to the logging infrastructure, 4735 as build listeners might be interested in receiving all messages. 4736 </para> 4737 </remarks> 4738 </member> 4739 <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String,System.Object[])"> 4740 <summary> 4741 Logs a formatted message with the given priority. 4742 </summary> 4743 <param name="messageLevel">The message priority at which the specified message is to be logged.</param> 4744 <param name="message">The message to log, containing zero or more format items.</param> 4745 <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param> 4746 <remarks> 4747 <para> 4748 The actual logging is delegated to the project. 4749 </para> 4750 <para> 4751 If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a 4752 message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the 4753 priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>. 4754 when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>. 4755 </para> 4756 <para> 4757 This will allow individual tasks to run in verbose mode while 4758 the build log itself is still configured with threshold 4759 <see cref="F:NAnt.Core.Level.Info"/>. 4760 </para> 4761 </remarks> 4762 </member> 4763 <member name="M:NAnt.Core.Task.IsLogEnabledFor(NAnt.Core.Level)"> 4764 <summary> 4765 Determines whether build output is enabled for the given 4766 <see cref="T:NAnt.Core.Level"/>. 4767 </summary> 4768 <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to check.</param> 4769 <returns> 4770 <see langword="true"/> if messages with the given <see cref="T:NAnt.Core.Level"/> 4771 should be passed on to the logging infrastructure; otherwise, 4772 <see langword="false"/>. 4773 </returns> 4774 <remarks> 4775 The threshold of the project is not taken into account to determine 4776 whether a message should be passed to the logging infrastructure, 4777 as build listeners might be interested in receiving all messages. 4778 </remarks> 4779 </member> 4780 <member name="M:NAnt.Core.Task.InitializeTaskConfiguration"> 4781 <summary> 4782 Initializes the configuration of the task using configuration 4783 settings retrieved from the NAnt configuration file. 4784 </summary> 4785 <remarks> 4786 TO-DO : Remove this temporary hack when a permanent solution is 4787 available for loading the default values from the configuration 4788 file if a build element is constructed from code. 4789 </remarks> 4790 </member> 4791 <member name="M:NAnt.Core.Task.Initialize"> 4792 <summary>Initializes the task.</summary> 4793 </member> 4794 <member name="M:NAnt.Core.Task.InitializeTask(System.Xml.XmlNode)"> 4795 <summary>Initializes the task.</summary> 4796 </member> 4797 <member name="M:NAnt.Core.Task.ExecuteTask"> 4798 <summary>Executes the task.</summary> 4799 </member> 4800 <member name="M:NAnt.Core.Task.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)"> 4801 <summary> 4802 Locates the XML node for the specified attribute in either the 4803 configuration section of the extension assembly or the.project. 4804 </summary> 4805 <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param> 4806 <param name="framework">The framework to use to obtain framework specific information, or <see langword="null" /> if no framework specific information should be used.</param> 4807 <returns> 4808 The XML configuration node for the specified attribute, or 4809 <see langword="null" /> if no corresponding XML node could be 4810 located. 4811 </returns> 4812 <remarks> 4813 If there's a valid current framework, the configuration section for 4814 that framework will first be searched. If no corresponding 4815 configuration node can be located in that section, the framework-neutral 4816 section of the project configuration node will be searched. 4817 </remarks> 4818 </member> 4819 <member name="P:NAnt.Core.Task.FailOnError"> 4820 <summary> 4821 Determines if task failure stops the build, or is just reported. 4822 The default is <see langword="true" />. 4823 </summary> 4824 </member> 4825 <member name="P:NAnt.Core.Task.Verbose"> 4826 <summary> 4827 Determines whether the task should report detailed build log messages. 4828 The default is <see langword="false" />. 4829 </summary> 4830 </member> 4831 <member name="P:NAnt.Core.Task.IfDefined"> 4832 <summary> 4833 If <see langword="true" /> then the task will be executed; otherwise, 4834 skipped. The default is <see langword="true" />. 4835 </summary> 4836 </member> 4837 <member name="P:NAnt.Core.Task.UnlessDefined"> 4838 <summary> 4839 Opposite of <see cref="P:NAnt.Core.Task.IfDefined"/>. If <see langword="false"/> 4840 then the task will be executed; otherwise, skipped. The default is 4841 <see langword="false"/>. 4842 </summary> 4843 </member> 4844 <member name="P:NAnt.Core.Task.Name"> 4845 <summary> 4846 The name of the task. 4847 </summary> 4848 </member> 4849 <member name="P:NAnt.Core.Task.LogPrefix"> 4850 <summary> 4851 The prefix used when sending messages to the log. 4852 </summary> 4853 </member> 4854 <member name="P:NAnt.Core.Task.Threshold"> 4855 <summary> 4856 Gets or sets the log threshold for this <see cref="T:NAnt.Core.Task"/>. By 4857 default the threshold of a task is <see cref="F:NAnt.Core.Level.Debug"/>, 4858 causing no messages to be filtered in the task itself. 4859 </summary> 4860 <value> 4861 The log threshold level for this <see cref="T:NAnt.Core.Task"/>. 4862 </value> 4863 <remarks> 4864 When the threshold of a <see cref="T:NAnt.Core.Task"/> is higher than the 4865 threshold of the <see cref="T:NAnt.Core.Project"/>, then all messages will 4866 still be delivered to the build listeners. 4867 </remarks> 4868 </member> 4869 <member name="P:NAnt.Core.Task.TaskBuilder"> 4870 <summary> 4871 Returns the TaskBuilder used to construct an instance of this 4872 <see cref="T:NAnt.Core.Task"/>. 4873 </summary> 4874 </member> 4875 <member name="P:NAnt.Core.Tasks.AttribTask.File"> 4876 <summary> 4877 The name of the file which will have its attributes set. This is 4878 provided as an alternate to using the task's fileset. 4879 </summary> 4880 </member> 4881 <member name="P:NAnt.Core.Tasks.AttribTask.AttribFileSet"> 4882 <summary> 4883 All the matching files and directories in this fileset will have 4884 their attributes set. 4885 </summary> 4886 </member> 4887 <member name="P:NAnt.Core.Tasks.AttribTask.ArchiveAttrib"> 4888 <summary> 4889 Set the archive attribute. The default is <see langword="false" />. 4890 </summary> 4891 </member> 4892 <member name="P:NAnt.Core.Tasks.AttribTask.HiddenAttrib"> 4893 <summary> 4894 Set the hidden attribute. The default is <see langword="false" />. 4895 </summary> 4896 </member> 4897 <member name="P:NAnt.Core.Tasks.AttribTask.NormalAttrib"> 4898 <summary> 4899 Set the normal file attributes. This attribute is only valid if used 4900 alone. The default is <see langword="false" />. 4901 </summary> 4902 </member> 4903 <member name="P:NAnt.Core.Tasks.AttribTask.ReadOnlyAttrib"> 4904 <summary> 4905 Set the read-only attribute. The default is <see langword="false" />. 4906 </summary> 4907 </member> 4908 <member name="P:NAnt.Core.Tasks.AttribTask.SystemAttrib"> 4909 <summary> 4910 Set the system attribute. The default is <see langword="false" />. 4911 </summary> 4912 </member> 4913 <member name="T:NAnt.Core.Tasks.AvailableTask"> 4914 <summary> 4915 Checks if a resource is available at runtime. 4916 </summary> 4917 <remarks> 4918 <para> 4919 The specified property is set to <see langword="true"/> if the 4920 requested resource is available at runtime, and <see langword="false"/> 4921 if the resource is not available. 4922 </para> 4923 <note> 4924 we advise you to use the following functions instead: 4925 </note> 4926 <list type="table"> 4927 <listheader> 4928 <term>Function</term> 4929 <description>Description</description> 4930 </listheader> 4931 <item> 4932 <term><see cref="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)"/></term> 4933 <description>Determines whether the specified file exists.</description> 4934 </item> 4935 <item> 4936 <term><see cref="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)"/></term> 4937 <description>Determines whether the given path refers to an existing directory on disk.</description> 4938 </item> 4939 <item> 4940 <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)"/></term> 4941 <description>Checks whether the specified framework exists..</description> 4942 </item> 4943 <item> 4944 <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)"/></term> 4945 <description>Checks whether the SDK for the specified framework is installed.</description> 4946 </item> 4947 </list> 4948 </remarks> 4949 <example> 4950 <para> 4951 Sets the <c>myfile.present</c> property to <see langword="true"/> if the 4952 file is available on the filesystem and <see langword="false"/> if the 4953 file is not available. 4954 </para> 4955 <code> 4956 <![CDATA[ 4957 <available type="File" resource="myfile.txt" property="myfile.present" /> 4958 ]]> 4959 </code> 4960 </example> 4961 <example> 4962 <para> 4963 Sets the <c>build.dir.present</c> property to <see langword="true"/> 4964 if the directory is available on the filesystem and <see langword="false"/> 4965 if the directory is not available. 4966 </para> 4967 <code> 4968 <![CDATA[ 4969 <available type="Directory" resource="build" property="build.dir.present" /> 4970 ]]> 4971 </code> 4972 </example> 4973 <example> 4974 <para> 4975 Sets the <c>mono-0.21.framework.present</c> property to <see langword="true"/> 4976 if the Mono 0.21 framework is available on the current system and 4977 <see langword="false"/> if the framework is not available. 4978 </para> 4979 <code> 4980 <![CDATA[ 4981 <available type="Framework" resource="mono-0.21" property="mono-0.21.framework.present" /> 4982 ]]> 4983 </code> 4984 </example> 4985 <example> 4986 <para> 4987 Sets the <c>net-1.1.frameworksdk.present</c> property to <see langword="true"/> 4988 if the .NET 1.1 Framework SDK is available on the current system and 4989 <see langword="false"/> if the SDK is not available. 4990 </para> 4991 <code> 4992 <![CDATA[ 4993 <available type="FrameworkSDK" resource="net-1.1" property="net-1.1.frameworksdk.present" /> 4994 ]]> 4995 </code> 4996 </example> 4997 </member> 4998 <member name="M:NAnt.Core.Tasks.AvailableTask.ExecuteTask"> 4999 <summary> 5000 Executes the task. 5001 </summary> 5002 <remarks> 5003 <para> 5004 Sets the property identified by <see cref="P:NAnt.Core.Tasks.AvailableTask.PropertyName"/> to 5005 <see langword="true"/> when the resource exists and to <see langword="false"/> 5006 when the resource doesn't exist. 5007 </para> 5008 </remarks> 5009 <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception> 5010 </member> 5011 <member name="M:NAnt.Core.Tasks.AvailableTask.Evaluate"> 5012 <summary> 5013 Evaluates the availability of a resource. 5014 </summary> 5015 <returns> 5016 <see langword="true"/> if the resource is available; otherwise, 5017 <see langword="false"/>. 5018 </returns> 5019 <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception> 5020 </member> 5021 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFile"> 5022 <summary> 5023 Checks if the file specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> property is 5024 available on the filesystem. 5025 </summary> 5026 <returns> 5027 <see langword="true"/> when the file exists; otherwise, <see langword="false"/>. 5028 </returns> 5029 </member> 5030 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckDirectory"> 5031 <summary> 5032 Checks if the directory specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> 5033 property is available on the filesystem. 5034 </summary> 5035 <returns> 5036 <see langword="true"/> when the directory exists; otherwise, <see langword="false"/>. 5037 </returns> 5038 </member> 5039 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFramework"> 5040 <summary> 5041 Checks if the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> 5042 property is available on the current system. 5043 </summary> 5044 <returns> 5045 <see langword="true"/> when the framework is available; otherwise, 5046 <see langword="false"/>. 5047 </returns> 5048 </member> 5049 <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFrameworkSDK"> 5050 <summary> 5051 Checks if the SDK for the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> 5052 property is available on the current system. 5053 </summary> 5054 <returns> 5055 <see langword="true"/> when the SDK for the specified framework is 5056 available; otherwise, <see langword="false"/>. 5057 </returns> 5058 </member> 5059 <member name="P:NAnt.Core.Tasks.AvailableTask.Resource"> 5060 <summary> 5061 The resource which must be available. 5062 </summary> 5063 </member> 5064 <member name="P:NAnt.Core.Tasks.AvailableTask.Type"> 5065 <summary> 5066 The type of resource which must be present. 5067 </summary> 5068 </member> 5069 <member name="P:NAnt.Core.Tasks.AvailableTask.PropertyName"> 5070 <summary> 5071 The property that must be set if the resource is available. 5072 </summary> 5073 </member> 5074 <member name="T:NAnt.Core.Tasks.AvailableTask.ResourceType"> 5075 <summary> 5076 Defines the possible resource checks. 5077 </summary> 5078 </member> 5079 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.File"> 5080 <summary> 5081 Determines whether a given file exists. 5082 </summary> 5083 </member> 5084 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Directory"> 5085 <summary> 5086 Determines whether a given directory exists. 5087 </summary> 5088 </member> 5089 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Framework"> 5090 <summary> 5091 Determines whether a given framework is available. 5092 </summary> 5093 </member> 5094 <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.FrameworkSDK"> 5095 <summary> 5096 Determines whether a given SDK is available. 5097 </summary> 5098 </member> 5099 <member name="T:NAnt.Core.Tasks.CallTask"> 5100 <summary> 5101 Calls a NAnt target in the current project. 5102 </summary> 5103 <remarks> 5104 <para> 5105 When the <see cref="T:NAnt.Core.Tasks.CallTask"/> is used to execute a target, both that 5106 target and all its dependent targets will be re-executed. 5107 </para> 5108 <para> 5109 To avoid dependent targets from being executed more than once, two 5110 options are available: 5111 </para> 5112 <list type="bullet"> 5113 <item> 5114 <description> 5115 Add an "unless" attribute with value "${<see href="../functions/target.has-executed.html">target::has-executed</see>('<c><target name></c>')}" 5116 to the dependent targets. 5117 </description> 5118 </item> 5119 <item> 5120 <description> 5121 Set the <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute on the 5122 <see cref="T:NAnt.Core.Tasks.CallTask"/> to <see langword="false "/> (<c>recommended</c>). 5123 </description> 5124 </item> 5125 </list> 5126 </remarks> 5127 <example> 5128 <para> 5129 Call the target "build". 5130 </para> 5131 <code> 5132 <![CDATA[ 5133 <call target="build" /> 5134 ]]> 5135 </code> 5136 </example> 5137 <example> 5138 <para> 5139 This shows how a project could 'compile' a debug and release build 5140 using a common compile target. 5141 </para> 5142 <code> 5143 <![CDATA[ 5144 <project default="build"> 5145 <property name="debug" value="false" /> 5146 <target name="init"> 5147 <echo message="initializing" /> 5148 </target> 5149 <target name="compile" depends="init"> 5150 <echo message="compiling with debug = ${debug}" /> 5151 </target> 5152 <target name="build"> 5153 <property name="debug" value="false" /> 5154 <call target="compile" /> 5155 <property name="debug" value="true" /> 5156 <call target="compile" /> 5157 </target> 5158 </project> 5159 ]]> 5160 </code> 5161 <para> 5162 The <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> parameter of the 5163 <see cref="T:NAnt.Core.Tasks.CallTask"/> defaults to <see langword="true"/>, 5164 causing the "init" target to be executed for both 5165 the "debug" and "release" build. 5166 </para> 5167 <para> 5168 This results in the following build log: 5169 </para> 5170 <code> 5171 build: 5172 5173 init: 5174 [echo] initializing 5175 5176 compile: 5177 5178 [echo] compiling with debug = false 5179 5180 init: 5181 5182 [echo] initializing 5183 5184 compile: 5185 5186 [echo] compiling with debug = true 5187 5188 BUILD SUCCEEDED 5189 </code> 5190 <para> 5191 If the "init" should only be executed once, set the 5192 <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute of the <see cref="T:NAnt.Core.Tasks.CallTask"/> 5193 to <see langword="false"/>. 5194 </para> 5195 <para> 5196 The build log would then look like this: 5197 </para> 5198 <code> 5199 build: 5200 5201 init: 5202 [echo] initializing 5203 5204 compile: 5205 5206 [echo] compiling with debug = false 5207 5208 compile: 5209 5210 [echo] compiling with debug = true 5211 5212 BUILD SUCCEEDED 5213 </code> 5214 </example> 5215 </member> 5216 <member name="M:NAnt.Core.Tasks.CallTask.ExecuteTask"> 5217 <summary> 5218 Executes the specified target. 5219 </summary> 5220 </member> 5221 <member name="M:NAnt.Core.Tasks.CallTask.Initialize"> 5222 <summary> 5223 Makes sure the <see cref="T:NAnt.Core.Tasks.CallTask"/> is not calling its own 5224 parent. 5225 </summary> 5226 </member> 5227 <member name="P:NAnt.Core.Tasks.CallTask.TargetName"> 5228 <summary> 5229 NAnt target to call. 5230 </summary> 5231 </member> 5232 <member name="P:NAnt.Core.Tasks.CallTask.ForceExecute"> 5233 <summary> 5234 Force an execute even if the target has already been executed. The 5235 default is <see langword="false" />. 5236 </summary> 5237 </member> 5238 <member name="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"> 5239 <summary> 5240 Execute the specified targets dependencies -- even if they have been 5241 previously executed. The default is <see langword="true" />. 5242 </summary> 5243 </member> 5244 <member name="T:NAnt.Core.Tasks.CopyTask"> 5245 <summary> 5246 Copies a file or set of files to a new file or directory. 5247 </summary> 5248 <remarks> 5249 <para> 5250 Files are only copied if the source file is newer than the destination 5251 file, or if the destination file does not exist. However, you can 5252 explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/> attribute. 5253 </para> 5254 <para> 5255 When a <see cref="T:NAnt.Core.Types.FileSet"/> is used to select files to copy, the 5256 <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set. Files that are 5257 located under the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/> will 5258 be copied to a directory under the destination directory matching the 5259 path relative to the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/>, 5260 unless the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/> attribute is set to 5261 <see langword="true"/>. 5262 </para> 5263 <para> 5264 Files that are not located under the the base directory of the 5265 <see cref="T:NAnt.Core.Types.FileSet"/> will be copied directly under to the destination 5266 directory, regardless of the value of the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/> 5267 attribute. 5268 </para> 5269 <h4>Encoding</h4> 5270 <para> 5271 Unless an encoding is specified, the encoding associated with the 5272 system's current ANSI code page is used. 5273 </para> 5274 <para> 5275 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text 5276 file is automatically recognized, if the file starts with the 5277 appropriate byte order marks. 5278 </para> 5279 <note> 5280 If you employ filters in your copy operation, you should limit the copy 5281 to text files. Binary files will be corrupted by the copy operation. 5282 </note> 5283 </remarks> 5284 <example> 5285 <para> 5286 Copy a single file while changing its encoding from "latin1" to 5287 "utf-8". 5288 </para> 5289 <code> 5290 <![CDATA[ 5291 <copy 5292 file="myfile.txt" 5293 tofile="mycopy.txt" 5294 inputencoding="latin1" 5295 outputencoding="utf-8" /> 5296 ]]> 5297 </code> 5298 </example> 5299 <example> 5300 <para>Copy a set of files to a new directory.</para> 5301 <code> 5302 <![CDATA[ 5303 <copy todir="${build.dir}"> 5304 <fileset basedir="bin"> 5305 <include name="*.dll" /> 5306 </fileset> 5307 </copy> 5308 ]]> 5309 </code> 5310 </example> 5311 <example> 5312 <para> 5313 Copy a set of files to a directory, replacing <c>@TITLE@</c> with 5314 "Foo Bar" in all files. 5315 </para> 5316 <code> 5317 <![CDATA[ 5318 <copy todir="../backup/dir"> 5319 <fileset basedir="src_dir"> 5320 <include name="**/*" /> 5321 </fileset> 5322 <filterchain> 5323 <replacetokens> 5324 <token key="TITLE" value="Foo Bar" /> 5325 </replacetokens> 5326 </filterchain> 5327 </copy> 5328 ]]> 5329 </code> 5330 </example> 5331 </member> 5332 <member name="M:NAnt.Core.Tasks.CopyTask.#ctor"> 5333 <summary> 5334 Initialize new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>. 5335 </summary> 5336 </member> 5337 <member name="M:NAnt.Core.Tasks.CopyTask.Initialize"> 5338 <summary> 5339 Checks whether the task is initialized with valid attributes. 5340 </summary> 5341 </member> 5342 <member name="M:NAnt.Core.Tasks.CopyTask.ExecuteTask"> 5343 <summary> 5344 Executes the Copy task. 5345 </summary> 5346 <exception cref="T:NAnt.Core.BuildException">A file that has to be copied does not exist or could not be copied.</exception> 5347 </member> 5348 <member name="M:NAnt.Core.Tasks.CopyTask.DoFileOperations"> 5349 <summary> 5350 Actually does the file copies. 5351 </summary> 5352 </member> 5353 <member name="P:NAnt.Core.Tasks.CopyTask.SourceFile"> 5354 <summary> 5355 The file to copy. 5356 </summary> 5357 </member> 5358 <member name="P:NAnt.Core.Tasks.CopyTask.ToFile"> 5359 <summary> 5360 The file to copy to. 5361 </summary> 5362 </member> 5363 <member name="P:NAnt.Core.Tasks.CopyTask.ToDirectory"> 5364 <summary> 5365 The directory to copy to. 5366 </summary> 5367 </member> 5368 <member name="P:NAnt.Core.Tasks.CopyTask.Overwrite"> 5369 <summary> 5370 Overwrite existing files even if the destination files are newer. 5371 The default is <see langword="false" />. 5372 </summary> 5373 </member> 5374 <member name="P:NAnt.Core.Tasks.CopyTask.Flatten"> 5375 <summary> 5376 Ignore directory structure of source directory, copy all files into 5377 a single directory, specified by the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> 5378 attribute. The default is <see langword="false"/>. 5379 </summary> 5380 </member> 5381 <member name="P:NAnt.Core.Tasks.CopyTask.IncludeEmptyDirs"> 5382 <summary> 5383 Copy any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>. 5384 The default is <see langword="true"/>. 5385 </summary> 5386 </member> 5387 <member name="P:NAnt.Core.Tasks.CopyTask.CopyFileSet"> 5388 <summary> 5389 Used to select the files to copy. To use a <see cref="T:NAnt.Core.Types.FileSet"/>, 5390 the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set. 5391 </summary> 5392 </member> 5393 <member name="P:NAnt.Core.Tasks.CopyTask.Filters"> 5394 <summary> 5395 Chain of filters used to alter the file's content as it is copied. 5396 </summary> 5397 </member> 5398 <member name="P:NAnt.Core.Tasks.CopyTask.InputEncoding"> 5399 <summary> 5400 The encoding to use when reading files. The default is the system's 5401 current ANSI code page. 5402 </summary> 5403 </member> 5404 <member name="P:NAnt.Core.Tasks.CopyTask.OutputEncoding"> 5405 <summary> 5406 The encoding to use when writing the files. The default is 5407 the encoding of the input file. 5408 </summary> 5409 </member> 5410 <member name="P:NAnt.Core.Tasks.CopyTask.FileCopyMap"> 5411 <summary> 5412 The set of files to perform a file operation on. 5413 </summary> 5414 <remarks> 5415 <para> 5416 The key of the <see cref="T:System.Collections.Hashtable"/> is the absolute path of 5417 the destination file and the value is a <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/> 5418 holding the path and last write time of the most recently updated 5419 source file that is selected to be copied or moved to the 5420 destination file. 5421 </para> 5422 <para> 5423 On Windows, the <see cref="T:System.Collections.Hashtable"/> is case-insensitive. 5424 </para> 5425 </remarks> 5426 </member> 5427 <member name="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"> 5428 <summary> 5429 Holds the absolute paths and last write time of a given file. 5430 </summary> 5431 </member> 5432 <member name="M:NAnt.Core.Tasks.CopyTask.FileDateInfo.#ctor(System.String,System.DateTime)"> 5433 <summary> 5434 Initializes a new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/> 5435 class for the specified file and last write time. 5436 </summary> 5437 <param name="path">The absolute path of the file.</param> 5438 <param name="lastWriteTime">The last write time of the file.</param> 5439 </member> 5440 <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.Path"> 5441 <summary> 5442 Gets the absolute path of the current file. 5443 </summary> 5444 <value> 5445 The absolute path of the current file. 5446 </value> 5447 </member> 5448 <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.LastWriteTime"> 5449 <summary> 5450 Gets the time when the current file was last written to. 5451 </summary> 5452 <value> 5453 The time when the current file was last written to. 5454 </value> 5455 </member> 5456 <member name="T:NAnt.Core.Tasks.DeleteTask"> 5457 <summary> 5458 Deletes a file, fileset or directory. 5459 </summary> 5460 <remarks> 5461 <para> 5462 Deletes either a single file, all files in a specified directory and 5463 its sub-directories, or a set of files specified by one or more filesets. 5464 </para> 5465 <para> 5466 If the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> or <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/> attribute is 5467 set then the fileset contents will be ignored. To delete the files 5468 in the fileset ommit the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> and <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/> 5469 attributes in the <c><delete></c> element. 5470 </para> 5471 <para> 5472 If the specified file or directory does not exist, no error is 5473 reported. 5474 </para> 5475 <note> 5476 Read-only files cannot be deleted. Use the <see cref="T:NAnt.Core.Tasks.AttribTask"/> 5477 first to remove the read-only attribute. 5478 </note> 5479 </remarks> 5480 <example> 5481 <para>Delete a single file.</para> 5482 <code> 5483 <![CDATA[ 5484 <delete file="myfile.txt" /> 5485 ]]> 5486 </code> 5487 </example> 5488 <example> 5489 <para> 5490 Delete a directory and the contents within. If the directory does not 5491 exist, no error is reported. 5492 </para> 5493 <code> 5494 <![CDATA[ 5495 <delete dir="${build.dir}" /> 5496 ]]> 5497 </code> 5498 </example> 5499 <example> 5500 <para> 5501 Delete a set of files. 5502 </para> 5503 <code> 5504 <![CDATA[ 5505 <delete> 5506 <fileset> 5507 <include name="${basename}-??.exe" /> 5508 <include name="${basename}-??.pdb" /> 5509 </fileset> 5510 </delete> 5511 ]]> 5512 </code> 5513 </example> 5514 </member> 5515 <member name="M:NAnt.Core.Tasks.DeleteTask.Initialize"> 5516 <summary> 5517 Ensures the supplied attributes are valid. 5518 </summary> 5519 </member> 5520 <member name="P:NAnt.Core.Tasks.DeleteTask.File"> 5521 <summary> 5522 The file to delete. 5523 </summary> 5524 </member> 5525 <member name="P:NAnt.Core.Tasks.DeleteTask.Directory"> 5526 <summary> 5527 The directory to delete. 5528 </summary> 5529 </member> 5530 <member name="P:NAnt.Core.Tasks.DeleteTask.IncludeEmptyDirs"> 5531 <summary> 5532 Remove any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>. 5533 The default is <see langword="true"/>. 5534 </summary> 5535 </member> 5536 <member name="P:NAnt.Core.Tasks.DeleteTask.DeleteFileSet"> 5537 <summary> 5538 All the files in the file set will be deleted. 5539 </summary> 5540 </member> 5541 <member name="P:NAnt.Core.Tasks.DeleteTask.Verbose"> 5542 <summary> 5543 Controls whether to show the name of each deleted file or directory. 5544 The default is <see langword="false" />. 5545 </summary> 5546 </member> 5547 <member name="T:NAnt.Core.Tasks.DescriptionTask"> 5548 <summary> 5549 An empty task that allows a build file to contain a description. 5550 </summary> 5551 <example> 5552 <para>Set a description.</para> 5553 <code> 5554 <![CDATA[ 5555 <description>This is a description.</description> 5556 ]]> 5557 </code> 5558 </example> 5559 </member> 5560 <member name="T:NAnt.Core.Tasks.EchoTask"> 5561 <summary> 5562 Writes a message to the build log or a specified file. 5563 </summary> 5564 <remarks> 5565 <para> 5566 The message can be specified using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute 5567 or as inline content. If neither is included - or the message contains 5568 only whitespace - then an empty message will be emitted in the output. 5569 </para> 5570 <para> 5571 Macros in the message will be expanded. 5572 </para> 5573 <para> 5574 When writing to a file, the <see cref="P:NAnt.Core.Tasks.EchoTask.MessageLevel"/> attribute is 5575 ignored. 5576 </para> 5577 <note> 5578 Since NAnt 0.86, a newline will no longer be implictly added when 5579 writing a message to a file. 5580 </note> 5581 </remarks> 5582 <example> 5583 <para> 5584 Writes a message with level <see cref="F:NAnt.Core.Level.Debug"/> to the build log. 5585 </para> 5586 <code> 5587 <![CDATA[ 5588 <echo message="Hello, World!" level="Debug" /> 5589 ]]> 5590 </code> 5591 </example> 5592 <example> 5593 <para> 5594 Writes a two-line message to the build log using inline content. 5595 </para> 5596 <code> 5597 <![CDATA[ 5598 <echo>First line 5599 Second line</echo> 5600 ]]> 5601 </code> 5602 </example> 5603 <example> 5604 <para> 5605 Writes a two-line message to the build log using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute. 5606 </para> 5607 <code> 5608 <![CDATA[ 5609 <echo message='First line 5610 Second line</echo> 5611 ]]> 5612 </code> 5613 </example> 5614 <example> 5615 <para> 5616 Writes a message with expanded macro to the build log. 5617 </para> 5618 <code> 5619 <![CDATA[ 5620 <echo message="Base build directory = ${nant.project.basedir}" /> 5621 ]]> 5622 </code> 5623 </example> 5624 <example> 5625 <para> 5626 Functionally equivalent to the previous example. 5627 </para> 5628 <code> 5629 <![CDATA[ 5630 <echo>Base build directory = ${nant.project.basedir}</echo> 5631 ]]> 5632 </code> 5633 </example> 5634 <example> 5635 <para> 5636 Writes the previous message to a file in the project directory, 5637 overwriting the file if it exists. 5638 </para> 5639 <code> 5640 <![CDATA[ 5641 <echo file="buildmessage.txt">Base build directory = ${nant.project.basedir}</echo> 5642 ]]> 5643 </code> 5644 </example> 5645 </member> 5646 <member name="M:NAnt.Core.Tasks.EchoTask.ExecuteTask"> 5647 <summary> 5648 Outputs the message to the build log or the specified file. 5649 </summary> 5650 </member> 5651 <member name="P:NAnt.Core.Tasks.EchoTask.Encoding"> 5652 <summary> 5653 The encoding to use when writing message to a file. The default is 5654 UTF-8 encoding without a Byte Order Mark (BOM). 5655 </summary> 5656 </member> 5657 <member name="P:NAnt.Core.Tasks.EchoTask.Message"> 5658 <summary> 5659 The message to output. 5660 </summary> 5661 </member> 5662 <member name="P:NAnt.Core.Tasks.EchoTask.Contents"> 5663 <summary> 5664 Gets or sets the inline content that should be output. 5665 </summary> 5666 <value> 5667 The inline content that should be output. 5668 </value> 5669 </member> 5670 <member name="P:NAnt.Core.Tasks.EchoTask.File"> 5671 <summary> 5672 The file to write the message to. 5673 </summary> 5674 </member> 5675 <member name="P:NAnt.Core.Tasks.EchoTask.Append"> 5676 <summary> 5677 Determines whether the <see cref="T:NAnt.Core.Tasks.EchoTask"/> should append to the 5678 file, or overwrite it. By default, the file will be overwritten. 5679 </summary> 5680 <value> 5681 <see langword="true"/> if output should be appended to the file; 5682 otherwise, <see langword="false"/>. The default is 5683 <see langword="false"/>. 5684 </value> 5685 </member> 5686 <member name="P:NAnt.Core.Tasks.EchoTask.MessageLevel"> 5687 <summary> 5688 The logging level with which the message should be output. The default 5689 is <see cref="F:NAnt.Core.Level.Info"/>. 5690 </summary> 5691 </member> 5692 <member name="T:NAnt.Core.Tasks.ExecTask"> 5693 <summary> 5694 Executes a system command. 5695 </summary> 5696 <remarks> 5697 <para> 5698 Use of nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> element(s) 5699 is advised over the <see cref="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments"/> parameter, as 5700 it supports automatic quoting and can resolve relative to absolute 5701 paths. 5702 </para> 5703 </remarks> 5704 <example> 5705 <para>Ping "nant.sourceforge.net".</para> 5706 <code> 5707 <![CDATA[ 5708 <exec program="ping"> 5709 <arg value="nant.sourceforge.net" /> 5710 </exec> 5711 ]]> 5712 </code> 5713 </example> 5714 <example> 5715 <para> 5716 Execute a java application using <c>IKVM.NET</c> that requires the 5717 Apache FOP jars, and a set of custom jars. 5718 </para> 5719 <code> 5720 <![CDATA[ 5721 <path id="fop-classpath"> 5722 <pathelement file="${fop.dist.dir}/build/fop.jar" /> 5723 <pathelement file="${fop.dist.dir}/lib/xercesImpl-2.2.1.jar" /> 5724 <pathelement file="${fop.dist.dir}/lib/avalon-framework-cvs-20020806.jar" /> 5725 <pathelement file="${fop.dist.dir}/lib/batik.jar" /> 5726 </path> 5727 <exec program="ikvm.exe" useruntimeengine="true"> 5728 <arg value="-cp" /> 5729 <arg> 5730 <path> 5731 <pathelement dir="conf" /> 5732 <path refid="fop-classpath" /> 5733 <pathelement file="lib/mylib.jar" /> 5734 <pathelement file="lib/otherlib.zip" /> 5735 </path> 5736 </arg> 5737 <arg value="org.me.MyProg" /> 5738 </exec> 5739 ]]> 5740 </code> 5741 <para> 5742 Assuming the base directory of the build file is "c:\ikvm-test" and 5743 the value of the "fop.dist.dir" property is "c:\fop", then the value 5744 of the <c>-cp</c> argument that is passed to<c>ikvm.exe</c> is 5745 "c:\ikvm-test\conf;c:\fop\build\fop.jar;conf;c:\fop\lib\xercesImpl-2.2.1.jar;c:\fop\lib\avalon-framework-cvs-20020806.jar;c:\fop\lib\batik.jar;c:\ikvm-test\lib\mylib.jar;c:\ikvm-test\lib\otherlib.zip" 5746 on a DOS-based system. 5747 </para> 5748 </example> 5749 </member> 5750 <member name="T:NAnt.Core.Tasks.ExternalProgramBase"> 5751 <summary> 5752 Provides the abstract base class for tasks that execute external applications. 5753 </summary> 5754 <remarks> 5755 <para> 5756 When a <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/> is applied to the 5757 deriving class and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName"/> does not return an 5758 absolute path, then the program to execute will first be searched for 5759 in the location specified by <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/>. 5760 </para> 5761 <para> 5762 If the program does not exist in that location, then the list of tool 5763 paths of the current target framework will be scanned in the order in 5764 which they are defined in the NAnt configuration file. 5765 </para> 5766 </remarks> 5767 </member> 5768 <member name="F:NAnt.Core.Tasks.ExternalProgramBase.UnknownExitCode"> 5769 <summary> 5770 Defines the exit code that will be returned by <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode"/> 5771 if the process could not be started, or did not exit (in time). 5772 </summary> 5773 </member> 5774 <member name="F:NAnt.Core.Tasks.ExternalProgramBase._lockObject"> 5775 <summary> 5776 Will be used to ensure thread-safe operations. 5777 </summary> 5778 </member> 5779 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.ExecuteTask"> 5780 <summary> 5781 Starts the external process and captures its output. 5782 </summary> 5783 <exception cref="T:NAnt.Core.BuildException"> 5784 <para>The external process did not finish within the configured timeout.</para> 5785 <para>-or-</para> 5786 <para>The exit code of the external process indicates a failure.</para> 5787 </exception> 5788 </member> 5789 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.PrepareProcess(System.Diagnostics.Process)"> 5790 <summary> 5791 Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified 5792 <see cref="T:System.Diagnostics.Process"/>. 5793 </summary> 5794 <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param> 5795 </member> 5796 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StartProcess"> 5797 <summary> 5798 Starts the process and handles errors. 5799 </summary> 5800 <returns>The <see cref="T:System.Diagnostics.Process"/> that was started.</returns> 5801 </member> 5802 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Output"> 5803 <summary> 5804 Reads from the stream until the external program is ended. 5805 </summary> 5806 </member> 5807 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Error"> 5808 <summary> 5809 Reads from the stream until the external program is ended. 5810 </summary> 5811 </member> 5812 <member name="M:NAnt.Core.Tasks.ExternalProgramBase.DetermineFilePath"> 5813 <summary> 5814 Determines the path of the external program that should be executed. 5815 </summary> 5816 <returns> 5817 A fully qualifies pathname including the program name. 5818 </returns> 5819 <exception cref="T:NAnt.Core.BuildException">The task is not available or not configured for the current framework.</exception> 5820 </member> 5821 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName"> 5822 <summary> 5823 The name of the executable that should be used to launch the 5824 external program. 5825 </summary> 5826 <value> 5827 The name of the executable that should be used to launch the external 5828 program, or <see langword="null" /> if no name is specified. 5829 </value> 5830 <remarks> 5831 If available, the configured value in the NAnt configuration 5832 file will be used if no name is specified. 5833 </remarks> 5834 </member> 5835 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramFileName"> 5836 <summary> 5837 Gets the filename of the external program to start. 5838 </summary> 5839 <value> 5840 The filename of the external program. 5841 </value> 5842 <remarks> 5843 Override in derived classes to explicitly set the location of the 5844 external tool. 5845 </remarks> 5846 </member> 5847 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramArguments"> 5848 <summary> 5849 Gets the command-line arguments for the external program. 5850 </summary> 5851 <value> 5852 The command-line arguments for the external program. 5853 </value> 5854 </member> 5855 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Output"> 5856 <summary> 5857 Gets the file to which the standard output should be redirected. 5858 </summary> 5859 <value> 5860 The file to which the standard output should be redirected, or 5861 <see langword="null" /> if the standard output should not be 5862 redirected. 5863 </value> 5864 <remarks> 5865 The default implementation will never allow the standard output 5866 to be redirected to a file. Deriving classes should override this 5867 property to change this behaviour. 5868 </remarks> 5869 </member> 5870 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputAppend"> 5871 <summary> 5872 Gets a value indicating whether output will be appended to the 5873 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>. 5874 </summary> 5875 <value> 5876 <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>; 5877 otherwise, <see langword="false"/>. 5878 </value> 5879 </member> 5880 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.BaseDirectory"> 5881 <summary> 5882 Gets the working directory for the application. 5883 </summary> 5884 <value> 5885 The working directory for the application. 5886 </value> 5887 </member> 5888 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.TimeOut"> 5889 <summary> 5890 The maximum amount of time the application is allowed to execute, 5891 expressed in milliseconds. Defaults to no time-out. 5892 </summary> 5893 </member> 5894 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"> 5895 <summary> 5896 The command-line arguments for the external program. 5897 </summary> 5898 </member> 5899 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"> 5900 <summary> 5901 Specifies whether the external program is a managed application 5902 which should be executed using a runtime engine, if configured. 5903 The default is <see langword="false"/>. 5904 </summary> 5905 <value> 5906 <see langword="true"/> if the external program should be executed 5907 using a runtime engine; otherwise, <see langword="false"/>. 5908 </value> 5909 <remarks> 5910 <para> 5911 The value of <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is only used from 5912 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/>, and then only if its value is set to 5913 <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>. In which case 5914 <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> returns <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/> 5915 if <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is <see langword="true"/>. 5916 </para> 5917 <para> 5918 In all other cases, the value of <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> 5919 is ignored. 5920 </para> 5921 </remarks> 5922 </member> 5923 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"> 5924 <summary> 5925 Specifies whether the external program should be treated as a managed 5926 application, possibly forcing it to be executed under the currently 5927 targeted version of the CLR. 5928 </summary> 5929 <value> 5930 A <see cref="T:NAnt.Core.Types.ManagedExecution"/> indicating how the program should 5931 be treated. 5932 </value> 5933 <remarks> 5934 <para> 5935 If <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> is set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>, 5936 which is the default value, and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is 5937 <see langword="true"/> then <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/> 5938 is returned. 5939 </para> 5940 <para> 5941 When the changing <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Managed"/> to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>, 5942 then <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine"/> is set to <see langword="false"/>; 5943 otherwise, it is changed to <see langword="true"/>. 5944 </para> 5945 </remarks> 5946 </member> 5947 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputWriter"> 5948 <summary> 5949 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which standard output 5950 messages of the external program will be written. 5951 </summary> 5952 <value> 5953 The <see cref="T:System.IO.TextWriter"/> to which standard output messages of 5954 the external program will be written. 5955 </value> 5956 <remarks> 5957 By default, standard output messages wil be written to the build log 5958 with level <see cref="F:NAnt.Core.Level.Info"/>. 5959 </remarks> 5960 </member> 5961 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ErrorWriter"> 5962 <summary> 5963 Gets or sets the <see cref="T:System.IO.TextWriter"/> to which error output 5964 of the external program will be written. 5965 </summary> 5966 <value> 5967 The <see cref="T:System.IO.TextWriter"/> to which error output of the external 5968 program will be written. 5969 </value> 5970 <remarks> 5971 By default, error output wil be written to the build log with level 5972 <see cref="F:NAnt.Core.Level.Warning"/>. 5973 </remarks> 5974 </member> 5975 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode"> 5976 <summary> 5977 Gets the value that the process specified when it terminated. 5978 </summary> 5979 <value> 5980 The code that the associated process specified when it terminated, 5981 or <c>-1000</c> if the process could not be started or did not 5982 exit (in time). 5983 </value> 5984 </member> 5985 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProcessId"> 5986 <summary> 5987 Gets the unique identifier for the spawned application. 5988 </summary> 5989 </member> 5990 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Spawn"> 5991 <summary> 5992 Gets or sets a value indicating whether the application should be 5993 spawned. If you spawn an application, its output will not be logged 5994 by NAnt. The default is <see langword="false" />. 5995 </summary> 5996 </member> 5997 <member name="P:NAnt.Core.Tasks.ExternalProgramBase.CommandLine"> 5998 <summary> 5999 Gets the command-line arguments, separated by spaces. 6000 </summary> 6001 </member> 6002 <member name="M:NAnt.Core.Tasks.ExecTask.Initialize"> 6003 <summary> 6004 Performs additional checks after the task has been initialized. 6005 </summary> 6006 <exception cref="T:NAnt.Core.BuildException"><see cref="P:NAnt.Core.Tasks.ExecTask.FileName"/> does not hold a valid file name.</exception> 6007 </member> 6008 <member name="M:NAnt.Core.Tasks.ExecTask.ExecuteTask"> 6009 <summary> 6010 Executes the external program. 6011 </summary> 6012 </member> 6013 <member name="P:NAnt.Core.Tasks.ExecTask.FileName"> 6014 <summary> 6015 The program to execute without command arguments. 6016 </summary> 6017 <remarks> 6018 The path will not be evaluated to a full path using the project 6019 base directory. 6020 </remarks> 6021 </member> 6022 <member name="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments"> 6023 <summary> 6024 The command-line arguments for the program. These will be 6025 passed as is to the external program. When quoting is necessary, 6026 these must be explictly set as part of the value. Consider using 6027 nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> elements instead. 6028 </summary> 6029 </member> 6030 <member name="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet"> 6031 <summary> 6032 Environment variables to pass to the program. 6033 </summary> 6034 </member> 6035 <member name="P:NAnt.Core.Tasks.ExecTask.WorkingDirectory"> 6036 <summary> 6037 The directory in which the command will be executed. 6038 </summary> 6039 <value> 6040 The directory in which the command will be executed. The default 6041 is the project's base directory. 6042 </value> 6043 <remarks> 6044 <para> 6045 The working directory will be evaluated relative to the project's 6046 base directory if it is relative. 6047 </para> 6048 </remarks> 6049 </member> 6050 <member name="P:NAnt.Core.Tasks.ExecTask.ResultProperty"> 6051 <summary> 6052 <para> 6053 The name of a property in which the exit code of the program should 6054 be stored. Only of interest if <see cref="P:NAnt.Core.Task.FailOnError"/> is 6055 <see langword="false"/>. 6056 </para> 6057 <para> 6058 If the exit code of the program is "-1000" then the program could 6059 not be started, or did not exit (in time). 6060 </para> 6061 </summary> 6062 </member> 6063 <member name="P:NAnt.Core.Tasks.ExecTask.UseRuntimeEngine"> 6064 <summary> 6065 Specifies whether the external program should be executed using a 6066 runtime engine, if configured. The default is <see langword="false" />. 6067 </summary> 6068 <value> 6069 <see langword="true" /> if the external program should be executed 6070 using a runtime engine; otherwise, <see langword="false" />. 6071 </value> 6072 </member> 6073 <member name="P:NAnt.Core.Tasks.ExecTask.Managed"> 6074 <summary> 6075 Specifies whether the external program is a managed application 6076 which should be executed using a runtime engine, if configured. 6077 The default is <see langword="false" />. 6078 </summary> 6079 <value> 6080 <see langword="true" /> if the external program should be executed 6081 using a runtime engine; otherwise, <see langword="false" />. 6082 </value> 6083 </member> 6084 <member name="P:NAnt.Core.Tasks.ExecTask.ProgramFileName"> 6085 <summary> 6086 Gets the filename of the external program to start. 6087 </summary> 6088 <value> 6089 The filename of the external program. 6090 </value> 6091 </member> 6092 <member name="P:NAnt.Core.Tasks.ExecTask.ProgramArguments"> 6093 <summary> 6094 Gets the command-line arguments for the external program. 6095 </summary> 6096 <value> 6097 The command-line arguments for the external program. 6098 </value> 6099 </member> 6100 <member name="P:NAnt.Core.Tasks.ExecTask.BaseDirectory"> 6101 <summary> 6102 The directory the program is in. 6103 </summary> 6104 <remarks> 6105 <value> 6106 The directory the program is in. The default is the project's base 6107 directory. 6108 </value> 6109 <para> 6110 The basedir will be evaluated relative to the project's base 6111 directory if it is relative. 6112 </para> 6113 </remarks> 6114 </member> 6115 <member name="P:NAnt.Core.Tasks.ExecTask.Output"> 6116 <summary> 6117 The file to which the standard output will be redirected. 6118 </summary> 6119 <remarks> 6120 By default, the standard output is redirected to the console. 6121 </remarks> 6122 </member> 6123 <member name="P:NAnt.Core.Tasks.ExecTask.OutputAppend"> 6124 <summary> 6125 Gets or sets a value indicating whether output should be appended 6126 to the output file. The default is <see langword="false"/>. 6127 </summary> 6128 <value> 6129 <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExecTask.Output"/>; 6130 otherwise, <see langword="false"/>. 6131 </value> 6132 </member> 6133 <member name="P:NAnt.Core.Tasks.ExecTask.Spawn"> 6134 <summary> 6135 Gets or sets a value indicating whether the application should be 6136 spawned. If you spawn an application, its output will not be logged 6137 by NAnt. The default is <see langword="false" />. 6138 </summary> 6139 </member> 6140 <member name="P:NAnt.Core.Tasks.ExecTask.ProcessIdProperty"> 6141 <summary> 6142 The name of a property in which the unique identifier of the spawned 6143 application should be stored. Only of interest if <see cref="P:NAnt.Core.Tasks.ExecTask.Spawn"/> 6144 is <see langword="true"/>. 6145 </summary> 6146 </member> 6147 <member name="T:NAnt.Core.Tasks.FailTask"> 6148 <summary> 6149 Exits the current build by throwing a <see cref="T:NAnt.Core.BuildException"/>, 6150 optionally printing additional information. 6151 </summary> 6152 <remarks> 6153 <para> 6154 The cause of the build failure can be specified using the <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> 6155 attribute or as inline content. 6156 </para> 6157 <para> 6158 Macros in the message will be expanded. 6159 </para> 6160 </remarks> 6161 <example> 6162 <para>Exits the current build without giving further information.</para> 6163 <code> 6164 <![CDATA[ 6165 <fail /> 6166 ]]> 6167 </code> 6168 </example> 6169 <example> 6170 <para>Exits the current build and writes a message to the build log.</para> 6171 <code> 6172 <![CDATA[ 6173 <fail message="Something wrong here." /> 6174 ]]> 6175 </code> 6176 </example> 6177 <example> 6178 <para>Functionally equivalent to the previous example.</para> 6179 <code> 6180 <![CDATA[ 6181 <fail>Something wrong here.</fail> 6182 ]]> 6183 </code> 6184 </example> 6185 </member> 6186 <member name="P:NAnt.Core.Tasks.FailTask.Message"> 6187 <summary> 6188 A message giving further information on why the build exited. 6189 </summary> 6190 <remarks> 6191 Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive. 6192 </remarks> 6193 </member> 6194 <member name="P:NAnt.Core.Tasks.FailTask.Contents"> 6195 <summary> 6196 Gets or sets the inline content that should be output in the build 6197 log, giving further information on why the build exited. 6198 </summary> 6199 <value> 6200 The inline content that should be output in the build log. 6201 </value> 6202 <remarks> 6203 Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive. 6204 </remarks> 6205 </member> 6206 <member name="T:NAnt.Core.Tasks.GetTask"> 6207 <summary> 6208 Gets a particular file from a URL source. 6209 </summary> 6210 <remarks> 6211 <para> 6212 Options include verbose reporting and timestamp based fetches. 6213 </para> 6214 <para> 6215 Currently, only HTTP and UNC protocols are supported. FTP support may 6216 be added when more pluggable protocols are added to the System.Net 6217 assembly. 6218 </para> 6219 <para> 6220 The <see cref="P:NAnt.Core.Tasks.GetTask.UseTimeStamp"/> option enables you to control downloads 6221 so that the remote file is only fetched if newer than the local copy. 6222 If there is no local copy, the download always takes place. When a file 6223 is downloaded, the timestamp of the downloaded file is set to the remote 6224 timestamp. 6225 </para> 6226 <note> 6227 This timestamp facility only works on downloads using the HTTP protocol. 6228 </note> 6229 </remarks> 6230 <example> 6231 <para> 6232 Gets the index page of the NAnt home page, and stores it in the file 6233 <c>help/index.html</c> relative to the project base directory. 6234 </para> 6235 <code> 6236 <![CDATA[ 6237 <get src="http://nant.sourceforge.org/" dest="help/index.html" /> 6238 ]]> 6239 </code> 6240 </example> 6241 <example> 6242 <para> 6243 Gets the index page of a secured web site using the given credentials, 6244 while connecting using the specified password-protected proxy server. 6245 </para> 6246 <code> 6247 <![CDATA[ 6248 <get src="http://password.protected.site/index.html" dest="secure/index.html"> 6249 <credentials username="user" password="guess" domain="mydomain" /> 6250 <proxy host="proxy.company.com" port="8080"> 6251 <credentials username="proxyuser" password="dunno" /> 6252 </proxy> 6253 </get> 6254 ]]> 6255 </code> 6256 </example> 6257 </member> 6258 <member name="M:NAnt.Core.Tasks.GetTask.Initialize"> 6259 <summary> 6260 Initializes task and ensures the supplied attributes are valid. 6261 </summary> 6262 </member> 6263 <member name="M:NAnt.Core.Tasks.GetTask.ExecuteTask"> 6264 <summary> 6265 This is where the work is done 6266 </summary> 6267 </member> 6268 <member name="M:NAnt.Core.Tasks.GetTask.TouchFile(System.IO.FileInfo,System.DateTime)"> 6269 <summary> 6270 Sets the timestamp of a given file to a specified time. 6271 </summary> 6272 </member> 6273 <member name="P:NAnt.Core.Tasks.GetTask.Source"> 6274 <summary> 6275 The URL from which to retrieve a file. 6276 </summary> 6277 </member> 6278 <member name="P:NAnt.Core.Tasks.GetTask.DestinationFile"> 6279 <summary> 6280 The file where to store the retrieved file. 6281 </summary> 6282 </member> 6283 <member name="P:NAnt.Core.Tasks.GetTask.HttpProxy"> 6284 <summary> 6285 If inside a firewall, proxy server/port information 6286 Format: {proxy server name}:{port number} 6287 Example: proxy.mycompany.com:8080 6288 </summary> 6289 </member> 6290 <member name="P:NAnt.Core.Tasks.GetTask.Proxy"> 6291 <summary> 6292 The network proxy to use to access the Internet resource. 6293 </summary> 6294 </member> 6295 <member name="P:NAnt.Core.Tasks.GetTask.Credentials"> 6296 <summary> 6297 The network credentials used for authenticating the request with 6298 the Internet resource. 6299 </summary> 6300 </member> 6301 <member name="P:NAnt.Core.Tasks.GetTask.IgnoreErrors"> 6302 <summary> 6303 Log errors but don't treat as fatal. The default is <see langword="false" />. 6304 </summary> 6305 </member> 6306 <member name="P:NAnt.Core.Tasks.GetTask.UseTimeStamp"> 6307 <summary> 6308 Conditionally download a file based on the timestamp of the local 6309 copy. HTTP only. The default is <see langword="false" />. 6310 </summary> 6311 </member> 6312 <member name="P:NAnt.Core.Tasks.GetTask.Timeout"> 6313 <summary> 6314 The length of time, in milliseconds, until the request times out. 6315 The default is <c>100000</c> milliseconds. 6316 </summary> 6317 </member> 6318 <member name="P:NAnt.Core.Tasks.GetTask.Certificates"> 6319 <summary> 6320 The security certificates to associate with the request. 6321 </summary> 6322 </member> 6323 <member name="T:NAnt.Core.Tasks.IfTask"> 6324 <summary> 6325 Checks the conditional attributes and executes the children if 6326 <see langword="true"/>. 6327 </summary> 6328 <remarks> 6329 <para> 6330 If no conditions are checked, all child tasks are executed. 6331 </para> 6332 <para> 6333 If more than one attribute is used, they are &&'d. The first 6334 to fail stops the check. 6335 </para> 6336 <para> 6337 The order of condition evaluation is, <see cref="P:NAnt.Core.Tasks.IfTask.TargetNameExists"/>, 6338 <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameExists"/>, <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue"/>, 6339 <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>. 6340 </para> 6341 <note> 6342 instead of using the deprecated attributes, we advise you to use the 6343 following functions in combination with the <see cref="P:NAnt.Core.Tasks.IfTask.Test"/> 6344 attribute: 6345 </note> 6346 <list type="table"> 6347 <listheader> 6348 <term>Function</term> 6349 <description>Description</description> 6350 </listheader> 6351 <item> 6352 <term><see cref="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)"/></term> 6353 <description>Checks whether the specified property exists.</description> 6354 </item> 6355 <item> 6356 <term><see cref="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)"/></term> 6357 <description>Checks whether the specified target exists.</description> 6358 </item> 6359 </list> 6360 </remarks> 6361 <example> 6362 <para>Tests the value of a property using expressions.</para> 6363 <code> 6364 <![CDATA[ 6365 <if test="${build.configuration=='release'}"> 6366 <echo>Build release configuration</echo> 6367 </if> 6368 ]]> 6369 </code> 6370 </example> 6371 <example> 6372 <para>Tests the the output of a function.</para> 6373 <code> 6374 <![CDATA[ 6375 <if test="${not file::exists(filename) or file::get-length(filename) = 0}"> 6376 <echo message="The version file ${filename} doesn't exist or is empty!" /> 6377 </if> 6378 ]]> 6379 </code> 6380 </example> 6381 <example> 6382 <para><c>(Deprecated)</c> Check that a target exists.</para> 6383 <code> 6384 <![CDATA[ 6385 <target name="myTarget" /> 6386 <if targetexists="myTarget"> 6387 <echo message="myTarget exists" /> 6388 </if> 6389 ]]> 6390 </code> 6391 </example> 6392 <example> 6393 <para><c>(Deprecated)</c> Check existence of a property.</para> 6394 <code> 6395 <![CDATA[ 6396 <if propertyexists="myProp"> 6397 <echo message="myProp Exists. Value='${myProp}'" /> 6398 </if> 6399 ]]> 6400 </code> 6401 </example> 6402 <example> 6403 <para><c>(Deprecated)</c> Check that a property value is true.</para> 6404 <code> 6405 <![CDATA[ 6406 <if propertytrue="myProp"> 6407 <echo message="myProp is true. Value='${myProp}'" /> 6408 </if> 6409 ]]> 6410 </code> 6411 </example> 6412 <example> 6413 <para> 6414 <c>(Deprecated)</c> Check that a property exists and is <see langword="true"/> 6415 (uses multiple conditions). 6416 </para> 6417 <code> 6418 <![CDATA[ 6419 <if propertyexists="myProp" propertytrue="myProp"> 6420 <echo message="myProp is '${myProp}'" /> 6421 </if> 6422 ]]> 6423 </code> 6424 <para>which is the same as</para> 6425 <code> 6426 <![CDATA[ 6427 <if propertyexists="myProp"> 6428 <if propertytrue="myProp"> 6429 <echo message="myProp is '${myProp}'" /> 6430 </if> 6431 </if> 6432 ]]> 6433 </code> 6434 </example> 6435 <example> 6436 <para> 6437 <c>(Deprecated)</c> Check file dates. If <c>myfile.dll</c> is uptodate, 6438 then do stuff. 6439 </para> 6440 <code> 6441 <![CDATA[ 6442 <if uptodatefile="myfile.dll" comparefile="myfile.cs"> 6443 <echo message="myfile.dll is newer/same-date as myfile.cs" /> 6444 </if> 6445 ]]> 6446 </code> 6447 <para>or</para> 6448 <code> 6449 <![CDATA[ 6450 <if uptodatefile="myfile.dll"> 6451 <comparefiles> 6452 <include name="*.cs" /> 6453 </comparefiles> 6454 <echo message="myfile.dll is newer/same-date as myfile.cs" /> 6455 </if> 6456 ]]> 6457 </code> 6458 <para>or</para> 6459 <code> 6460 <![CDATA[ 6461 <if> 6462 <uptodatefiles> 6463 <include name="myfile.dll" /> 6464 </uptodatefiles> 6465 <comparefiles> 6466 <include name="*.cs" /> 6467 </comparefiles> 6468 <echo message="myfile.dll is newer/same-date as myfile.cs" /> 6469 </if> 6470 ]]> 6471 </code> 6472 </example> 6473 </member> 6474 <member name="T:NAnt.Core.TaskContainer"> 6475 <summary> 6476 Executes embedded tasks in the order in which they are defined. 6477 </summary> 6478 </member> 6479 <member name="M:NAnt.Core.TaskContainer.Initialize"> 6480 <summary> 6481 Automatically exclude build elements that are defined on the task 6482 from things that get executed, as they are evaluated normally during 6483 XML task initialization. 6484 </summary> 6485 </member> 6486 <member name="M:NAnt.Core.TaskContainer.ExecuteChildTasks"> 6487 <summary> 6488 Creates and executes the embedded (child XML nodes) elements. 6489 </summary> 6490 <remarks> 6491 Skips any element defined by the host <see cref="T:NAnt.Core.Task"/> that has 6492 a <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> defined. 6493 </remarks> 6494 </member> 6495 <member name="P:NAnt.Core.TaskContainer.CustomXmlProcessing"> 6496 <summary> 6497 Gets a value indicating whether the element is performing additional 6498 processing using the <see cref="T:System.Xml.XmlNode"/> that was use to 6499 initialize the element. 6500 </summary> 6501 <value> 6502 <see langword="true"/>, as a <see cref="T:NAnt.Core.TaskContainer"/> is 6503 responsable for creating tasks from the nested build elements. 6504 </value> 6505 </member> 6506 <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFile"> 6507 <summary> 6508 The file to compare if uptodate. 6509 </summary> 6510 </member> 6511 <member name="P:NAnt.Core.Tasks.IfTask.CompareFile"> 6512 <summary> 6513 The file to check against for the uptodate file. 6514 </summary> 6515 </member> 6516 <member name="P:NAnt.Core.Tasks.IfTask.CompareFiles"> 6517 <summary> 6518 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the comparison files for 6519 the <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>(s) check. 6520 </summary> 6521 </member> 6522 <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFiles"> 6523 <summary> 6524 The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the uptodate files for 6525 the <see cref="P:NAnt.Core.Tasks.IfTask.CompareFile"/>(s) check. 6526 </summary> 6527 </member> 6528 <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue"> 6529 <summary> 6530 Used to test whether a property is true. 6531 </summary> 6532 </member> 6533 <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameExists"> 6534 <summary> 6535 Used to test whether a property exists. 6536 </summary> 6537 </member> 6538 <member name="P:NAnt.Core.Tasks.IfTask.TargetNameExists"> 6539 <summary> 6540 Used to test whether a target exists. 6541 </summary> 6542 </member> 6543 <member name="P:NAnt.Core.Tasks.IfTask.Test"> 6544 <summary> 6545 Used to test arbitrary boolean expression. 6546 </summary> 6547 </member> 6548 <member name="T:NAnt.Core.Tasks.IfNotTask"> 6549 <summary> 6550 The opposite of the <c>if</c> task. 6551 </summary> 6552 <example> 6553 <para>Check that a property does not exist.</para> 6554 <code> 6555 <![CDATA[ 6556 <ifnot propertyexists="myProp"> 6557 <echo message="myProp does not exist."/> 6558 </if> 6559 ]]> 6560 </code> 6561 <para>Check that a property value is not true.</para> 6562 <code> 6563 <![CDATA[ 6564 <ifnot propertytrue="myProp"> 6565 <echo message="myProp is not true."/> 6566 </if> 6567 ]]> 6568 </code> 6569 </example> 6570 <example> 6571 <para>Check that a target does not exist.</para> 6572 <code> 6573 <![CDATA[ 6574 <ifnot targetexists="myTarget"> 6575 <echo message="myTarget does not exist."/> 6576 </if> 6577 ]]> 6578 </code> 6579 </example> 6580 </member> 6581 <member name="T:NAnt.Core.Tasks.IncludeTask"> 6582 <summary> 6583 Includes an external build file. 6584 </summary> 6585 <remarks> 6586 <para> 6587 This task is used to break your build file into smaller chunks. You 6588 can load a partial build file and have it included into the build file. 6589 </para> 6590 <note> 6591 Any global (project level) tasks in the included build file are executed 6592 when this task is executed. Tasks in target elements are only executed 6593 if that target is executed. 6594 </note> 6595 <note> 6596 The project element attributes are ignored. 6597 </note> 6598 <note> 6599 This task can only be in the global (project level) section of the 6600 build file. 6601 </note> 6602 <note> 6603 This task can only include files from the file system. 6604 </note> 6605 </remarks> 6606 <example> 6607 <para> 6608 Include a task that fetches the project version from the 6609 <c>GetProjectVersion.include</c> build file. 6610 </para> 6611 <code> 6612 <![CDATA[ 6613 <include buildfile="GetProjectVersion.include" /> 6614 ]]> 6615 </code> 6616 </example> 6617 </member> 6618 <member name="F:NAnt.Core.Tasks.IncludeTask._includedFileNames"> 6619 <summary> 6620 Used to check for recursived includes. 6621 </summary> 6622 </member> 6623 <member name="M:NAnt.Core.Tasks.IncludeTask.Initialize"> 6624 <summary> 6625 Verifies parameters. 6626 </summary> 6627 </member> 6628 <member name="P:NAnt.Core.Tasks.IncludeTask.BuildFileName"> 6629 <summary> 6630 Build file to include. 6631 </summary> 6632 </member> 6633 <member name="T:NAnt.Core.Tasks.LoadFileTask"> 6634 <summary> 6635 Load a text file into a single property. 6636 </summary> 6637 <remarks> 6638 <para> 6639 Unless an encoding is specified, the encoding associated with the 6640 system's current ANSI code page is used. 6641 </para> 6642 <para> 6643 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text 6644 file is automatically recognized, if the file starts with the appropriate 6645 byte order marks. 6646 </para> 6647 </remarks> 6648 <example> 6649 <para> 6650 Load file <c>message.txt</c> into property "message". 6651 </para> 6652 <code> 6653 <![CDATA[ 6654 <loadfile 6655 file="message.txt" 6656 property="message" /> 6657 ]]> 6658 </code> 6659 </example> 6660 <example> 6661 <para> 6662 Load a file using the "latin-1" encoding. 6663 </para> 6664 <code> 6665 <![CDATA[ 6666 <loadfile 6667 file="loadfile.xml" 6668 property="encoded-file" 6669 encoding="iso-8859-1" /> 6670 ]]> 6671 </code> 6672 </example> 6673 <example> 6674 <para> 6675 Load a file, replacing all <c>@NOW@</c> tokens with the current 6676 date/time. 6677 </para> 6678 <code> 6679 <![CDATA[ 6680 <loadfile file="token.txt" property="token-file"> 6681 <filterchain> 6682 <replacetokens> 6683 <token key="NOW" value="${datetime::now()}" /> 6684 </replacetokens> 6685 </filterchain> 6686 </loadfile> 6687 ]]> 6688 </code> 6689 </example> 6690 </member> 6691 <member name="P:NAnt.Core.Tasks.LoadFileTask.File"> 6692 <summary> 6693 The file to load. 6694 </summary> 6695 </member> 6696 <member name="P:NAnt.Core.Tasks.LoadFileTask.Property"> 6697 <summary> 6698 The name of the property to save the content to. 6699 </summary> 6700 </member> 6701 <member name="P:NAnt.Core.Tasks.LoadFileTask.Encoding"> 6702 <summary> 6703 The encoding to use when loading the file. The default is the encoding 6704 associated with the system's current ANSI code page. 6705 </summary> 6706 </member> 6707 <member name="P:NAnt.Core.Tasks.LoadFileTask.FilterChain"> 6708 <summary> 6709 The filterchain definition to use. 6710 </summary> 6711 </member> 6712 <member name="T:NAnt.Core.Tasks.LoadTasksTask"> 6713 <summary> 6714 Loads tasks form a given assembly or all assemblies in a given directory 6715 or <see cref="T:NAnt.Core.Types.FileSet"/>. 6716 </summary> 6717 <example> 6718 <para> 6719 Load tasks from a single assembly. 6720 </para> 6721 <code> 6722 <![CDATA[ 6723 <loadtasks assembly="c:foo\NAnt.Contrib.Tasks.dll" /> 6724 ]]> 6725 </code> 6726 </example> 6727 <example> 6728 <para> 6729 Scan a single directory for task assemblies. 6730 </para> 6731 <code> 6732 <![CDATA[ 6733 <loadtasks path="c:\foo" /> 6734 ]]> 6735 </code> 6736 </example> 6737 <example> 6738 <para> 6739 Use a <see cref="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet"/> containing both a directory and an 6740 assembly. 6741 </para> 6742 <code> 6743 <![CDATA[ 6744 <loadtasks> 6745 <fileset> 6746 <include name="C:\cvs\NAntContrib\build" /> 6747 <include name="C:\cvs\NAntContrib\build\NAnt.Contrib.Tasks.dll" /> 6748 </fileset> 6749 </loadtasks> 6750 ]]> 6751 </code> 6752 </example> 6753 </member> 6754 <member name="M:NAnt.Core.Tasks.LoadTasksTask.ExecuteTask"> 6755 <summary> 6756 Executes the Load Tasks task. 6757 </summary> 6758 <exception cref="T:NAnt.Core.BuildException">Specified assembly or path does not exist.</exception> 6759 </member> 6760 <member name="M:NAnt.Core.Tasks.LoadTasksTask.Initialize"> 6761 <summary> 6762 Validates the attributes. 6763 </summary> 6764 <exception cref="T:NAnt.Core.BuildException">Both <see cref="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath"/> and <see cref="P:NAnt.Core.Tasks.LoadTasksTask.Path"/> are set.</exception> 6765 </member> 6766 <member name="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath"> 6767 <summary> 6768 An assembly to load tasks from. 6769 </summary> 6770 </member> 6771 <member name="P:NAnt.Core.Tasks.LoadTasksTask.Path"> 6772 <summary> 6773 A directory to scan for task assemblies. 6774 </summary> 6775 </member> 6776 <member name="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet"> 6777 <summary> 6778 Used to select which directories or individual assemblies to scan. 6779 </summary> 6780 </member> 6781 <member name="T:NAnt.Core.Tasks.LoopTask"> 6782 <summary> 6783 Loops over a set of items. 6784 </summary> 6785 <remarks> 6786 <para> 6787 Can loop over files in directory, lines in a file, etc. 6788 </para> 6789 <para> 6790 The property value is stored before the loop is done, and restored 6791 when the loop is finished. 6792 </para> 6793 <para> 6794 The property is returned to its normal value once it is used. Read-only 6795 parameters cannot be overridden in this loop. 6796 </para> 6797 </remarks> 6798 <example> 6799 <para>Loops over the files in <c>c:\</c>.</para> 6800 <code> 6801 <![CDATA[ 6802 <foreach item="File" in="c:\" property="filename"> 6803 <echo message="${filename}" /> 6804 </foreach> 6805 ]]> 6806 </code> 6807 </example> 6808 <example> 6809 <para>Loops over all files in the project directory.</para> 6810 <code> 6811 <![CDATA[ 6812 <foreach item="File" property="filename"> 6813 <in> 6814 <items> 6815 <include name="**" /> 6816 </items> 6817 </in> 6818 <do> 6819 <echo message="${filename}" /> 6820 </do> 6821 </foreach> 6822 ]]> 6823 </code> 6824 </example> 6825 <example> 6826 <para>Loops over the folders in <c>c:\</c>.</para> 6827 <code> 6828 <![CDATA[ 6829 <foreach item="Folder" in="c:\" property="foldername"> 6830 <echo message="${foldername}" /> 6831 </foreach> 6832 ]]> 6833 </code> 6834 </example> 6835 <example> 6836 <para>Loops over all folders in the project directory.</para> 6837 <code> 6838 <![CDATA[ 6839 <foreach item="Folder" property="foldername"> 6840 <in> 6841 <items> 6842 <include name="**" /> 6843 </items> 6844 </in> 6845 <do> 6846 <echo message="${foldername}" /> 6847 </do> 6848 </foreach> 6849 ]]> 6850 </code> 6851 </example> 6852 <example> 6853 <para>Loops over a list.</para> 6854 <code> 6855 <![CDATA[ 6856 <foreach item="String" in="1 2,3" delim=" ," property="count"> 6857 <echo message="${count}" /> 6858 </foreach> 6859 ]]> 6860 </code> 6861 </example> 6862 <example> 6863 <para> 6864 Loops over lines in the file <c>properties.csv</c>, where each line 6865 is of the format name,value. 6866 </para> 6867 <code> 6868 <![CDATA[ 6869 <foreach item="Line" in="properties.csv" delim="," property="x,y"> 6870 <echo message="Read pair ${x}=${y}" /> 6871 </foreach> 6872 ]]> 6873 </code> 6874 </example> 6875 </member> 6876 <member name="P:NAnt.Core.Tasks.LoopTask.Property"> 6877 <summary> 6878 The NAnt property name(s) that should be used for the current 6879 iterated item. 6880 </summary> 6881 <remarks> 6882 If specifying multiple properties, separate them with a comma. 6883 </remarks> 6884 </member> 6885 <member name="P:NAnt.Core.Tasks.LoopTask.ItemType"> 6886 <summary> 6887 The type of iteration that should be done. 6888 </summary> 6889 </member> 6890 <member name="P:NAnt.Core.Tasks.LoopTask.TrimType"> 6891 <summary> 6892 The type of whitespace trimming that should be done. The default 6893 is <see cref="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None"/>. 6894 </summary> 6895 </member> 6896 <member name="P:NAnt.Core.Tasks.LoopTask.Source"> 6897 <summary> 6898 The source of the iteration. 6899 </summary> 6900 </member> 6901 <member name="P:NAnt.Core.Tasks.LoopTask.Delimiter"> 6902 <summary> 6903 The deliminator char. 6904 </summary> 6905 </member> 6906 <member name="P:NAnt.Core.Tasks.LoopTask.InElement"> 6907 <summary> 6908 Stuff to operate in. Just like the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/> 6909 attribute, but supports more complicated things like a <see cref="T:NAnt.Core.Types.FileSet"/> 6910 and such. 6911 <note> 6912 Please remove the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/> attribute if you 6913 are using this element. 6914 </note> 6915 </summary> 6916 </member> 6917 <member name="P:NAnt.Core.Tasks.LoopTask.StuffToDo"> 6918 <summary> 6919 Tasks to execute for each matching item. 6920 </summary> 6921 </member> 6922 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None"> 6923 <summary> 6924 Do not remove any white space characters. 6925 </summary> 6926 </member> 6927 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.End"> 6928 <summary> 6929 Remove all white space characters from the end of the current 6930 item. 6931 </summary> 6932 </member> 6933 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Start"> 6934 <summary> 6935 Remove all white space characters from the beginning of the 6936 current item. 6937 </summary> 6938 </member> 6939 <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Both"> 6940 <summary> 6941 Remove all white space characters from the beginning and end of 6942 the current item. 6943 </summary> 6944 </member> 6945 <member name="T:NAnt.Core.Tasks.MailTask"> 6946 <summary> 6947 Sends an SMTP message. 6948 </summary> 6949 <remarks> 6950 <para> 6951 Text and text files to include in the message body may be specified as 6952 well as binary attachments. 6953 </para> 6954 </remarks> 6955 <example> 6956 <para> 6957 Sends an email from <c>nant@sourceforge.net</c> to three recipients 6958 with a subject about the attachments. The body of the message will be 6959 the combined contents of all <c>.txt</c> files in the base directory. 6960 All zip files in the base directory will be included as attachments. 6961 The message will be sent using the <c>smtpserver.anywhere.com</c> SMTP 6962 server. 6963 </para> 6964 <code> 6965 <![CDATA[ 6966 <mail 6967 from="nant@sourceforge.net" 6968 tolist="recipient1@sourceforge.net" 6969 cclist="recipient2@sourceforge.net" 6970 bcclist="recipient3@sourceforge.net" 6971 subject="Msg 7: With attachments" 6972 mailhost="smtpserver.anywhere.com"> 6973 <files> 6974 <include name="*.txt" /> 6975 </files> 6976 <attachments> 6977 <include name="*.zip" /> 6978 </attachments> 6979 </mail> 6980 ]]> 6981 </code> 6982 </example> 6983 </member> 6984 <member name="M:NAnt.Core.Tasks.MailTask.Initialize"> 6985 <summary> 6986 Initializes task and ensures the supplied attributes are valid. 6987 </summary> 6988 </member> 6989 <member name="M:NAnt.Core.Tasks.MailTask.ExecuteTask"> 6990 <summary> 6991 This is where the work is done. 6992 </summary> 6993 </member> 6994 <member name="M:NAnt.Core.Tasks.MailTask.ReadFile(System.String)"> 6995 <summary> 6996 Reads a text file and returns the content 6997 in a string. 6998 </summary> 6999 <param name="filename">The file to read content of.</param> 7000 <returns> 7001 The content of the specified file. 7002 </returns> 7003 </member> 7004 <member name="P:NAnt.Core.Tasks.MailTask.From"> 7005 <summary> 7006 Email address of sender. 7007 </summary> 7008 </member> 7009 <member name="P:NAnt.Core.Tasks.MailTask.ToList"> 7010 <summary> 7011 Semicolon-separated list of recipient email addresses. 7012 </summary> 7013 </member> 7014 <member name="P:NAnt.Core.Tasks.MailTask.CcList"> 7015 <summary> 7016 Semicolon-separated list of CC: recipient email addresses. 7017 </summary> 7018 </member> 7019 <member name="P:NAnt.Core.Tasks.MailTask.BccList"> 7020 <summary> 7021 Semicolon-separated list of BCC: recipient email addresses. 7022 </summary> 7023 </member> 7024 <member name="P:NAnt.Core.Tasks.MailTask.Mailhost"> 7025 <summary> 7026 Host name of mail server. The default is <c>localhost</c>. 7027 </summary> 7028 </member> 7029 <member name="P:NAnt.Core.Tasks.MailTask.Message"> 7030 <summary> 7031 Text to send in body of email message. 7032 </summary> 7033 </member> 7034 <member name="P:NAnt.Core.Tasks.MailTask.Subject"> 7035 <summary> 7036 Text to send in subject line of email message. 7037 </summary> 7038 </member> 7039 <member name="P:NAnt.Core.Tasks.MailTask.Format"> 7040 <summary> 7041 Format of the message. The default is <see cref="F:System.Web.Mail.MailFormat.Text"/>. 7042 </summary> 7043 </member> 7044 <member name="P:NAnt.Core.Tasks.MailTask.Files"> 7045 <summary> 7046 Files that are transmitted as part of the body of the email message. 7047 </summary> 7048 </member> 7049 <member name="P:NAnt.Core.Tasks.MailTask.Attachments"> 7050 <summary> 7051 Attachments that are transmitted with the message. 7052 </summary> 7053 </member> 7054 <member name="T:NAnt.Core.Tasks.MkDirTask"> 7055 <summary> 7056 Creates a directory and any non-existent parent directory if necessary. 7057 </summary> 7058 <example> 7059 <para>Create the directory <c>build</c>.</para> 7060 <code> 7061 <![CDATA[ 7062 <mkdir dir="build" /> 7063 ]]> 7064 </code> 7065 </example> 7066 <example> 7067 <para>Create the directory tree <c>one/two/three</c>.</para> 7068 <code> 7069 <![CDATA[ 7070 <mkdir dir="one/two/three" /> 7071 ]]> 7072 </code> 7073 </example> 7074 </member> 7075 <member name="M:NAnt.Core.Tasks.MkDirTask.ExecuteTask"> 7076 <summary> 7077 Creates the directory specified by the <see cref="P:NAnt.Core.Tasks.MkDirTask.Dir"/> property. 7078 </summary> 7079 <exception cref="T:NAnt.Core.BuildException">The directory could not be created.</exception> 7080 </member> 7081 <member name="P:NAnt.Core.Tasks.MkDirTask.Dir"> 7082 <summary> 7083 The directory to create. 7084 </summary> 7085 </member> 7086 <member name="T:NAnt.Core.Tasks.MoveTask"> 7087 <summary> 7088 Moves a file or set of files to a new file or directory. 7089 </summary> 7090 <remarks> 7091 <para> 7092 Files are only moved if the source file is newer than the destination 7093 file, or if the destination file does not exist. However, you can 7094 explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/> 7095 attribute. 7096 </para> 7097 <para> 7098 A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to move. To use 7099 a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> 7100 attribute must be set. 7101 </para> 7102 <h3>Encoding</h3> 7103 <para> 7104 Unless an encoding is specified, the encoding associated with the 7105 system's current ANSI code page is used. 7106 </para> 7107 <para> 7108 An UTF-8, little-endian Unicode, and big-endian Unicode encoded text 7109 file is automatically recognized, if the file starts with the 7110 appropriate byte order marks. 7111 </para> 7112 <note> 7113 If you employ filters in your move operation, you should limit the 7114 move to text files. Binary files will be corrupted by the move 7115 operation. 7116 </note> 7117 </remarks> 7118 <example> 7119 <para> 7120 Move a single file while changing its encoding from "latin1" to 7121 "utf-8". 7122 </para> 7123 <code> 7124 <![CDATA[ 7125 <move 7126 file="myfile.txt" 7127 tofile="mycopy.txt" 7128 inputencoding="latin1" 7129 outputencoding="utf-8" /> 7130 ]]> 7131 </code> 7132 </example> 7133 <example> 7134 <para>Move a set of files.</para> 7135 <code> 7136 <![CDATA[ 7137 <move todir="${build.dir}"> 7138 <fileset basedir="bin"> 7139 <include name="*.dll" /> 7140 </fileset> 7141 </move> 7142 ]]> 7143 </code> 7144 </example> 7145 <example> 7146 <para> 7147 Move a set of files to a directory, replacing <c>@TITLE@</c> with 7148 "Foo Bar" in all files. 7149 </para> 7150 <code> 7151 <![CDATA[ 7152 <move todir="../backup/dir"> 7153 <fileset basedir="src_dir"> 7154 <include name="**/*" /> 7155 </fileset> 7156 <filterchain> 7157 <replacetokens> 7158 <token key="TITLE" value="Foo Bar" /> 7159 </replacetokens> 7160 </filterchain> 7161 </move> 7162 ]]> 7163 </code> 7164 </example> 7165 </member> 7166 <member name="M:NAnt.Core.Tasks.MoveTask.DoFileOperations"> 7167 <summary> 7168 Actually does the file moves. 7169 </summary> 7170 </member> 7171 <member name="P:NAnt.Core.Tasks.MoveTask.SourceFile"> 7172 <summary> 7173 The file to move. 7174 </summary> 7175 </member> 7176 <member name="P:NAnt.Core.Tasks.MoveTask.ToFile"> 7177 <summary> 7178 The file to move to. 7179 </summary> 7180 </member> 7181 <member name="P:NAnt.Core.Tasks.MoveTask.ToDirectory"> 7182 <summary> 7183 The directory to move to. 7184 </summary> 7185 </member> 7186 <member name="P:NAnt.Core.Tasks.MoveTask.CopyFileSet"> 7187 <summary> 7188 Used to select the files to move. To use a <see cref="T:NAnt.Core.Types.FileSet"/>, 7189 the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/> attribute must be set. 7190 </summary> 7191 </member> 7192 <member name="P:NAnt.Core.Tasks.MoveTask.Flatten"> 7193 <summary> 7194 Ignore directory structure of source directory, move all files into 7195 a single directory, specified by the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/> 7196 attribute. The default is <see langword="false"/>. 7197 </summary> 7198 </member> 7199 <member name="P:NAnt.Core.Tasks.MoveTask.Filters"> 7200 <summary> 7201 Chain of filters used to alter the file's content as it is moved. 7202 </summary> 7203 </member> 7204 <member name="T:NAnt.Core.Tasks.NAntSchemaTask"> 7205 <summary> 7206 Creates an XSD File for all available tasks. 7207 </summary> 7208 <remarks> 7209 <para> 7210 This can be used in conjuntion with the command-line option to do XSD 7211 Schema validation on the build file. 7212 </para> 7213 </remarks> 7214 <example> 7215 <para>Creates a <c>NAnt.xsd</c> file in the current project directory.</para> 7216 <code> 7217 <![CDATA[ 7218 <nantschema output="NAnt.xsd" /> 7219 ]]> 7220 </code> 7221 </example> 7222 </member> 7223 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.WriteSchema(System.IO.Stream,System.Type[],System.Type[],System.String)"> 7224 <summary> 7225 Creates a NAnt Schema for given types 7226 </summary> 7227 <param name="stream">The output stream to save the schema to. If <see langword="null" />, writing is ignored, no exception generated.</param> 7228 <param name="tasks">The list of tasks to generate XML Schema for.</param> 7229 <param name="dataTypes">The list of datatypes to generate XML Schema for.</param> 7230 <param name="targetNS">The target namespace to output.</param> 7231 <returns>The new NAnt Schema.</returns> 7232 </member> 7233 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdAttribute(System.String,System.Boolean)"> 7234 <summary> 7235 Creates a new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance. 7236 </summary> 7237 <param name="name">The name of the attribute.</param> 7238 <param name="required">Value indicating whether the attribute should be required.</param> 7239 <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.</returns> 7240 </member> 7241 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdSequence(System.Decimal,System.Decimal)"> 7242 <summary> 7243 Creates a new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance. 7244 </summary> 7245 <param name="min">The minimum value to allow for this choice</param> 7246 <param name="max">The maximum value to allow, Decimal.MaxValue sets it to 'unbound'</param> 7247 <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.</returns> 7248 </member> 7249 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.OutputFile"> 7250 <summary> 7251 The name of the output file to which the XSD should be written. 7252 </summary> 7253 </member> 7254 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.TargetNamespace"> 7255 <summary> 7256 The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd" 7257 </summary> 7258 </member> 7259 <member name="P:NAnt.Core.Tasks.NAntSchemaTask.ForType"> 7260 <summary> 7261 The <see cref="T:System.Type"/> for which an XSD should be created. If not 7262 specified, an XSD will be created for all available tasks. 7263 </summary> 7264 </member> 7265 <member name="M:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator.#ctor(System.Type[],System.Type[],System.String)"> 7266 <summary> 7267 Creates a new instance of the <see cref="T:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator"/> 7268 class. 7269 </summary> 7270 <param name="tasks">Tasks for which a schema should be generated.</param> 7271 <param name="dataTypes">Data Types for which a schema should be generated.</param> 7272 <param name="targetNS">The namespace to use. 7273 <example> http://tempuri.org/nant.xsd </example> 7274 </param> 7275 </member> 7276 <member name="T:NAnt.Core.Tasks.NAntTask"> 7277 <summary> 7278 Runs NAnt on a supplied build file, or a set of build files. 7279 </summary> 7280 <remarks> 7281 <para> 7282 By default, all the properties of the current project will be available 7283 in the new project. Alternatively, you can set <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/> 7284 to <see langword="false"/> to not copy any properties to the new 7285 project. 7286 </para> 7287 <para> 7288 You can also set properties in the new project from the old project by 7289 using nested property tags. These properties are always passed to the 7290 new project regardless of the setting of <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>. 7291 This allows you to parameterize your subprojects. 7292 </para> 7293 <para> 7294 References to data types can also be passed to the new project, but by 7295 default they are not. If you set the <see cref="P:NAnt.Core.Tasks.NAntTask.InheritRefs"/> to 7296 <see langword="true"/>, all references will be copied. 7297 </para> 7298 </remarks> 7299 <example> 7300 <para> 7301 Build a project located in a different directory if the <c>debug</c> 7302 property is not <see langword="true"/>. 7303 </para> 7304 <code> 7305 <![CDATA[ 7306 <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build" unless="${debug}" /> 7307 ]]> 7308 </code> 7309 </example> 7310 <example> 7311 <para> 7312 Build a project while adding a set of properties to that project. 7313 </para> 7314 <code> 7315 <![CDATA[ 7316 <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build"> 7317 <properties> 7318 <property name="build.dir" value="c:/buildserver" /> 7319 <property name="build.debug" value="false" /> 7320 <property name="lib.dir" value="c:/shared/lib" readonly="true" /> 7321 </properties> 7322 </nant> 7323 ]]> 7324 </code> 7325 </example> 7326 <example> 7327 <para> 7328 Build all projects named <c>default.build</c> located anywhere under 7329 the project base directory. 7330 </para> 7331 <code> 7332 <![CDATA[ 7333 <nant> 7334 <buildfiles> 7335 <include name="**/default.build" /> 7336 <!-- avoid recursive execution of current build file --> 7337 <exclude name="${project::get-buildfile-path()}" /> 7338 </buildfiles> 7339 </nant> 7340 ]]> 7341 </code> 7342 </example> 7343 </member> 7344 <member name="M:NAnt.Core.Tasks.NAntTask.Initialize"> 7345 <summary> 7346 Validates the <see cref="T:NAnt.Core.Tasks.NAntTask"/> element. 7347 </summary> 7348 </member> 7349 <member name="P:NAnt.Core.Tasks.NAntTask.BuildFile"> 7350 <summary> 7351 The build file to build. 7352 </summary> 7353 </member> 7354 <member name="P:NAnt.Core.Tasks.NAntTask.DefaultTarget"> 7355 <summary> 7356 The target to execute. To specify more than one target seperate 7357 targets with a space. Targets are executed in order if possible. 7358 The default is to use target specified in the project's default 7359 attribute. 7360 </summary> 7361 </member> 7362 <member name="P:NAnt.Core.Tasks.NAntTask.BuildFiles"> 7363 <summary> 7364 Used to specify a set of build files to process. 7365 </summary> 7366 </member> 7367 <member name="P:NAnt.Core.Tasks.NAntTask.InheritAll"> 7368 <summary> 7369 Specifies whether current property values should be inherited by 7370 the executed project. The default is <see langword="true" />. 7371 </summary> 7372 </member> 7373 <member name="P:NAnt.Core.Tasks.NAntTask.InheritRefs"> 7374 <summary> 7375 Specifies whether all references will be copied to the new project. 7376 The default is <see langword="false" />. 7377 </summary> 7378 </member> 7379 <member name="P:NAnt.Core.Tasks.NAntTask.OverrideProperties"> 7380 <summary> 7381 Specifies a collection of properties that should be created in the 7382 executed project. Note, existing properties with identical names 7383 that are not read-only will be overwritten. 7384 </summary> 7385 </member> 7386 <member name="T:NAnt.Core.Tasks.PropertyTask"> 7387 <summary> 7388 Sets a property in the current project. 7389 </summary> 7390 <remarks> 7391 <note>NAnt uses a number of predefined properties.</note> 7392 </remarks> 7393 <example> 7394 <para> 7395 Define a <c>debug</c> property with value <see langword="true" />. 7396 </para> 7397 <code> 7398 <![CDATA[ 7399 <property name="debug" value="true" /> 7400 ]]> 7401 </code> 7402 </example> 7403 <example> 7404 <para> 7405 Use the user-defined <c>debug</c> property. 7406 </para> 7407 <code> 7408 <![CDATA[ 7409 <property name="trace" value="${debug}" /> 7410 ]]> 7411 </code> 7412 </example> 7413 <example> 7414 <para> 7415 Define a read-only property. This is just like passing in the param 7416 on the command line. 7417 </para> 7418 <code> 7419 <![CDATA[ 7420 <property name="do_not_touch_ME" value="hammer" readonly="true" /> 7421 ]]> 7422 </code> 7423 </example> 7424 <example> 7425 <para> 7426 Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line). 7427 </para> 7428 <code> 7429 <![CDATA[ 7430 <project name="property-example"> 7431 <property name="debug" value="true" overwrite="false" /> 7432 <echo message="debug: ${debug}" /> 7433 </project> 7434 ]]> 7435 </code> 7436 <para> 7437 Executing this build file with the command line option <c>-D:debug=false</c>, 7438 would cause the value specified on the command line to remain unaltered. 7439 </para> 7440 <code> 7441 <![CDATA[ 7442 [echo] debug: false 7443 ]]> 7444 </code> 7445 </example> 7446 </member> 7447 <member name="P:NAnt.Core.Tasks.PropertyTask.PropertyName"> 7448 <summary> 7449 The name of the NAnt property to set. 7450 </summary> 7451 </member> 7452 <member name="P:NAnt.Core.Tasks.PropertyTask.Value"> 7453 <summary> 7454 The value to assign to the NAnt property. 7455 </summary> 7456 </member> 7457 <member name="P:NAnt.Core.Tasks.PropertyTask.ReadOnly"> 7458 <summary> 7459 Specifies whether the property is read-only or not. 7460 The default is <see langword="false" />. 7461 </summary> 7462 </member> 7463 <member name="P:NAnt.Core.Tasks.PropertyTask.Dynamic"> 7464 <summary> 7465 Specifies whether references to other properties should not be 7466 expanded when the value of the property is set, but expanded when 7467 the property is actually used. By default, properties will be 7468 expanded when set. 7469 </summary> 7470 </member> 7471 <member name="P:NAnt.Core.Tasks.PropertyTask.Overwrite"> 7472 <summary> 7473 Specifies whether the value of a property should be overwritten if 7474 the property already exists (unless the property is read-only). 7475 The default is <see langword="true" />. 7476 </summary> 7477 </member> 7478 <member name="T:NAnt.Core.Tasks.RegexTask"> 7479 <summary> 7480 Sets project properties based on the evaluatuion of a regular expression. 7481 </summary> 7482 <remarks> 7483 <para> 7484 The <see cref="P:NAnt.Core.Tasks.RegexTask.Pattern"/> attribute must contain one or more 7485 <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcongroupingconstructs.asp"> 7486 named grouping constructs</see>, which represents the names of the 7487 properties to be set. These named grouping constructs can be enclosed 7488 by angle brackets (?<name>) or single quotes (?'name'). 7489 </para> 7490 <note> 7491 In the build file, use the XML element <![CDATA[<]]> to specify <, 7492 and <![CDATA[>]]> to specify >. 7493 </note> 7494 <note> 7495 The named grouping construct must not contain any punctuation and it 7496 cannot begin with a number. 7497 </note> 7498 </remarks> 7499 <example> 7500 <para> 7501 Find the last word in the given string and stores it in the property 7502 <c>lastword</c>. 7503 </para> 7504 <code> 7505 <![CDATA[ 7506 <regex pattern="(?'lastword'\w+)$" input="This is a test sentence" /> 7507 <echo message="${lastword}" /> 7508 ]]> 7509 </code> 7510 </example> 7511 <example> 7512 <para> 7513 Split the full filename and extension of a filename. 7514 </para> 7515 <code> 7516 <![CDATA[ 7517 <regex pattern="^(?'filename'.*)\.(?'extension'\w+)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" /> 7518 ]]> 7519 </code> 7520 </example> 7521 <example> 7522 <para> 7523 Split the path and the filename. (This checks for <c>/</c> or <c>\</c> 7524 as the path separator). 7525 </para> 7526 <code> 7527 <![CDATA[ 7528 <regex pattern="^(?'path'.*(\\|/)|(/|\\))(?'file'.*)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" /> 7529 ]]> 7530 </code> 7531 <para> 7532 Results in path=<c>d:\Temp\SomeDir\SomeDir\</c> and file=<c>bla.xml</c>. 7533 </para> 7534 </example> 7535 </member> 7536 <member name="M:NAnt.Core.Tasks.RegexTask.ExecuteTask"> 7537 <summary> 7538 Executes the task. 7539 </summary> 7540 </member> 7541 <member name="P:NAnt.Core.Tasks.RegexTask.Pattern"> 7542 <summary> 7543 Represents the regular expression to be evalued. 7544 </summary> 7545 <value> 7546 The regular expression to be evalued. 7547 </value> 7548 <remarks> 7549 The pattern must contain one or more named constructs, which may 7550 not contain any punctuation and cannot begin with a number. 7551 </remarks> 7552 </member> 7553 <member name="P:NAnt.Core.Tasks.RegexTask.Options"> 7554 <summary> 7555 A comma separated list of options to pass to the regex engine. The 7556 default is <see cref="F:System.Text.RegularExpressions.RegexOptions.None"/>. 7557 </summary> 7558 </member> 7559 <member name="P:NAnt.Core.Tasks.RegexTask.Input"> 7560 <summary> 7561 Represents the input for the regular expression. 7562 </summary> 7563 <value> 7564 The input for the regular expression. 7565 </value> 7566 </member> 7567 <member name="T:NAnt.Core.Tasks.SetEnvTask"> 7568 <summary> 7569 Sets an environment variable or a whole collection of them. Use an empty 7570 <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute to clear a variable. 7571 </summary> 7572 <remarks> 7573 <note> 7574 Variables will be set for the current NAnt process and all child 7575 processes that NAnt spawns (compilers, shell tools, etc). If the 7576 intention is to only set a variable for a single child process, then 7577 using the <see cref="T:NAnt.Core.Tasks.ExecTask"/> and its nested <see cref="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet"/> 7578 element might be a better option. 7579 </note> 7580 <note> 7581 Expansion of inline environment variables is performed using the syntax 7582 of the current platform. So on Windows platforms using the string %PATH% 7583 in the <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute will result in the value of 7584 the PATH variable being expanded in place before the variable is set. 7585 </note> 7586 </remarks> 7587 <example> 7588 <para>Set the MONO_PATH environment variable on a *nix platform.</para> 7589 <code> 7590 <![CDATA[ 7591 <setenv name=="MONO_PATH" value="/home/jimbob/dev/foo:%MONO_PATH%"/> 7592 ]]> 7593 </code> 7594 </example> 7595 <example> 7596 <para>Set a collection of environment variables. Note the nested variable used to set var3.</para> 7597 <code> 7598 <![CDATA[ 7599 <setenv> 7600 <variable name="var1" value="value2" /> 7601 <variable name="var2" value="value2" /> 7602 <variable name="var3" value="value3:%var2%" /> 7603 </setenv> 7604 ]]> 7605 </code> 7606 </example> 7607 <example> 7608 <para>Set environment variables using nested path elements.</para> 7609 <code> 7610 <![CDATA[ 7611 <path id="build.path"> 7612 <pathelement dir="c:/windows" /> 7613 <pathelement dir="c:/cygwin/usr/local/bin" /> 7614 </path> 7615 <setenv> 7616 <variable name="build_path" > 7617 <path refid="build.path" /> 7618 </variable> 7619 <variable name="path2"> 7620 <path> 7621 <pathelement dir="c:/windows" /> 7622 <pathelement dir="c:/cygwin/usr/local/bin" /> 7623 </path> 7624 </variable> 7625 </setenv> 7626 ]]> 7627 </code> 7628 </example> 7629 </member> 7630 <member name="M:NAnt.Core.Tasks.SetEnvTask.SetEnvironmentVariable(System.String,System.String)"> 7631 <summary> 7632 Win32 DllImport for the SetEnvironmentVariable function. 7633 </summary> 7634 <param name="lpName"></param> 7635 <param name="lpValue"></param> 7636 <returns></returns> 7637 </member> 7638 <member name="M:NAnt.Core.Tasks.SetEnvTask.setenv(System.String,System.String,System.Int32)"> 7639 <summary> 7640 *nix dllimport for the setenv function. 7641 </summary> 7642 <param name="name"></param> 7643 <param name="value"></param> 7644 <param name="overwrite"></param> 7645 <returns> 7646 <c>0</c> if the execution is successful; otherwise, <c>-1</c>. 7647 </returns> 7648 </member> 7649 <member name="M:NAnt.Core.Tasks.SetEnvTask.unsetenv(System.String)"> 7650 <summary> 7651 Deletes all instances of the variable name. 7652 </summary> 7653 <param name="name">The variable to unset.</param> 7654 <returns> 7655 <c>0</c> if the execution is successful; otherwise, <c>-1</c>. 7656 </returns> 7657 </member> 7658 <member name="M:NAnt.Core.Tasks.SetEnvTask.Initialize"> 7659 <summary> 7660 Checks whether the task is initialized with valid attributes. 7661 </summary> 7662 </member> 7663 <member name="M:NAnt.Core.Tasks.SetEnvTask.ExecuteTask"> 7664 <summary> 7665 Set the environment variables 7666 </summary> 7667 </member> 7668 <member name="M:NAnt.Core.Tasks.SetEnvTask.SetSingleEnvironmentVariable(System.String,System.String)"> 7669 <summary> 7670 Do the actual work here. 7671 </summary> 7672 <param name="name">The name of the environment variable.</param> 7673 <param name="value">The value of the environment variable.</param> 7674 </member> 7675 <member name="P:NAnt.Core.Tasks.SetEnvTask.EnvName"> 7676 <summary> 7677 The name of a single Environment variable to set 7678 </summary> 7679 </member> 7680 <member name="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"> 7681 <summary> 7682 The literal value for the environment variable. 7683 </summary> 7684 </member> 7685 <member name="P:NAnt.Core.Tasks.SetEnvTask.File"> 7686 <summary> 7687 The value for a file-based environment variable. NAnt will convert 7688 it to an absolute filename. 7689 </summary> 7690 </member> 7691 <member name="P:NAnt.Core.Tasks.SetEnvTask.Directory"> 7692 <summary> 7693 The value for a directory-based environment variable. NAnt will 7694 convert it to an absolute path. 7695 </summary> 7696 </member> 7697 <member name="P:NAnt.Core.Tasks.SetEnvTask.Path"> 7698 <summary> 7699 The value for a PATH like environment variable. You can use 7700 <c>:</c> or <c>;</c> as path separators and NAnt will convert it to 7701 the platform's local conventions. 7702 </summary> 7703 </member> 7704 <member name="T:NAnt.Core.Tasks.SleepTask"> 7705 <summary> 7706 A task for sleeping a specified period of time, useful when a build or deployment process 7707 requires an interval between tasks. 7708 </summary> 7709 <example> 7710 <para>Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds.</para> 7711 <code> 7712 <![CDATA[ 7713 <sleep hours="1" minutes="2" seconds="3" milliseconds="4" /> 7714 ]]> 7715 </code> 7716 </example> 7717 <example> 7718 <para>Sleep 123 milliseconds.</para> 7719 <code> 7720 <![CDATA[ 7721 <sleep milliseconds="123" /> 7722 ]]> 7723 </code> 7724 </example> 7725 </member> 7726 <member name="M:NAnt.Core.Tasks.SleepTask.Initialize"> 7727 <summary> 7728 Verify parameters. 7729 </summary> 7730 </member> 7731 <member name="M:NAnt.Core.Tasks.SleepTask.GetSleepTime"> 7732 <summary> 7733 Return time to sleep. 7734 </summary> 7735 </member> 7736 <member name="M:NAnt.Core.Tasks.SleepTask.DoSleep(System.Int32)"> 7737 <summary> 7738 Sleeps for the specified number of milliseconds. 7739 </summary> 7740 <param name="millis">Number of milliseconds to sleep.</param> 7741 </member> 7742 <member name="P:NAnt.Core.Tasks.SleepTask.Hours"> 7743 <summary> 7744 Hours to add to the sleep time. 7745 </summary> 7746 </member> 7747 <member name="P:NAnt.Core.Tasks.SleepTask.Minutes"> 7748 <summary> 7749 Minutes to add to the sleep time. 7750 </summary> 7751 </member> 7752 <member name="P:NAnt.Core.Tasks.SleepTask.Seconds"> 7753 <summary> 7754 Seconds to add to the sleep time. 7755 </summary> 7756 </member> 7757 <member name="P:NAnt.Core.Tasks.SleepTask.Milliseconds"> 7758 <summary> 7759 Milliseconds to add to the sleep time. 7760 </summary> 7761 </member> 7762 <member name="T:NAnt.Core.Tasks.StyleTask"> 7763 <summary> 7764 Processes a document via XSLT. 7765 </summary> 7766 <example> 7767 <para>Create a report in HTML.</para> 7768 <code> 7769 <![CDATA[ 7770 <style style="report.xsl" in="data.xml" out="report.html" /> 7771 ]]> 7772 </code> 7773 </example> 7774 <example> 7775 <para>Create a report in HTML, with a param.</para> 7776 <code> 7777 <![CDATA[ 7778 <style style="report.xsl" in="data.xml" out="report.html"> 7779 <parameters> 7780 <parameter name="reportType" namespaceuri="" value="Plain" /> 7781 </parameters> 7782 </style> 7783 ]]> 7784 </code> 7785 </example> 7786 <example> 7787 <para>Create a report in HTML, with a expanded param.</para> 7788 <code> 7789 <![CDATA[ 7790 <style style="report.xsl" in="data.xml" out="report.html"> 7791 <parameters> 7792 <parameter name="reportType" namespaceuri="" value="${report.type}" /> 7793 </parameters> 7794 </style> 7795 ]]> 7796 </code> 7797 </example> 7798 <example> 7799 <para>Create some code based on a directory of templates.</para> 7800 <code> 7801 <![CDATA[ 7802 <style style="CodeGenerator.xsl" extension="java"> 7803 <infiles> 7804 <include name="*.xml" /> 7805 </infiles> 7806 <parameters> 7807 <parameter name="reportType" namespaceuri="" value=