diff --git a/.gitignore b/.gitignore index 6984de4..87b8134 100644 --- a/.gitignore +++ b/.gitignore @@ -40,3 +40,4 @@ _ReSharper*/ !/src/Net.Sf.Dbdeploy/Resources/* bintree.api.key bintray.api.key +Tools/nant/doc/ diff --git a/Tools/nant/README.txt b/Tools/nant/README.txt index e0ba4b6..79edf19 100755 --- a/Tools/nant/README.txt +++ b/Tools/nant/README.txt @@ -55,12 +55,12 @@ Compilation and Installation You will need the .NET Framework SDK as well as the runtime components if you intend to compile programs. - Note: NAnt currently supports versions 1.0, 1.1 and 2.0 + Note: NAnt currently supports versions 1.0, 1.1, 2.0, 3.5, and 4.0 of the Microsoft .NET Framework. or - * Mono for Windows (version 1.0 or higher) + * Mono for Windows (version 2.0 or higher) Available from http://www.mono-project.com/downloads/ @@ -73,7 +73,7 @@ Compilation and Installation Available from: http://www.freedesktop.org/Software/pkgconfig - * A working Mono installation and development libraries (version 1.0 or higher) + * A working Mono installation and development libraries (version 2.0 or higher) Available from: http://www.mono-project.com/downloads/ @@ -85,28 +85,28 @@ Compilation and Installation GNU Make -------- - make install MONO= MCS=csc prefix= [DESTDIR=] + make install MONO= MCS=csc prefix= [DESTDIR=] [TARGET=] - eg. make install MONO= MCS=csc prefix="c:\Program Files" + eg. make install MONO= MCS=csc prefix="c:\Program Files" TARGET=net-2.0 NMake ----- - nmake -f Makefile.nmake install prefix= [DESTDIR=] + nmake -f Makefile.nmake install prefix= [DESTDIR=] [TARGET=] - eg. nmake -f Makefile.nmake install prefix="c:\Program Files" + eg. nmake -f Makefile.nmake install prefix="c:\Program Files" TARGET=net-4.0 Building NAnt using Mono: GNU Make -------- - make install prefix= [DESTDIR=] + make install prefix= [DESTDIR=] [TARGET=] - eg. make install prefix="c:\Program Files" + eg. make install prefix="c:\Program Files" TARGET=mono-4.0 NMake ----- - nmake -f Makefile.nmake install MONO=mono CSC=mcs prefix= [DESTDIR=] + nmake -f Makefile.nmake install MONO=mono CSC=mcs prefix= [DESTDIR=] [TARGET=] eg. nmake -f Makefile.nmake install MONO=mono CSC=mcs prefix=/usr/local/ @@ -123,7 +123,7 @@ Documentation is available in HTML format, in the doc/ directory. License ------- -Copyright (C) 2001-2008 Gerry Shaw +Copyright (C) 2001-2012 Gerry Shaw This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by diff --git a/Tools/nant/bin/NAnt.CompressionTasks.dll b/Tools/nant/bin/NAnt.CompressionTasks.dll index 20b1da0..11c81c2 100755 Binary files a/Tools/nant/bin/NAnt.CompressionTasks.dll and b/Tools/nant/bin/NAnt.CompressionTasks.dll differ diff --git a/Tools/nant/bin/NAnt.CompressionTasks.xml b/Tools/nant/bin/NAnt.CompressionTasks.xml index 9d90cb8..fb029f0 100755 --- a/Tools/nant/bin/NAnt.CompressionTasks.xml +++ b/Tools/nant/bin/NAnt.CompressionTasks.xml @@ -5,9 +5,9 @@ - - Summary description for ExpandTask. - + + Summary description for ExpandTask. + @@ -42,85 +42,92 @@ - - Overwrite files, even if they are newer than the corresponding - entries in the archive. The default is . - + + Overwrite files, even if they are newer than the corresponding + entries in the archive. The default is . + - - Expands a file packed using GZip compression. - - - Expands "test.tar.gz" to "test2.tar". - - - ]]> - - + + Expands a file packed using GZip compression. + + + Expands "test.tar.gz" to "test2.tar". + + + ]]> + + - - Extracts the file from the gzip archive. - + + Extracts the file from the gzip archive. + - - The file to expand. - + + The file to expand. + - - The destination file. - + + The destination file. + - - Creates a tar file from the specified filesets. - - - Uses #ziplib (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#. - - - - Tar all files in ${build.dir} and ${doc.dir} into a file - called "backup.tar.gz", and apply gzip compression to it. - - - - - - - - - - - ]]> - - + + Creates a tar file from the specified filesets. + + + Uses #ziplib (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#. + + + + Tar all files in ${build.dir} and ${doc.dir} into a file + called "backup.tar.gz", and apply gzip compression to it. + + + + + + + + + + + ]]> + + - - Creates the tar file. - + + Creates the tar file. + - - The tar file to create. - + + The tar file to create. + - - Include empty directories in the generated tar file. The default is - . - + + Include empty directories in the generated tar file. The default is + . + + + + + Ignore directory structure of source directory, compress all files + into a single directory. + The default value is . + - - The set of files to be included in the archive. - + + The set of files to be included in the archive. + @@ -128,39 +135,39 @@ - - Extracts files from a tar archive. - - - - Uses #ziplib - (SharpZipLib), an open source Zip/GZip library written entirely in C#. - - - - Extracts all files from a gzipped tar, preserving the directory structure. - - - ]]> - - + + Extracts files from a tar archive. + + + + Uses #ziplib + (SharpZipLib), an open source Zip/GZip library written entirely in C#. + + + + Extracts all files from a gzipped tar, preserving the directory structure. + + + ]]> + + - - Extracts the files from the archive. - + + Extracts the files from the archive. + - - The archive file to expand. - + + The archive file to expand. + - - The directory where to store the expanded file(s). The default is - the project base directory. - + + The directory where to store the expanded file(s). The default is + the project base directory. + @@ -168,143 +175,150 @@ - - Extracts files from a zip archive. - - - - Uses #ziplib - (SharpZipLib), an open source Zip/GZip library written entirely in C#. - - - - Extracts all the file from the zip, preserving the directory structure. - - - ]]> - - + + Extracts files from a zip archive. + + + + Uses #ziplib + (SharpZipLib), an open source Zip/GZip library written entirely in C#. + + + + Extracts all the file from the zip, preserving the directory structure. + + + ]]> + + - - Extracts the files from the zip file. - + + Extracts the files from the zip file. + - - The archive file to expand. - + + The archive file to expand. + - - The directory where the expanded files should be stored. The - default is the project base directory. - + + The directory where the expanded files should be stored. The + default is the project base directory. + - - The character encoding that has been used for filenames inside the - zip file. The default is the system's OEM code page. - + + The character encoding that has been used for filenames inside the + zip file. The default is the system's OEM code page. + - - Creates a zip file from the specified filesets. - - - - Uses #ziplib - (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#. - - - - - Zip all files in ${build.dir} and ${doc.dir} into a file - called "backup.zip". - - - - - - - - - - - ]]> - - + + Creates a zip file from the specified filesets. + + + + Uses #ziplib + (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#. + + + + + Zip all files in ${build.dir} and ${doc.dir} into a file + called "backup.zip". + + + + + + + + + + + ]]> + + - - Creates the zip file. - + + Creates the zip file. + - - The zip file to create. - + + The zip file to create. + - - The comment for the file. - + + The comment for the file. + - - Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS. - + + Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS. + - - Desired level of compression. Possible values are 0 (STORE only) - to 9 (highest). The default is 6. - + + Desired level of compression. Possible values are 0 (STORE only) + to 9 (highest). The default is 6. + - - Include empty directories in the generated zip file. The default is - . - + + Include empty directories in the generated zip file. The default is + . + + + + + Ignore directory structure of source directory, compress all files + into a single directory. + The default value is . + - - The set of files to be included in the archive. - + + The set of files to be included in the archive. + - - Specifies the behaviour when a duplicate file is found. The default - is . - + + Specifies the behaviour when a duplicate file is found. The default + is . + - - The character encoding to use for filenames and comment inside the - zip file. The default is the system's OEM code page. - + + The character encoding to use for filenames and comment inside the + zip file. The default is the system's OEM code page. + - - Specifies how entries with the same name should be processed. - + + Specifies how entries with the same name should be processed. + - - Overwrite existing entry with same name. - + + Overwrite existing entry with same name. + - - Preserve existing entry with the same name. - + + Preserve existing entry with the same name. + - - Report failure when two entries have the same name. - + + Report failure when two entries have the same name. + @@ -337,19 +351,19 @@ - - No compression. - + + No compression. + - - GZIP compression. - + + GZIP compression. + - - BZIP2 compression. - + + BZIP2 compression. + @@ -382,45 +396,45 @@ - - A 3 digit octal string, specify the user, group and other modes - in the standard Unix fashion. Only applies to plain files. The - default is 644. - + + A 3 digit octal string, specify the user, group and other modes + in the standard Unix fashion. Only applies to plain files. The + default is 644. + - - A 3 digit octal string, specify the user, group and other modes - in the standard Unix fashion. Only applies to directories. The - default is 755. - + + A 3 digit octal string, specify the user, group and other modes + in the standard Unix fashion. Only applies to directories. The + default is 755. + - - The username for the tar entry. - + + The username for the tar entry. + - - The user identifier (UID) for the tar entry. - + + The user identifier (UID) for the tar entry. + - - The groupname for the tar entry. - + + The groupname for the tar entry. + - - The group identifier (GID) for the tar entry. - + + The group identifier (GID) for the tar entry. + - - The top level directory prefix. If set, all file and directory paths - in the fileset will have this value prepended. Can either be a single - directory name or a "/" separated path. - + + The top level directory prefix. If set, all file and directory paths + in the fileset will have this value prepended. Can either be a single + directory name or a "/" separated path. + @@ -474,11 +488,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -511,16 +525,16 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. - - Get the total number of files that are represented by the - filesets in this collection. - + + Get the total number of files that are represented by the + filesets in this collection. + @@ -535,28 +549,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -565,11 +579,11 @@ - - The top level directory prefix. If set, all file and directory paths - in the fileset will have this value prepended. Can either be a single - directory name or a "/" separated path. - + + The top level directory prefix. If set, all file and directory paths + in the fileset will have this value prepended. Can either be a single + directory name or a "/" separated path. + @@ -623,11 +637,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -660,16 +674,16 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. - - Get the total number of files that are represented by the - filesets in this collection. - + + Get the total number of files that are represented by the + filesets in this collection. + @@ -684,28 +698,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + diff --git a/Tools/nant/bin/NAnt.Core.dll b/Tools/nant/bin/NAnt.Core.dll index 6dd8f1b..1083a42 100755 Binary files a/Tools/nant/bin/NAnt.Core.dll and b/Tools/nant/bin/NAnt.Core.dll differ diff --git a/Tools/nant/bin/NAnt.Core.xml b/Tools/nant/bin/NAnt.Core.xml index b203ddf..f7d392b 100755 --- a/Tools/nant/bin/NAnt.Core.xml +++ b/Tools/nant/bin/NAnt.Core.xml @@ -11,9 +11,9 @@ - - Base class for all validator attributes. - + + Base class for all validator attributes. + @@ -36,50 +36,53 @@ cannot be converted to a . - - Indicates that property should be treated as a XML attribute for the - task. - - - Examples of how to specify task attributes - - #region Public Instance Properties - - [BuildAttribute("out", Required=true)] - public string Output { - get { return _out; } - set { _out = value; } - } - [BuildAttribute("optimize")] - [BooleanValidator()] - public bool Optimize { - get { return _optimize; } - set { _optimize = value; } - } - [BuildAttribute("warnlevel")] - [Int32Validator(0,4)] // limit values to 0-4 - public int WarnLevel { - get { return _warnLevel; } - set { _warnLevel = value; } - } - [BuildElement("sources")] - public FileSet Sources { - get { return _sources; } - set { _sources = value; } - } - - #endregion Public Instance Properties - - #region Private Instance Fields - - private string _out = null; - private bool _optimize = false; - private int _warnLevel = 4; - private FileSet _sources = new FileSet(); - - #endregion Private Instance Fields - - + + Indicates that property should be treated as a XML attribute for the + task. + + + Examples of how to specify task attributes + + #region Public Instance Properties + + [BuildAttribute("out", Required=true)] + public string Output { + get { return _out; } + set { _out = value; } + } + + [BuildAttribute("optimize")] + [BooleanValidator()] + public bool Optimize { + get { return _optimize; } + set { _optimize = value; } + } + + [BuildAttribute("warnlevel")] + [Int32Validator(0,4)] // limit values to 0-4 + public int WarnLevel { + get { return _warnLevel; } + set { _warnLevel = value; } + } + + [BuildElement("sources")] + public FileSet Sources { + get { return _sources; } + set { _sources = value; } + } + + #endregion Public Instance Properties + + #region Private Instance Fields + + private string _out = null; + private bool _optimize = false; + private int _warnLevel = 4; + private FileSet _sources = new FileSet(); + + #endregion Private Instance Fields + + @@ -91,85 +94,85 @@ is a zero-length . - - Gets or sets the name of the XML attribute. - - - The name of the XML attribute. - + + Gets or sets the name of the XML attribute. + + + The name of the XML attribute. + - - Gets or sets a value indicating whether the attribute is required. - - - if the attribute is required; otherwise, - . The default is . - + + Gets or sets a value indicating whether the attribute is required. + + + if the attribute is required; otherwise, + . The default is . + - - Gets or sets a value indicating whether property references should - be expanded. - - - if properties should be expanded; otherwise - . The default is . - + + Gets or sets a value indicating whether property references should + be expanded. + + + if properties should be expanded; otherwise + . The default is . + - - Used to specify how this attribute will be handled as the XML is - parsed and given to the element. - - - if XML should be processed; otherwise - . The default is . - + + Used to specify how this attribute will be handled as the XML is + parsed and given to the element. + + + if XML should be processed; otherwise + . The default is . + - - Indicates that property should be treated as a XML arrayList - - - - Should only be applied to properties exposing strongly typed arrays or - strongly typed collections. - - - The XML format is like this: - - - - - - - - ]]> - - - + + Indicates that property should be treated as a XML arrayList + + + + Should only be applied to properties exposing strongly typed arrays or + strongly typed collections. + + + The XML format is like this: + + + + + + + + ]]> + + + - - Indicates that the property should be treated as an XML element and - further processing should be done. - - - - The XML format is like this: - - - - - - - ]]> - - - + + Indicates that the property should be treated as an XML element and + further processing should be done. + + + + The XML format is like this: + + + + + + + ]]> + + + @@ -181,31 +184,31 @@ is a zero-length . - - Gets or sets the name of the attribute. - - - The name of the attribute. - + + Gets or sets the name of the attribute. + + + The name of the attribute. + - - Gets or sets a value indicating whether the attribute is required. - - - if the attribute is required; otherwise, - . The default is . - + + Gets or sets a value indicating whether the attribute is required. + + + if the attribute is required; otherwise, + . The default is . + - - Used to specify how this element will be handled as the XML is parsed - and given to the element. - - - if XML should be processed; otherwise - . The default is . - + + Used to specify how this element will be handled as the XML is parsed + and given to the element. + + + if XML should be processed; otherwise + . The default is . + @@ -235,31 +238,31 @@ is . - - Indicates that the property should be treated as a container for a - collection of build elements. - - - - Should only be applied to properties exposing strongly typed arrays or - strongly typed collections. - - - The XML format is like this: - - - - - - - - - - ]]> - - - + + Indicates that the property should be treated as a container for a + collection of build elements. + + + + Should only be applied to properties exposing strongly typed arrays or + strongly typed collections. + + + The XML format is like this: + + + + + + + + + + ]]> + + + @@ -272,15 +275,15 @@ is a zero-length . - - The name of the child element within the collection. - - - The name to check for in the XML of the elements in the collection. - - - This can be used for validation and schema generation. - + + The name of the child element within the collection. + + + The name to check for in the XML of the elements in the collection. + + + This can be used for validation and schema generation. + @@ -302,14 +305,14 @@ cannot be converted to a . - - Indicates that class should be treated as a NAnt element. - - - Attach this attribute to a subclass of Element to have NAnt be able - to recognize it. The name should be short but must not confict - with any other element already in use. - + + Indicates that class should be treated as a NAnt element. + + + Attach this attribute to a subclass of Element to have NAnt be able + to recognize it. The name should be short but must not confict + with any other element already in use. + @@ -321,18 +324,18 @@ is a zero-length . - - Gets or sets the name of the element. - - - The name of the element. - + + Gets or sets the name of the element. + + + The name of the element. + - - Indicates that a property should be treated as a XML file set for the - task. - + + Indicates that a property should be treated as a XML file set for the + task. + @@ -344,24 +347,24 @@ is a zero-length . - - Indicates that the value of the property to which the attribute is - assigned, can be configured on the framework-level in the NAnt application - configuration file. - - - - The following example shows a property of which the value can be - configured for a specific framework in the NAnt configuration file. - - - [FrameworkConfigurable("exename", Required=true)] - public virtual string ExeName { - get { return _exeName; } - set { _exeName = value; } - } - - + + Indicates that the value of the property to which the attribute is + assigned, can be configured on the framework-level in the NAnt application + configuration file. + + + + The following example shows a property of which the value can be + configured for a specific framework in the NAnt configuration file. + + + [FrameworkConfigurable("exename", Required=true)] + public virtual string ExeName { + get { return _exeName; } + set { _exeName = value; } + } + + @@ -373,30 +376,30 @@ is a zero-length . - - Gets or sets the name of the framework configuration attribute. - - The name of the framework configuration attribute. + + Gets or sets the name of the framework configuration attribute. + + The name of the framework configuration attribute. - - Gets or sets a value indicating whether the configuration attribute - is required. - - - if the configuration attribute is required; - otherwise, . The default is . - + + Gets or sets a value indicating whether the configuration attribute + is required. + + + if the configuration attribute is required; + otherwise, . The default is . + - - Gets or sets a value indicating whether property references should - be expanded. - - - if properties should be expanded; otherwise - . The default is . - + + Gets or sets a value indicating whether property references should + be expanded. + + + if properties should be expanded; otherwise + . The default is . + @@ -418,12 +421,12 @@ is a zero-length . - - Gets or sets the name of the function. - - - The name of the function. - + + Gets or sets the name of the function. + + + The name of the function. + @@ -453,23 +456,23 @@ - - Gets or sets the category of the function set. - - - The name of the category of the function set. - - - This will be displayed in the user docs. - + + Gets or sets the category of the function set. + + + The name of the category of the function set. + + + This will be displayed in the user docs. + - - Gets or sets the prefix of all functions in this function set. - - - The prefix of the functions in this function set. - + + Gets or sets the prefix of all functions in this function set. + + + The prefix of the functions in this function set. + @@ -526,30 +529,30 @@ - - The base of the number to validate, which must be 2, 8, 10, or 16. - - - The base of the number to validate. - - - The default is 10. - + + The base of the number to validate, which must be 2, 8, 10, or 16. + + + The base of the number to validate. + + + The default is 10. + - - Defines possible locations in which a task executable can be located. - + + Defines possible locations in which a task executable can be located. + - - Locates the task executable in the current Framework directory. - + + Locates the task executable in the current Framework directory. + - - Locates the task executable in the current Framework SDK directory. - + + Locates the task executable in the current Framework SDK directory. + @@ -605,15 +608,15 @@ is an empty string value and is set to . - - Gets or sets a value indicating whether an empty string or - should be a considered a valid value. - - - if an empty string or - should be considered a valid value; otherwise, . - The default is . - + + Gets or sets a value indicating whether an empty string or + should be a considered a valid value. + + + if an empty string or + should be considered a valid value; otherwise, . + The default is . + @@ -625,38 +628,41 @@ - - An optional error message that can be used to better describe the - regular expression error. - + + An optional error message that can be used to better describe the + regular expression error. + - - Indicates that property should be treated as a XML attribute for the - task. - - - Examples of how to specify task attributes - - // task XmlType default is string - [TaskAttribute("out", Required=true)] - string _out = null; // assign default value here - [TaskAttribute("optimize")] - [BooleanValidator()] - // during ExecuteTask you can safely use Convert.ToBoolean(_optimize) - string _optimize = Boolean.FalseString; - [TaskAttribute("warnlevel")] - [Int32Validator(0,4)] // limit values to 0-4 - // during ExecuteTask you can safely use Convert.ToInt32(_optimize) - string _warnlevel = "0"; - [BuildElement("sources")] - FileSet _sources = new FileSet(); - - NOTE: Attribute values must be of type of string if you want - to be able to have macros. The field stores the exact value during - Initialize. Just before ExecuteTask is called NAnt will expand - all the macros with the current values. - + + Indicates that property should be treated as a XML attribute for the + task. + + + Examples of how to specify task attributes + + // task XmlType default is string + [TaskAttribute("out", Required=true)] + string _out = null; // assign default value here + + [TaskAttribute("optimize")] + [BooleanValidator()] + // during ExecuteTask you can safely use Convert.ToBoolean(_optimize) + string _optimize = Boolean.FalseString; + + [TaskAttribute("warnlevel")] + [Int32Validator(0,4)] // limit values to 0-4 + // during ExecuteTask you can safely use Convert.ToInt32(_optimize) + string _warnlevel = "0"; + + [BuildElement("sources")] + FileSet _sources = new FileSet(); + + NOTE: Attribute values must be of type of string if you want + to be able to have macros. The field stores the exact value during + Initialize. Just before ExecuteTask is called NAnt will expand + all the macros with the current values. + @@ -668,14 +674,14 @@ is a zero-length . - - Indicates that class should be treated as a task. - - - Attach this attribute to a subclass of Task to have NAnt be able - to recognize it. The name should be short but must not confict - with any other task already in use. - + + Indicates that class should be treated as a task. + + + Attach this attribute to a subclass of Task to have NAnt be able + to recognize it. The name should be short but must not confict + with any other task already in use. + @@ -687,15 +693,15 @@ is a zero-length . - - Models a NAnt XML element in the build file. - - - - Automatically validates attributes in the element based on attributes - applied to members in derived classes. - - + + Models a NAnt XML element in the build file. + + + + Automatically validates attributes in the element based on attributes + applied to members in derived classes. + + @@ -710,30 +716,30 @@ The element that should be used to create a new instance of the class. - - Performs default initialization. - - - Derived classes that wish to add custom initialization should override - the method. - + + Performs default initialization. + + + Derived classes that wish to add custom initialization should override + the method. + - - Retrieves the location in the build file where the element is - defined. - - The element's build file location + + Retrieves the location in the build file where the element is + defined. + + The element's build file location - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the project. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the project. + @@ -747,11 +753,11 @@ - - Derived classes should override to this method to provide extra - initialization and validation not covered by the base class. - - The XML node of the element to use for initialization. + + Derived classes should override to this method to provide extra + initialization and validation not covered by the base class. + + The XML node of the element to use for initialization. @@ -770,33 +776,33 @@ - - Performs initialization using the given set of properties. - + + Performs initialization using the given set of properties. + - - Initializes all build attributes and child elements. - + + Initializes all build attributes and child elements. + - - Locates the XML node for the specified attribute in the project - configuration node. - - The name of attribute for which the XML configuration node should be located. - The framework to use to obtain framework specific information, or if no framework specific information should be used. - - The XML configuration node for the specified attribute, or - if no corresponding XML node could be - located. - - - If there's a valid current framework, the configuration section for - that framework will first be searched. If no corresponding - configuration node can be located in that section, the framework-neutral - section of the project configuration node will be searched. - + + Locates the XML node for the specified attribute in the project + configuration node. + + The name of attribute for which the XML configuration node should be located. + The framework to use to obtain framework specific information, or if no framework specific information should be used. + + The XML configuration node for the specified attribute, or + if no corresponding XML node could be + located. + + + If there's a valid current framework, the configuration section for + that framework will first be searched. If no corresponding + configuration node can be located in that section, the framework-neutral + section of the project configuration node will be searched. + @@ -824,12 +830,12 @@ - - Gets the name of the XML element used to initialize this element. - - - The name of the XML element used to initialize this element. - + + Gets the name of the XML element used to initialize this element. + + + The name of the XML element used to initialize this element. + @@ -861,21 +867,21 @@ - - Gets or sets the XML node of the element. - - - The XML node of the element. - + + Gets or sets the XML node of the element. + + + The XML node of the element. + - - Gets or sets the location in the build file where the element is - defined. - - - The location in the build file where the element is defined. - + + Gets or sets the location in the build file where the element is + defined. + + + The location in the build file where the element is defined. + @@ -955,10 +961,10 @@ - - Holds the dictionary that should be used for property - expansion. - + + Holds the dictionary that should be used for property + expansion. + @@ -969,21 +975,21 @@ - - Holds the names of the attributes that still need to be - processed. - + + Holds the names of the attributes that still need to be + processed. + - - Holds the names of the child nodes that still need to be - processed. - + + Holds the names of the child nodes that still need to be + processed. + - - Holds the logger for the current class. - + + Holds the logger for the current class. + @@ -1003,9 +1009,9 @@ - - Internal interface used for setting element attributes. - + + Internal interface used for setting element attributes. + @@ -1017,27 +1023,27 @@ - - The base of the directory of this dirlist. The default is the project - base directory. - + + The base of the directory of this dirlist. The default is the project + base directory. + - - Gets the collection of environment variables that should be passed - to external programs that are launched. - - - - The collection of environment variables that should be passed - to external programs that are launched. - - + + Gets the collection of environment variables that should be passed + to external programs that are launched. + + + + The collection of environment variables that should be passed + to external programs that are launched. + + - - The command-line arguments for the runtime engine. - + + The command-line arguments for the runtime engine. + @@ -1140,81 +1146,82 @@ is . - - Functions as a chainable TextReader - - - Implements a abstraction over a TextReader that allows the class to represent - either a TextReader or another ChainableReader to which it is chained. - By passing a ChainableReader as a constructor paramater it is possiable to - chain many ChainableReaders together. The last ChainableReader in the chain must - be based on a TextReader. - + + Functions as a chainable TextReader + + + Implements a abstraction over a TextReader that allows the class to represent + either a TextReader or another ChainableReader to which it is chained. + + By passing a ChainableReader as a constructor paramater it is possiable to + chain many ChainableReaders together. The last ChainableReader in the chain must + be based on a TextReader. + - - Makes it so all calls to Read and Peek are passed the ChainableReader - passed as a parameter. - - ChainableReader to forward calls to + + Makes it so all calls to Read and Peek are passed the ChainableReader + passed as a parameter. + + ChainableReader to forward calls to - - Makes it so all calls to Read and Peek are passed the TextReader - passed as a parameter. - - TextReader to forward calls to + + Makes it so all calls to Read and Peek are passed the TextReader + passed as a parameter. + + TextReader to forward calls to - - Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor. - - Character or -1 if end of stream + + Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor. + + Character or -1 if end of stream - - Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor. - - - Character or -1 if end of stream. - + + Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor. + + + Character or -1 if end of stream. + - - Closes the reader. - + + Closes the reader. + - - Calls close and supresses the finalizer for the object. - + + Calls close and supresses the finalizer for the object. + - - Gets a value indicating if the reader is backed by a stream in the - chain. - - - if the reader is backed by a stream; - otherwise, . - + + Gets a value indicating if the reader is backed by a stream in the + chain. + + + if the reader is backed by a stream; + otherwise, . + - - Allows a file's content to be modified while performing an operation. - + + Allows a file's content to be modified while performing an operation. + - - Called after construction and after properties are set. Allows - for filter initialization. - + + Called after construction and after properties are set. Allows + for filter initialization. + - - If then the filter will be used; otherwise, - skipped. The default is . - + + If then the filter will be used; otherwise, + skipped. The default is . + @@ -1329,11 +1336,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -1366,10 +1373,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -1390,28 +1397,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -1470,15 +1477,15 @@ - - Provides the abstract base class for types. - + + Provides the abstract base class for types. + - - Should be overridden by derived classes. clones the referenced types - data into the current instance. - + + Should be overridden by derived classes. clones the referenced types + data into the current instance. + @@ -1487,14 +1494,14 @@ - - The ID used to be referenced later. - + + The ID used to be referenced later. + - - The ID to use as the reference. - + + The ID to use as the reference. + @@ -1507,12 +1514,12 @@ - - Gets the name of the datatype. - - - The name of the datatype. - + + Gets the name of the datatype. + + + The name of the datatype. + @@ -1536,22 +1543,34 @@ The last in the chain. + + + Determines whether a given FilterChain is null or empty. + + + true if is null or empty; + otherwise, false. + + + The FilterChain to check. + + - - The filters to apply. - + + The filters to apply. + - - The encoding to assume when filter-copying files. The default is - system's current ANSI code page. - + + The encoding to assume when filter-copying files. The default is + system's current ANSI code page. + - - Configurator that initializes filters in the order in which they've - been specified in the build file. - + + Configurator that initializes filters in the order in which they've + been specified in the build file. + @@ -1605,11 +1624,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -1642,10 +1661,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -1660,28 +1679,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -1718,43 +1737,43 @@ - - Holds data for expression expansion between input and output. - + + Holds data for expression expansion between input and output. + - - Called after construction and after properties are set. Allows - for filter initialization. - + + Called after construction and after properties are set. Allows + for filter initialization. + - - Reads the next character applying the filter logic. - - Char as an int or -1 if at the end of the stream + + Reads the next character applying the filter logic. + + Char as an int or -1 if at the end of the stream - - Reads the next character applying the filter logic without advancing the current position in the stream. - - Char as an int or -1 if at the end of the stream + + Reads the next character applying the filter logic without advancing the current position in the stream. + + Char as an int or -1 if at the end of the stream - - Moves to the next character. - + + Moves to the next character. + - - Refills the buffer, running our input through - .) - + + Refills the buffer, running our input through + .) + - - Determines whether we've passed the end of our data. - + + Determines whether we've passed the end of our data. + @@ -1799,46 +1818,47 @@ - - Construct that allows this filter to be chained to the one - in the parameter chainedReader. - - Filter that the filter will be chained to + + Construct that allows this filter to be chained to the one + in the parameter chainedReader. + + Filter that the filter will be chained to - - Reads the next character applying the filter logic. - - Char as an int or -1 if at the end of the stream + + Reads the next character applying the filter logic. + + Char as an int or -1 if at the end of the stream - - Reads the next character applying the filter logic without - advancing the current position in the stream. - Peek currently is not supported. - - - Char as an int or -1 if at the end of the stream. - + + Reads the next character applying the filter logic without + advancing the current position in the stream. + + Peek currently is not supported. + + + Char as an int or -1 if at the end of the stream. + - - - Helper function used to search for the filter's traget string. If the string - is found the result is true. If the string was not found false is returned and - nonMatchingChars contains the characters that were read to determine if the - string is present. - - - - It is assumed the stream is positioned at the character after the first character - in the target string. - - - First character in target string - Ture if the stream ended while search for the string. - Characters that were read while searching for the string. - + + + Helper function used to search for the filter's traget string. If the string + is found the result is true. If the string was not found false is returned and + nonMatchingChars contains the characters that were read to determine if the + string is present. + + + + It is assumed the stream is positioned at the character after the first character + in the target string. + + + First character in target string + Ture if the stream ended while search for the string. + Characters that were read while searching for the string. + @@ -1849,35 +1869,35 @@ Char as an int or -1 if at the end of the stream - - Compares to characters taking into account the _ignoreCase flag. - - - - + + Compares to characters taking into account the _ignoreCase flag. + + + + - - The string to be replaced. - + + The string to be replaced. + - - The new value for the replaced string. - Am empty string is permissible. - + + The new value for the replaced string. + Am empty string is permissible. + - - Determines if case will be ignored. - The default is . - + + Determines if case will be ignored. + The default is . + - - Delegate for Read and Peek. Allows the same implementation - to be used for both methods. - + + Delegate for Read and Peek. Allows the same implementation + to be used for both methods. + @@ -1929,42 +1949,43 @@ - - Construct that allows this filter to be chained to the one - in the parameter chainedReader. - - Filter that the filter will be chained to + + Construct that allows this filter to be chained to the one + in the parameter chainedReader. + + Filter that the filter will be chained to - - Reads the next character applying the filter logic. - - Char as an int or -1 if at the end of the stream + + Reads the next character applying the filter logic. + + Char as an int or -1 if at the end of the stream - - Reads the next character applying the filter logic without - advancing the current position in the stream. - Peek currently is not supported. - - - Char as an int or -1 if at the end of the stream. - + + Reads the next character applying the filter logic without + advancing the current position in the stream. + + Peek currently is not supported. + + + Char as an int or -1 if at the end of the stream. + - - Initialize the filter by setting its parameters. - + + Initialize the filter by setting its parameters. + - - Finds a token give that we are positioned at a beginning token character. Either a - token replacement is returned or the characters that were read looking for the token. - - A token was not found - A token was found by there is no replacement - The stream ended while looking for the token - Either the replacement token or the characters that were read looking for the token + + Finds a token give that we are positioned at a beginning token character. Either a + token replacement is returned or the characters that were read looking for the token. + + A token was not found + A token was found by there is no replacement + The stream ended while looking for the token + Either the replacement token or the characters that were read looking for the token @@ -1984,31 +2005,31 @@ - - Marks the beginning of a token. The default is "@". - + + Marks the beginning of a token. The default is "@". + - - Marks the end of a token. The default is "@". - + + Marks the end of a token. The default is "@". + - - Tokens and replacement values. - + + Tokens and replacement values. + - - Determines if case will be ignored. - The default is . - + + Determines if case will be ignored. + The default is . + - - Delegate for Read and Peek. Allows the same implementation - to be used for both methods. - + + Delegate for Read and Peek. Allows the same implementation + to be used for both methods. + @@ -2033,24 +2054,24 @@ - - Construct that allows this filter to be chained to the one - in the parameter chainedReader. - - Filter that the filter will be chained to + + Construct that allows this filter to be chained to the one + in the parameter chainedReader. + + Filter that the filter will be chained to - - Retrieves the next character with moving the position in the stream. - This method is not implemented - - -1 if end of stream otherwise a character + + Retrieves the next character with moving the position in the stream. + This method is not implemented + + -1 if end of stream otherwise a character - - Retrieves the next character in the stream. - - -1 if end of stream otherwise a character + + Retrieves the next character in the stream. + + -1 if end of stream otherwise a character @@ -2061,21 +2082,21 @@ Char as an int or -1 if at the end of the stream - - The number of spaces used when converting a tab. The default is - "8". - + + The number of spaces used when converting a tab. The default is + "8". + - - Delegate for Read and Peek. Allows the same implementation - to be used for both methods. - + + Delegate for Read and Peek. Allows the same implementation + to be used for both methods. + - - Functions to return information for a given assembly. - + + Functions to return information for a given assembly. + @@ -2124,13 +2145,13 @@ - - Gets the full name of the assembly, also known as the display name. - - The assembly to get the full name for. - - The full name of the assembly, also known as the display name. - + + Gets the full name of the assembly, also known as the display name. + + The assembly to get the full name for. + + The full name of the assembly, also known as the display name. + @@ -2143,19 +2164,19 @@ - - Gets the physical location, in codebase format, of the loaded file - that contains the manifest. - - The assembly to get the location for. - - The location of the specified assembly. - + + Gets the physical location, in codebase format, of the loaded file + that contains the manifest. + + The assembly to get the location for. + + The location of the specified assembly. + - - Functions that return information about an assembly's identity. - + + Functions that return information about an assembly's identity. + @@ -2291,49 +2312,49 @@ - - Converts the argument to an integer. - - value to be converted - converted to integer. The function fails with an exception when the conversion is not possible. + + Converts the argument to an integer. + + value to be converted + converted to integer. The function fails with an exception when the conversion is not possible. - - Converts the argument to double - - The value to be converted. - converted to double. The function fails with an exception when the conversion is not possible. + + Converts the argument to double + + The value to be converted. + converted to double. The function fails with an exception when the conversion is not possible. - - Converts the argument to a string. - - The value to be converted. - - converted to string. The function fails - with an exception when the conversion is not possible. - - - Named method ConvertToString as a static ToString method would break - CLS compliance. - + + Converts the argument to a string. + + The value to be converted. + + converted to string. The function fails + with an exception when the conversion is not possible. + + + Named method ConvertToString as a static ToString method would break + CLS compliance. + - - Converts the argument to a datetime. - - value to be converted - converted to datetime. The function fails with an exception when the conversion is not possible. + + Converts the argument to a datetime. + + value to be converted + converted to datetime. The function fails with an exception when the conversion is not possible. - - Converts the argument to a boolean - - The string value to be converted to boolean. Must be 'true' or 'false'. - - converted to boolean. The function fails - with an exception when the conversion is not possible. - + + Converts the argument to a boolean + + The string value to be converted to boolean. Must be 'true' or 'false'. + + converted to boolean. The function fails + with an exception when the conversion is not possible. + @@ -2345,96 +2366,96 @@ - - Gets the year component of the specified date. - - The date of which to get the year component. - - The year, between 1 and 9999. - + + Gets the year component of the specified date. + + The date of which to get the year component. + + The year, between 1 and 9999. + - - Gets the month component of the specified date. - - The date of which to get the month component. - - The month, between 1 and 12. - + + Gets the month component of the specified date. + + The date of which to get the month component. + + The month, between 1 and 12. + - - Gets the day of the month represented by the specified date. - - The date of which to get the day of the month. - - The day value, between 1 and 31. - + + Gets the day of the month represented by the specified date. + + The date of which to get the day of the month. + + The day value, between 1 and 31. + - - Gets the hour component of the specified date. - - The date of which to get the hour component. - - The hour, between 0 and 23. - + + Gets the hour component of the specified date. + + The date of which to get the hour component. + + The hour, between 0 and 23. + - - Gets the minute component of the specified date. - - The date of which to get the minute component. - - The minute, between 0 and 59. - + + Gets the minute component of the specified date. + + The date of which to get the minute component. + + The minute, between 0 and 59. + - - Gets the seconds component of the specified date. - - The date of which to get the seconds component. - - The seconds, between 0 and 59. - + + Gets the seconds component of the specified date. + + The date of which to get the seconds component. + + The seconds, between 0 and 59. + - - Gets the milliseconds component of the specified date. - - The date of which to get the milliseconds component. - - The millisecond, between 0 and 999. - + + Gets the milliseconds component of the specified date. + + The date of which to get the milliseconds component. + + The millisecond, between 0 and 999. + - - Gets the number of ticks that represent the specified date. - - The date of which to get the number of ticks. - - The number of ticks that represent the date and time of the - specified date. - + + Gets the number of ticks that represent the specified date. + + The date of which to get the number of ticks. + + The number of ticks that represent the date and time of the + specified date. + - - Gets the day of the week represented by the specified date. - - The date of which to get the day of the week. - - The day of the week, ranging from zero, indicating Sunday, to six, - indicating Saturday. - + + Gets the day of the week represented by the specified date. + + The date of which to get the day of the week. + + The day of the week, ranging from zero, indicating Sunday, to six, + indicating Saturday. + - - Gets the day of the year represented by the specified date. - - The date of which to get the day of the year. - - The day of the year, between 1 and 366. - + + Gets the day of the year represented by the specified date. + + The date of which to get the day of the year. + + The day of the year, between 1 and 366. + @@ -2450,14 +2471,14 @@ is less than 1 or greater than 12. - - Returns an indication whether the specified year is a leap year. - - A 4-digit year. - - if is a leap year; - otherwise, . - + + Returns an indication whether the specified year is a leap year. + + A 4-digit year. + + if is a leap year; + otherwise, . + @@ -2490,10 +2511,26 @@ for the invariant culture. + + + Converts the specified to its equivalent + string representation. + + A to convert. + A format string. + + A string representation of formatted + using the specified format + + + is formatted with the + for the invariant culture. + + - - Groups a set of functions for dealing with directories. - + + Groups a set of functions for dealing with directories. + @@ -2583,28 +2620,28 @@ The specified path, file name, or both exceed the system-defined maximum length. - - Determines whether the given path refers to an existing directory - on disk. - - The path to test. - - if refers to an - existing directory; otherwise, . - - - Remove directory "test", if it exists. - - - ]]> - - + + Determines whether the given path refers to an existing directory + on disk. + + The path to test. + + if refers to an + existing directory; otherwise, . + + + Remove directory "test", if it exists. + + + ]]> + + - - Functions for requesting information from DNS. - + + Functions for requesting information from DNS. + @@ -2648,9 +2685,9 @@ - - Provide information about the current environment and platform. - + + Provide information about the current environment and platform. + @@ -2710,27 +2747,27 @@ - - Gets the user name of the person who started the current thread. - - - The name of the person logged on to the system who started the - current thread. - - - - Modify the home directory of the current user on unix-based systems. - - - - - - - - ]]> - - + + Gets the user name of the person who started the current thread. + + + The name of the person logged on to the system who started the + current thread. + + + + Modify the home directory of the current user on unix-based systems. + + + + + + + + ]]> + + @@ -2743,28 +2780,28 @@ Environment variable does not exist. - - Gets a value indicating whether the specified environment variable - exists. - - The environment variable that should be checked. - - if the environment variable exists; otherwise, - . - - - - Execute a set of tasks only if the "BUILD_DEBUG" environment - variable is set. - - - - ... - - ]]> - - + + Gets a value indicating whether the specified environment variable + exists. + + The environment variable that should be checked. + + if the environment variable exists; otherwise, + . + + + + Execute a set of tasks only if the "BUILD_DEBUG" environment + variable is set. + + + + ... + + ]]> + + @@ -2784,39 +2821,39 @@ - - Gets the newline string defined for this environment. - - - A string containing CRLF for non-Unix platforms, or LF for Unix - platforms. - - - Output two lines in a log file. - - - ]]> - - - - - - Groups a set of functions for dealing with files. - - - - Returns the creation date and time of the specified file. + Gets the newline string defined for this environment. - The file for which to obtain creation date and time information. - The creation date and time of the specified file. + A string containing CRLF for non-Unix platforms, or LF for Unix + platforms. - The specified file does not exist. - is a zero-length string, contains only white space, or contains one or more invalid characters. - The specified path, file name, or both exceed the system-defined maximum length. - The parameter is in an invalid format. + + Output two lines in a log file. + + + ]]> + + + + + + Groups a set of functions for dealing with files. + + + + + Returns the creation date and time of the specified file. + + The file for which to obtain creation date and time information. + + The creation date and time of the specified file. + + The specified file does not exist. + is a zero-length string, contains only white space, or contains one or more invalid characters. + The specified path, file name, or both exceed the system-defined maximum length. + The parameter is in an invalid format. @@ -2844,24 +2881,24 @@ The parameter is in an invalid format. - - Determines whether the specified file exists. - - The file to check. - - if refers to an - existing file; otherwise, . - - - Execute a set of tasks, if file "output.xml" does not exist. - - - ... - - ]]> - - + + Determines whether the specified file exists. + + The file to check. + + if refers to an + existing file; otherwise, . + + + Execute a set of tasks, if file "output.xml" does not exist. + + + ... + + ]]> + + @@ -2900,9 +2937,9 @@ The caller does not have path discovery permission. - - Functions that provide version information for a physical file on disk. - + + Functions that provide version information for a physical file on disk. + @@ -2954,14 +2991,14 @@ - - Checks whether the specified framework exists, and is valid. - - The framework to test. - - if the specified framework exists ; otherwise, - . - + + Checks whether the specified framework exists, and is valid. + + The framework to test. + + if the specified framework exists ; otherwise, + . + @@ -2976,20 +3013,20 @@ - - Gets the identifier of the current target framework. - - - The identifier of the current target framework. - + + Gets the identifier of the current target framework. + + + The identifier of the current target framework. + - - Gets the identifier of the runtime framework. - - - The identifier of the runtime framework. - + + Gets the identifier of the runtime framework. + + + The identifier of the runtime framework. + @@ -3257,58 +3294,58 @@ - - Rounds the value to the nearest whole number - - Number to be rounded, can be anything convertible to a double. - - Rounded value. - + + Rounds the value to the nearest whole number + + Number to be rounded, can be anything convertible to a double. + + Rounded value. + - - Returns the largest whole number less than or equal to the specified - number. - - value to be , can be anything convertible to a double - - The largest whole number less than or equal to the specified number. - + + Returns the largest whole number less than or equal to the specified + number. + + value to be , can be anything convertible to a double + + The largest whole number less than or equal to the specified number. + - - Returns the smallest whole number greater than or equal to the specified number - - value - - The smallest whole number greater than or equal to the specified number. - + + Returns the smallest whole number greater than or equal to the specified number + + value + + The smallest whole number greater than or equal to the specified number. + - - Returns the absolute value of the specified number - - value to take the absolute value from - - when is greater - than or equal to zero; otherwise, -. - + + Returns the absolute value of the specified number + + value to take the absolute value from + + when is greater + than or equal to zero; otherwise, -. + - - Gets the base directory of the appdomain in which NAnt is running. - - - The base directory of the appdomain in which NAnt is running. - + + Gets the base directory of the appdomain in which NAnt is running. + + + The base directory of the appdomain in which NAnt is running. + - - Gets the NAnt assembly. - - - The NAnt assembly. - + + Gets the NAnt assembly. + + + The NAnt assembly. + @@ -3440,34 +3477,34 @@ - - Gets the base directory of the current project. - - - The base directory of the current project. - + + Gets the base directory of the current project. + + + The base directory of the current project. + - - Checks whether the specified target exists. - - The target to test. - - if the specified target exists; otherwise, - . - - - - Execute target "clean", if it exists. - - - - - - ]]> - - + + Checks whether the specified target exists. + + The target to test. + + if the specified target exists; otherwise, + . + + + + Execute target "clean", if it exists. + + + + + + ]]> + + @@ -3491,14 +3528,14 @@ Target does not exist. - - Checks whether the specified task exists. - - The task to test. - - if the specified task exists; otherwise, - . - + + Checks whether the specified task exists. + + The task to test. + + if the specified task exists; otherwise, + . + @@ -3512,29 +3549,29 @@ Task is not available. - - Checks whether the specified property exists. - - The property to test. - - if the specified property exists; otherwise, - . - - - - Execute a set of tasks if the "build.debug" property - exists. - - - - - - - - ]]> - - + + Checks whether the specified property exists. + + The property to test. + + if the specified property exists; otherwise, + . + + + + Execute a set of tasks if the "build.debug" property + exists. + + + + + + + + ]]> + + @@ -3569,45 +3606,45 @@ - - Gets the name of the platform on which NAnt is running. - - - The name of the platform on which NAnt is running. - + + Gets the name of the platform on which NAnt is running. + + + The name of the platform on which NAnt is running. + - - Checks whether NAnt is running on Windows (and not just 32-bit Windows - as the name may lead you to believe). - - - if NAnt is running on Windows; - otherwise, . - + + Checks whether NAnt is running on Windows (and not just 32-bit Windows + as the name may lead you to believe). + + + if NAnt is running on Windows; + otherwise, . + - - Checks whether NAnt is running on Windows. - - - if NAnt is running on Windows; - otherwise, . - + + Checks whether NAnt is running on Windows. + + + if NAnt is running on Windows; + otherwise, . + - - Checks whether NAnt is running on Unix. - - - if NAnt is running on Unix; - otherwise, . - + + Checks whether NAnt is running on Unix. + + + if NAnt is running on Unix; + otherwise, . + - - Functions that return information about an operating system. - + + Functions that return information about an operating system. + @@ -3952,26 +3989,26 @@ - - Factory method to return a new instance of ExecTask - - - + + Factory method to return a new instance of ExecTask + + + - - Returns the length of the specified string. - - input string - - The string's length. - - - string::get-length('foo') ==> 3 - - - string::get-length('') ==> 0 - + + Returns the length of the specified string. + + input string + + The string's length. + + + string::get-length('foo') ==> 3 + + + string::get-length('') ==> 0 + @@ -4015,108 +4052,108 @@ - - Tests whether the specified string starts with the specified prefix - string. - - test string - prefix string - - when is a prefix for - the string . Meaning, the characters at the - beginning of are identical to - ; otherwise, . - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::starts-with('testing string', 'test') ==> true - - - string::starts-with('testing string', 'testing') ==> true - - - string::starts-with('testing string', 'string') ==> false - - - string::starts-with('test', 'testing string') ==> false - + + Tests whether the specified string starts with the specified prefix + string. + + test string + prefix string + + when is a prefix for + the string . Meaning, the characters at the + beginning of are identical to + ; otherwise, . + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::starts-with('testing string', 'test') ==> true + + + string::starts-with('testing string', 'testing') ==> true + + + string::starts-with('testing string', 'string') ==> false + + + string::starts-with('test', 'testing string') ==> false + - - Tests whether the specified string ends with the specified suffix - string. - - test string - suffix string - - when is a suffix for - the string . Meaning, the characters at the - end of are identical to - ; otherwise, . - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::ends-with('testing string', 'string') ==> true - - - string::ends-with('testing string', '') ==> true - - - string::ends-with('testing string', 'bring') ==> false - - - string::ends-with('string', 'testing string') ==> false - + + Tests whether the specified string ends with the specified suffix + string. + + test string + suffix string + + when is a suffix for + the string . Meaning, the characters at the + end of are identical to + ; otherwise, . + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::ends-with('testing string', 'string') ==> true + + + string::ends-with('testing string', '') ==> true + + + string::ends-with('testing string', 'bring') ==> false + + + string::ends-with('string', 'testing string') ==> false + - - Returns the specified string converted to lowercase. - - input string - - The string in lowercase. - - - The casing rules of the invariant culture are used to convert the - to lowercase. - - - string::to-lower('testing string') ==> 'testing string' - - - string::to-lower('Testing String') ==> 'testing string' - - - string::to-lower('Test 123') ==> 'test 123' - + + Returns the specified string converted to lowercase. + + input string + + The string in lowercase. + + + The casing rules of the invariant culture are used to convert the + to lowercase. + + + string::to-lower('testing string') ==> 'testing string' + + + string::to-lower('Testing String') ==> 'testing string' + + + string::to-lower('Test 123') ==> 'test 123' + - - Returns the specified string converted to uppercase. - - input string - - The string in uppercase. - - - The casing rules of the invariant culture are used to convert the - to uppercase. - - - string::to-upper('testing string') ==> 'TESTING STRING' - - - string::to-upper('Testing String') ==> 'TESTING STRING' - - - string::to-upper('Test 123') ==> 'TEST 123' - + + Returns the specified string converted to uppercase. + + input string + + The string in uppercase. + + + The casing rules of the invariant culture are used to convert the + to uppercase. + + + string::to-upper('testing string') ==> 'TESTING STRING' + + + string::to-upper('Testing String') ==> 'TESTING STRING' + + + string::to-upper('Test 123') ==> 'TEST 123' + @@ -4150,101 +4187,101 @@ - - Tests whether the specified string contains the given search string. - - The string to search. - The string to locate within . - - if is found in - ; otherwise, . - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::contains('testing string', 'test') ==> true - - - string::contains('testing string', '') ==> true - - - string::contains('testing string', 'Test') ==> false - - - string::contains('testing string', 'foo') ==> false - + + Tests whether the specified string contains the given search string. + + The string to search. + The string to locate within . + + if is found in + ; otherwise, . + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::contains('testing string', 'test') ==> true + + + string::contains('testing string', '') ==> true + + + string::contains('testing string', 'Test') ==> false + + + string::contains('testing string', 'foo') ==> false + - - Returns the position of the first occurrence in the specified string - of the given search string. - - The string to search. - The string to locate within . - - - The lowest-index position of in - if it is found, or -1 if - does not contain . - - - If is an empty string, the return value - will always be 0. - - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::index-of('testing string', 'test') ==> 0 - - - string::index-of('testing string', '') ==> 0 - - - string::index-of('testing string', 'Test') ==> -1 - - - string::index-of('testing string', 'ing') ==> 4 - + + Returns the position of the first occurrence in the specified string + of the given search string. + + The string to search. + The string to locate within . + + + The lowest-index position of in + if it is found, or -1 if + does not contain . + + + If is an empty string, the return value + will always be 0. + + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::index-of('testing string', 'test') ==> 0 + + + string::index-of('testing string', '') ==> 0 + + + string::index-of('testing string', 'Test') ==> -1 + + + string::index-of('testing string', 'ing') ==> 4 + - - Returns the position of the last occurrence in the specified string - of the given search string. - - The string to search. - The string to locate within . - - - The highest-index position of in - if it is found, or -1 if - does not contain . - - - If is an empty string, the return value - is the last index position in . - - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::last-index-of('testing string', 'test') ==> 0 - - - string::last-index-of('testing string', '') ==> 13 - - - string::last-index-of('testing string', 'Test') ==> -1 - - - string::last-index-of('testing string', 'ing') ==> 11 - + + Returns the position of the last occurrence in the specified string + of the given search string. + + The string to search. + The string to locate within . + + + The highest-index position of in + if it is found, or -1 if + does not contain . + + + If is an empty string, the return value + is the last index position in . + + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::last-index-of('testing string', 'test') ==> 0 + + + string::last-index-of('testing string', '') ==> 13 + + + string::last-index-of('testing string', 'Test') ==> -1 + + + string::last-index-of('testing string', 'ing') ==> 11 + @@ -4311,64 +4348,64 @@ - - Returns the given string trimmed of whitespace. - - input string - - The string with any leading or trailing - white space characters removed. - - - string::trim(' test ') ==> 'test' - - - string::trim('\t\tfoo \r\n') ==> 'foo' - - - - - Returns the given string trimmed of leading whitespace. - - input string - - The string with any leading - whites pace characters removed. - - - string::trim-start(' test ') ==> 'test ' - - - string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n' - - - - - Returns the given string trimmed of trailing whitespace. - - input string - - The string with any trailing - white space characters removed. - - - string::trim-end(' test ') ==> ' test' - - - string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo' - - - - Returns the total number of days represented by the specified - , expressed in whole and fractional days. + Returns the given string trimmed of whitespace. - A . + input string - The total number of days represented by the given . + The string with any leading or trailing + white space characters removed. + + string::trim(' test ') ==> 'test' + + + string::trim('\t\tfoo \r\n') ==> 'foo' + - + + + Returns the given string trimmed of leading whitespace. + + input string + + The string with any leading + whites pace characters removed. + + + string::trim-start(' test ') ==> 'test ' + + + string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n' + + + + + Returns the given string trimmed of trailing whitespace. + + input string + + The string with any trailing + white space characters removed. + + + string::trim-end(' test ') ==> ' test' + + + string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo' + + + + + Returns the total number of days represented by the specified + , expressed in whole and fractional days. + + A . + + The total number of days represented by the given . + + + Returns the total number of hours represented by the specified , expressed in whole and fractional hours. @@ -4703,17 +4740,17 @@ - - Provides the abstract base class for tasks. - - - A task is a piece of code that can be executed. - + + Provides the abstract base class for tasks. + + + A task is a piece of code that can be executed. + - - Executes the task unless it is skipped. - + + Executes the task unless it is skipped. + @@ -4785,61 +4822,61 @@ - - Initializes the configuration of the task using configuration - settings retrieved from the NAnt configuration file. - - - TO-DO : Remove this temporary hack when a permanent solution is - available for loading the default values from the configuration - file if a build element is constructed from code. - + + Initializes the configuration of the task using configuration + settings retrieved from the NAnt configuration file. + + + TO-DO : Remove this temporary hack when a permanent solution is + available for loading the default values from the configuration + file if a build element is constructed from code. + - Initializes the task. + Initializes the task. - Initializes the task. + Initializes the task. - Executes the task. + Executes the task. - - Locates the XML node for the specified attribute in either the - configuration section of the extension assembly or the.project. - - The name of attribute for which the XML configuration node should be located. - The framework to use to obtain framework specific information, or if no framework specific information should be used. - - The XML configuration node for the specified attribute, or - if no corresponding XML node could be - located. - - - If there's a valid current framework, the configuration section for - that framework will first be searched. If no corresponding - configuration node can be located in that section, the framework-neutral - section of the project configuration node will be searched. - + + Locates the XML node for the specified attribute in either the + configuration section of the extension assembly or the.project. + + The name of attribute for which the XML configuration node should be located. + The framework to use to obtain framework specific information, or if no framework specific information should be used. + + The XML configuration node for the specified attribute, or + if no corresponding XML node could be + located. + + + If there's a valid current framework, the configuration section for + that framework will first be searched. If no corresponding + configuration node can be located in that section, the framework-neutral + section of the project configuration node will be searched. + - - Determines if task failure stops the build, or is just reported. - The default is . - + + Determines if task failure stops the build, or is just reported. + The default is . + - - Determines whether the task should report detailed build log messages. - The default is . - + + Determines whether the task should report detailed build log messages. + The default is . + - - If then the task will be executed; otherwise, - skipped. The default is . - + + If then the task will be executed; otherwise, + skipped. The default is . + @@ -4849,14 +4886,14 @@ - - The name of the task. - + + The name of the task. + - - The prefix used when sending messages to the log. - + + The prefix used when sending messages to the log. + @@ -4880,42 +4917,42 @@ - - The name of the file which will have its attributes set. This is - provided as an alternate to using the task's fileset. - + + The name of the file which will have its attributes set. This is + provided as an alternate to using the task's fileset. + - - All the matching files and directories in this fileset will have - their attributes set. - + + All the matching files and directories in this fileset will have + their attributes set. + - - Set the archive attribute. The default is . - + + Set the archive attribute. The default is . + - - Set the hidden attribute. The default is . - + + Set the hidden attribute. The default is . + - - Set the normal file attributes. This attribute is only valid if used - alone. The default is . - + + Set the normal file attributes. This attribute is only valid if used + alone. The default is . + - - Set the read-only attribute. The default is . - + + Set the read-only attribute. The default is . + - - Set the system attribute. The default is . - + + Set the system attribute. The default is . + @@ -5064,189 +5101,320 @@ - - The resource which must be available. - + + The resource which must be available. + - - The type of resource which must be present. - + + The type of resource which must be present. + - - The property that must be set if the resource is available. - + + The property that must be set if the resource is available. + - - Defines the possible resource checks. - + + Defines the possible resource checks. + - - Determines whether a given file exists. - + + Determines whether a given file exists. + - - Determines whether a given directory exists. - + + Determines whether a given directory exists. + - - Determines whether a given framework is available. - + + Determines whether a given framework is available. + - - Determines whether a given SDK is available. - + + Determines whether a given SDK is available. + + + Calls a NAnt target in the current project. + + + + When the is used to execute a target, both that + target and all its dependent targets will be re-executed. + + + To avoid dependent targets from being executed more than once, two + options are available: + + + + + Add an "unless" attribute with value "${target::has-executed('<target name>')}" + to the dependent targets. + + + + + Set the attribute on the + to (recommended). + + + + + + + Call the target "build". + + + + ]]> + + + + + This shows how a project could 'compile' a debug and release build + using a common compile target. + + + + + + + + + + + + + + + + + + ]]> + + + The parameter of the + defaults to , + causing the "init" target to be executed for both + the "debug" and "release" build. + + + This results in the following build log: + + + build: + + init: + + [echo] initializing + + compile: + + [echo] compiling with debug = false + + init: + + [echo] initializing + + compile: + + [echo] compiling with debug = true + + BUILD SUCCEEDED + + + If the "init" should only be executed once, set the + attribute of the + to . + + + The build log would then look like this: + + + build: + + init: + + [echo] initializing + + compile: + + [echo] compiling with debug = false + + compile: + + [echo] compiling with debug = true + + BUILD SUCCEEDED + + + + + + Executes the specified target. + + + + + Makes sure the is not calling its own + parent. + + + + + NAnt target to call. + + + + + Force an execute even if the target has already been executed. The + default is . + + + + + Execute the specified targets dependencies -- even if they have been + previously executed. The default is . + + + - Calls a NAnt target in the current project. + + Executes an alternate set of task or type definition depending on + conditions that are individually set on each group. + - When the is used to execute a target, both that - target and all its dependent targets will be re-executed. + The selects one among a number of possible + alternatives. It consists of a sequence of <when> elements + followed by an optional <otherwise> element. - To avoid dependent targets from being executed more than once, two - options are available: + Each <when> element has a single attribute, test, which + specifies an expression. The content of the <when> and + <otherwise> elements is a set of nested tasks. + + + The content of the first, and only the first, <when> + element whose test is is executed. If no + <when> element is , the + content of the <otherwise> element is executed. + If no <when> element is , and no + <otherwise> element is present, nothing is done. - - - - Add an "unless" attribute with value "${target::has-executed('<target name>')}" - to the dependent targets. - - - - - Set the attribute on the - to (recommended). - - - - Call the target "build". + Execute alternate set of tasks depending on the configuration being + built. + + + + ... + + + + ... + + + Build configuration '${build.config}' is not supported! + + ]]> - This shows how a project could 'compile' a debug and release build - using a common compile target. + Define a sources patternset holding an alternate set of patterns + depending on the configuration being built. - - - - - - - - - - - - - - + + + + + + + + + + + + + + Build configuration '${build.config}' is not supported! + + ]]> - - The parameter of the - defaults to , - causing the "init" target to be executed for both - the "debug" and "release" build. - - - This results in the following build log: - - - build: - - init: - [echo] initializing - - compile: - - [echo] compiling with debug = false - - init: - - [echo] initializing - - compile: - - [echo] compiling with debug = true - - BUILD SUCCEEDED - - - If the "init" should only be executed once, set the - attribute of the - to . - - - The build log would then look like this: - - - build: - - init: - [echo] initializing - - compile: - - [echo] compiling with debug = false - - compile: - - [echo] compiling with debug = true - - BUILD SUCCEEDED - - - - Executes the specified target. - + + + One or more alternative sets of tasks to execute. + + The set of tasks to add. - + - Makes sure the is not calling its own - parent. + The set of tasks to execute if none of the + elements are . - - - NAnt target to call. - + + + Gets a value indicating whether a fallback element is defined. + + + if a fallback element is defined; otherwise, + . + - - - Force an execute even if the target has already been executed. The - default is . - + + + Groups a set of tasks to execute when a condition is met. + - - - Execute the specified targets dependencies -- even if they have been - previously executed. The default is . - + + + Executes embedded tasks/elements in the order in which they are defined. + + + + + Creates and executes the embedded (child XML nodes) elements. + + + + + Gets a value indicating whether the element is performing additional + processing using the that was use to + initialize the element. + + + , as a is + responsable for creating tasks from the nested build elements. + + + + + Used to test arbitrary boolean expression. + @@ -5259,8 +5427,38 @@ explicitly overwrite files with the attribute. - When a is used to select files to copy, the - attribute must be set. Files that are + Entire directory structures can be copied to a new location. For this + to happen, the following criteria must be met: + + + + + Everything in the fileset is included + + + + + The directory structure is not flattened + + + + + Empty directories are included + + + + + Destination directory does not exist + + + + + If any of these items are not met, then the files within the source + directory will be copied over instead of the entire directory structure. + + + When a is used to select files or directories to + copy, the attribute must be set. Files that are located under the base directory of the will be copied to a directory under the destination directory matching the path relative to the base directory of the , @@ -5341,7 +5539,7 @@ + ]]> @@ -5354,9 +5552,9 @@ - - Checks whether the task is initialized with valid attributes. - + + Checks whether the task is initialized with valid attributes. + @@ -5365,30 +5563,30 @@ A file that has to be copied does not exist or could not be copied. - - Actually does the file copies. - + + Actually does the file copies. + - - The file to copy. - + + The file to copy. + - - The file to copy to. - + + The file to copy to. + - - The directory to copy to. - + + The directory to copy to. + - - Overwrite existing files even if the destination files are newer. - The default is . - + + Overwrite existing files even if the destination files are newer. + The default is . + @@ -5410,21 +5608,21 @@ - - Chain of filters used to alter the file's content as it is copied. - + + Chain of filters used to alter the file's content as it is copied. + - - The encoding to use when reading files. The default is the system's - current ANSI code page. - + + The encoding to use when reading files. The default is the system's + current ANSI code page. + - - The encoding to use when writing the files. The default is - the encoding of the input file. - + + The encoding to use when writing the files. The default is + the encoding of the input file. + @@ -5432,10 +5630,16 @@ - The key of the is the absolute path of + FileCopyMap should now be considered a readonly hashtable. Any changes to + this property will not be taken into account during the file operation + task. To interact with the file operation, use the + property. + + + The key of the is the absolute path of the destination file and the value is a holding the path and last write time of the most recently updated - source file that is selected to be copied or moved to the + source file that is selected to be copied or moved to the destination file. @@ -5443,34 +5647,389 @@ - - - Holds the absolute paths and last write time of a given file. - - - + - Initializes a new instance of the - class for the specified file and last write time. + Gets the operation map containing all the files/directories to + perform file operations on. + + + + The type of class for this object inherits from KeyedCollection + and is structured so that the key of this collection contains the + full path of the target file/location while the value contains + the object + with the operation details. + + + On Windows, the + is case-insensitive. + + + + + + Holds the absolute paths and last write time of a given file. + + + + + Initializes a new instance of the + class + for the specified . + + + A object containing + the full path and last write time of the file the object represents. + + + + + Initializes a new instance of the + class for the specified file and last write time. The absolute path of the file. The last write time of the file. - - Gets the absolute path of the current file. - - - The absolute path of the current file. - + + Gets the absolute path of the current file. + + + The absolute path of the current file. + - - Gets the time when the current file was last written to. - - - The time when the current file was last written to. - + + Gets the time when the current file was last written to. + + + The time when the current file was last written to. + + + + + Provides methods and properties to properly manage file operations for + NAnt file system based tasks (such as CopyTask and MoveTask). + + + + + Initializes a new instance of the + class with the + source and target locations specified. + + + A object representing the file/location + where the file operation will start. + + + A object representing the file/location + where the file operation will end. + + + + + Normalizes the attributes of + . + + + + + Checks to see whether or not the full path of + + matches the full path of + . + + + is + used to check path equality. + + + true if both paths match; otherwise false. + + + + + Checks to see whether or not the full path of + + is identical to the full path of + . + + + The difference between this method and SourceEqualsTarget is + that the casing of the path is never ignored regardless of + operating system. + + + true if both paths are identical; otherwise false. + + + + + Updates the source of a given instance based on the + . + + If the LastWriteTime property of the + is greater than the LastWriteTime property of + , then + is + replaced with . + + + + The new to replace + the current + object. + + + + + Returns a that represents the current + . + + + A that represents the current + . + + + + + Checks to see if a given + target is considered outdated. + + + A used for comparison purposes + against . + + + The to check. + + + true if the target file is considered out of date; otherwise + false + + + + + Checks to see if the target directory does not exist or that + it does match the source directory name but not string casing. + + + Source directory to check against . + + + The target directory to validate. + + + true if the target directory does not exist or matches the source + directory name but not casing; otherwise false + + + + + Checks to see whether is a file type or + a directory type. + + + The FileSystemInfo type used to compare with. + + + The object to check. + + + true if is the same type as + ; otherwise, false. + + + + + Gets or sets the string comparer to use when comparing + the source path to the target path. + + + + + Gets the full path of + . + + + + + Gets the details of the source path. + + + + + Gets the type of + . + + + + + Gets the type of the file operation an instance of + represents. + + + + + Gets a value indicating whether + is + outdated. + + + true if + is + outdated (or simply a directory); otherwise, false. + + + + + Gets the full path of + . + + + + + Gets the details of the target path. + + + + + Gets the type of + . + + + + + A collection class used to track all of the + objects for + a given file operation task (such as the CopyTask or MoveTask). + + + + + The StringComparer used when comparing file paths. + + + + + Initializes a new instance of the + + class that uses the default string comparer. + + + + + Initializes a new instance of the + + class that uses the specified string comparer. + + + The string comparer to use when comparing keys in the + . + + + + + Determines whether the + contains the + specified key. + + + The key to locate in the + . + + + true if the + contains an element with the specified key; otherwise, false. + + + + + Counts the number of directory operations in a collection. + + + The number of directory operations performed by this collection. + + + + + Counts the number of file operations in a collection. + + + The number of file operations performed by this collection. + + + + + Converts the current instance of + to + the old style FileCopyMap hashtable. + + + The contents of + in a + new hashtable. + + + + + Extracts the key from the specified + element. + + + The from which to + extract the key. + + + The key for the specified + . + + + + + Inserts an element into the + at the + specified index. + + + The zero-based index at which item should be inserted. + + + The to insert. + + + + + Replaces the item at the specified index with the specified item. + + + The zero-based index of the item to be replaced. + + + The new item. + + + + + Used to identify the type of operation a given + represent. + + + + + Indicates that the operation is from file to file. + + + + + Indicates that the operation is from file to directory. + + + + + Indicates that the operation is from directory to directory. + @@ -5532,19 +6091,19 @@ - - Ensures the supplied attributes are valid. - + + Ensures the supplied attributes are valid. + - - The file to delete. - + + The file to delete. + - - The directory to delete. - + + The directory to delete. + @@ -5553,28 +6112,28 @@ - - All the files in the file set will be deleted. - + + All the files in the file set will be deleted. + - - Controls whether to show the name of each deleted file or directory. - The default is . - + + Controls whether to show the name of each deleted file or directory. + The default is . + - - An empty task that allows a build file to contain a description. - - - Set a description. - - This is a description. - ]]> - - + + An empty task that allows a build file to contain a description. + + + Set a description. + + This is a description. + ]]> + + @@ -5663,33 +6222,33 @@ - - Outputs the message to the build log or the specified file. - + + Outputs the message to the build log or the specified file. + - - The encoding to use when writing message to a file. The default is - UTF-8 encoding without a Byte Order Mark (BOM). - + + The encoding to use when writing message to a file. The default is + UTF-8 encoding without a Byte Order Mark (BOM). + - - The message to output. - + + The message to output. + - - Gets or sets the inline content that should be output. - - - The inline content that should be output. - + + Gets or sets the inline content that should be output. + + + The inline content that should be output. + - - The file to write the message to. - + + The file to write the message to. + @@ -5791,9 +6350,9 @@ - - Will be used to ensure thread-safe operations. - + + Will be used to ensure thread-safe operations. + @@ -5819,14 +6378,14 @@ The that was started. - - Reads from the stream until the external program is ended. - + + Reads from the stream until the external program is ended. + - - Reads from the stream until the external program is ended. - + + Reads from the stream until the external program is ended. + @@ -5838,53 +6397,53 @@ The task is not available or not configured for the current framework. - - The name of the executable that should be used to launch the - external program. - - - The name of the executable that should be used to launch the external - program, or if no name is specified. - - - If available, the configured value in the NAnt configuration - file will be used if no name is specified. - + + The name of the executable that should be used to launch the + external program. + + + The name of the executable that should be used to launch the external + program, or if no name is specified. + + + If available, the configured value in the NAnt configuration + file will be used if no name is specified. + - - Gets the filename of the external program to start. - - - The filename of the external program. - - - Override in derived classes to explicitly set the location of the - external tool. - + + Gets the filename of the external program to start. + + + The filename of the external program. + + + Override in derived classes to explicitly set the location of the + external tool. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Gets the file to which the standard output should be redirected. - - - The file to which the standard output should be redirected, or - if the standard output should not be - redirected. - - - The default implementation will never allow the standard output - to be redirected to a file. Deriving classes should override this - property to change this behaviour. - + + Gets the file to which the standard output should be redirected. + + + The file to which the standard output should be redirected, or + if the standard output should not be + redirected. + + + The default implementation will never allow the standard output + to be redirected to a file. Deriving classes should override this + property to change this behaviour. + @@ -5897,23 +6456,23 @@ - - Gets the working directory for the application. - - - The working directory for the application. - + + Gets the working directory for the application. + + + The working directory for the application. + - - The maximum amount of time the application is allowed to execute, - expressed in milliseconds. Defaults to no time-out. - + + The maximum amount of time the application is allowed to execute, + expressed in milliseconds. Defaults to no time-out. + - - The command-line arguments for the external program. - + + The command-line arguments for the external program. + @@ -5992,31 +6551,31 @@ - - Gets the value that the process specified when it terminated. - - - The code that the associated process specified when it terminated, - or -1000 if the process could not be started or did not - exit (in time). - + + Gets the value that the process specified when it terminated. + + + The code that the associated process specified when it terminated, + or -1000 if the process could not be started or did not + exit (in time). + - - Gets the unique identifier for the spawned application. - + + Gets the unique identifier for the spawned application. + - - Gets or sets a value indicating whether the application should be - spawned. If you spawn an application, its output will not be logged - by NAnt. The default is . - + + Gets or sets a value indicating whether the application should be + spawned. If you spawn an application, its output will not be logged + by NAnt. The default is . + - - Gets the command-line arguments, separated by spaces. - + + Gets the command-line arguments, separated by spaces. + @@ -6025,19 +6584,19 @@ does not hold a valid file name. - - Executes the external program. - + + Executes the external program. + - - The program to execute without command arguments. - - - The path will not be evaluated to a full path using the project - base directory. - - + + The program to execute without command arguments. + + + The path will not be evaluated to a full path using the project + base directory. + + The command-line arguments for the program. These will be @@ -6047,24 +6606,24 @@ - - Environment variables to pass to the program. - + + Environment variables to pass to the program. + - - The directory in which the command will be executed. - - - The directory in which the command will be executed. The default - is the project's base directory. - - - - The working directory will be evaluated relative to the project's - base directory if it is relative. - - + + The directory in which the command will be executed. + + + The directory in which the command will be executed. The default + is the project's base directory. + + + + The working directory will be evaluated relative to the project's + base directory if it is relative. + + @@ -6080,64 +6639,64 @@ - - Specifies whether the external program should be executed using a - runtime engine, if configured. The default is . - - - if the external program should be executed - using a runtime engine; otherwise, . - + + Specifies whether the external program should be executed using a + runtime engine, if configured. The default is . + + + if the external program should be executed + using a runtime engine; otherwise, . + - - Specifies whether the external program is a managed application - which should be executed using a runtime engine, if configured. - The default is . - - - if the external program should be executed - using a runtime engine; otherwise, . - + + Specifies whether the external program is a managed application + which should be executed using a runtime engine, if configured. + The default is . + + + if the external program should be executed + using a runtime engine; otherwise, . + - - Gets the filename of the external program to start. - - - The filename of the external program. - + + Gets the filename of the external program to start. + + + The filename of the external program. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - The directory the program is in. - - - - The directory the program is in. The default is the project's base - directory. - - - The basedir will be evaluated relative to the project's base - directory if it is relative. - - + + The directory the program is in. + + + + The directory the program is in. The default is the project's base + directory. + + + The basedir will be evaluated relative to the project's base + directory if it is relative. + + - - The file to which the standard output will be redirected. - - - By default, the standard output is redirected to the console. - + + The file to which the standard output will be redirected. + + + By default, the standard output is redirected to the console. + @@ -6150,11 +6709,11 @@ - - Gets or sets a value indicating whether the application should be - spawned. If you spawn an application, its output will not be logged - by NAnt. The default is . - + + Gets or sets a value indicating whether the application should be + spawned. If you spawn an application, its output will not be logged + by NAnt. The default is . + @@ -6275,69 +6834,69 @@ - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Sets the timestamp of a given file to a specified time. - + + Sets the timestamp of a given file to a specified time. + - - The URL from which to retrieve a file. - + + The URL from which to retrieve a file. + - - The file where to store the retrieved file. - + + The file where to store the retrieved file. + - - If inside a firewall, proxy server/port information - Format: {proxy server name}:{port number} - Example: proxy.mycompany.com:8080 - + + If inside a firewall, proxy server/port information + Format: {proxy server name}:{port number} + Example: proxy.mycompany.com:8080 + - - The network proxy to use to access the Internet resource. - + + The network proxy to use to access the Internet resource. + - - The network credentials used for authenticating the request with - the Internet resource. - + + The network credentials used for authenticating the request with + the Internet resource. + - - Log errors but don't treat as fatal. The default is . - + + Log errors but don't treat as fatal. The default is . + - - Conditionally download a file based on the timestamp of the local - copy. HTTP only. The default is . - + + Conditionally download a file based on the timestamp of the local + copy. HTTP only. The default is . + - - The length of time, in milliseconds, until the request times out. - The default is 100000 milliseconds. - + + The length of time, in milliseconds, until the request times out. + The default is 100000 milliseconds. + - - The security certificates to associate with the request. - + + The security certificates to associate with the request. + @@ -6491,16 +7050,16 @@ - - Executes embedded tasks in the order in which they are defined. - + + Executes embedded tasks in the order in which they are defined. + - - Automatically exclude build elements that are defined on the task - from things that get executed, as they are evaluated normally during - XML task initialization. - + + Automatically exclude build elements that are defined on the task + from things that get executed, as they are evaluated normally during + XML task initialization. + @@ -6523,14 +7082,14 @@ - - The file to compare if uptodate. - + + The file to compare if uptodate. + - - The file to check against for the uptodate file. - + + The file to check against for the uptodate file. + @@ -6545,188 +7104,188 @@ - - Used to test whether a property is true. - + + Used to test whether a property is true. + - - Used to test whether a property exists. - + + Used to test whether a property exists. + - - Used to test whether a target exists. - + + Used to test whether a target exists. + - - Used to test arbitrary boolean expression. - + + Used to test arbitrary boolean expression. + - - The opposite of the if task. - - - Check that a property does not exist. - - - - - ]]> - - Check that a property value is not true. - - - - - ]]> - - - - Check that a target does not exist. - - - - - ]]> - - + + The opposite of the if task. + + + Check that a property does not exist. + + + + + ]]> + + Check that a property value is not true. + + + + + ]]> + + + + Check that a target does not exist. + + + + + ]]> + + - - Includes an external build file. - - - - This task is used to break your build file into smaller chunks. You - can load a partial build file and have it included into the build file. - - - Any global (project level) tasks in the included build file are executed - when this task is executed. Tasks in target elements are only executed - if that target is executed. - - - The project element attributes are ignored. - - - This task can only be in the global (project level) section of the - build file. - - - This task can only include files from the file system. - - - - - Include a task that fetches the project version from the - GetProjectVersion.include build file. - - - - ]]> - - + + Includes an external build file. + + + + This task is used to break your build file into smaller chunks. You + can load a partial build file and have it included into the build file. + + + Any global (project level) tasks in the included build file are executed + when this task is executed. Tasks in target elements are only executed + if that target is executed. + + + The project element attributes are ignored. + + + This task can only be in the global (project level) section of the + build file. + + + This task can only include files from the file system. + + + + + Include a task that fetches the project version from the + GetProjectVersion.include build file. + + + + ]]> + + - - Used to check for recursived includes. - + + Used to check for recursived includes. + - - Verifies parameters. - + + Verifies parameters. + - - Build file to include. - + + Build file to include. + - - Load a text file into a single property. - - - - Unless an encoding is specified, the encoding associated with the - system's current ANSI code page is used. - - - An UTF-8, little-endian Unicode, and big-endian Unicode encoded text - file is automatically recognized, if the file starts with the appropriate - byte order marks. - - - - - Load file message.txt into property "message". - - - - ]]> - - - - - Load a file using the "latin-1" encoding. - - - - ]]> - - - - - Load a file, replacing all @NOW@ tokens with the current - date/time. - - - - - - - - - - ]]> - - + + Load a text file into a single property. + + + + Unless an encoding is specified, the encoding associated with the + system's current ANSI code page is used. + + + An UTF-8, little-endian Unicode, and big-endian Unicode encoded text + file is automatically recognized, if the file starts with the appropriate + byte order marks. + + + + + Load file message.txt into property "message". + + + + ]]> + + + + + Load a file using the "latin-1" encoding. + + + + ]]> + + + + + Load a file, replacing all @NOW@ tokens with the current + date/time. + + + + + + + + + + ]]> + + - - The file to load. - + + The file to load. + - - The name of the property to save the content to. - + + The name of the property to save the content to. + - - The encoding to use when loading the file. The default is the encoding - associated with the system's current ANSI code page. - + + The encoding to use when loading the file. The default is the encoding + associated with the system's current ANSI code page. + - - The filterchain definition to use. - + + The filterchain definition to use. + @@ -6783,128 +7342,128 @@ Both and are set. - - An assembly to load tasks from. - + + An assembly to load tasks from. + - - A directory to scan for task assemblies. - + + A directory to scan for task assemblies. + - - Used to select which directories or individual assemblies to scan. - + + Used to select which directories or individual assemblies to scan. + - - Loops over a set of items. - - - - Can loop over files in directory, lines in a file, etc. - - - The property value is stored before the loop is done, and restored - when the loop is finished. - - - The property is returned to its normal value once it is used. Read-only - parameters cannot be overridden in this loop. - - - - Loops over the files in c:\. - - - - - ]]> - - - - Loops over all files in the project directory. - - - - - - - - - - - - ]]> - - - - Loops over the folders in c:\. - - - - - ]]> - - - - Loops over all folders in the project directory. - - - - - - - - - - - - ]]> - - - - Loops over a list. - - - - - ]]> - - - - - Loops over lines in the file properties.csv, where each line - is of the format name,value. - - - - - - ]]> - - + + Loops over a set of items. + + + + Can loop over files in directory, lines in a file, etc. + + + The property value is stored before the loop is done, and restored + when the loop is finished. + + + The property is returned to its normal value once it is used. Read-only + parameters cannot be overridden in this loop. + + + + Loops over the files in c:\. + + + + + ]]> + + + + Loops over all files in the project directory. + + + + + + + + + + + + ]]> + + + + Loops over the folders in c:\. + + + + + ]]> + + + + Loops over all folders in the project directory. + + + + + + + + + + + + ]]> + + + + Loops over a list. + + + + + ]]> + + + + + Loops over lines in the file properties.csv, where each line + is of the format name,value. + + + + + + ]]> + + - - The NAnt property name(s) that should be used for the current - iterated item. - - - If specifying multiple properties, separate them with a comma. - + + The NAnt property name(s) that should be used for the current + iterated item. + + + If specifying multiple properties, separate them with a comma. + - - The type of iteration that should be done. - + + The type of iteration that should be done. + @@ -6913,14 +7472,14 @@ - - The source of the iteration. - + + The source of the iteration. + - - The deliminator char. - + + The deliminator char. + @@ -6934,162 +7493,323 @@ - - Tasks to execute for each matching item. - + + Tasks to execute for each matching item. + - - Do not remove any white space characters. - - + + Do not remove any white space characters. + + - - Remove all white space characters from the end of the current - item. - + + Remove all white space characters from the end of the current + item. + - - Remove all white space characters from the beginning of the - current item. - + + Remove all white space characters from the beginning of the + current item. + - - Remove all white space characters from the beginning and end of - the current item. - + + Remove all white space characters from the beginning and end of + the current item. + - - Sends an SMTP message. - - - - Text and text files to include in the message body may be specified as - well as binary attachments. - - - - - Sends an email from nant@sourceforge.net to three recipients - with a subject about the attachments. The body of the message will be - the combined contents of all .txt files in the base directory. - All zip files in the base directory will be included as attachments. - The message will be sent using the smtpserver.anywhere.com SMTP - server. - - - - - - - - - - - ]]> - - + + Sends an SMTP message. + + + + Text and text files to include in the message body may be specified as + well as binary attachments. + + + + + Sends an email from nant@sourceforge.net to three recipients + with a subject about the attachments. The body of the message will be + the combined contents of all .txt files in the base directory. + All zip files in the base directory will be included as attachments. + The message will be sent using the smtpserver.anywhere.com SMTP + server. + + + + + + + + + + + ]]> + + + + + Sends an email from a gmail account to multiple recipients. This example + illustrates how to add a recipient's name to an email address. + + + + ]]> + + + Email addresses in any of the lists (to, cc, bcc, from) can be in one of + the five listed formats below. + + + + Full Name <address@abcxyz.com> + + + <address@abcxyz.com> Full Name + + + (Full Name) address@abcxyz.com + + + address@abcxyz.com (Full Name) + + + address@abcxyz.com + + + + Remember to use &gt; and &lt; XML entities for the angle brackets. + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done. - + + This is where the work is done. + - - Reads a text file and returns the content - in a string. - - The file to read content of. - - The content of the specified file. - + + Reads a text file and returns the content + in a string. + + The file to read content of. + + The content of the specified file. + + + + + Converts an email address or a series of email addresses from + a object to a new + object. + + + A list of email addresses separated by a semicolon. + + + A new object + containing the addresses from . + + + + + Converts a object containing + email address information to a + object. + + + + Email address information passed to this method should be in + one of five formats. + + + + Full Name <address@abcxyz.com> + + + <address@abcxyz.com> Full Name + + + (Full Name) address@abcxyz.com + + + address@abcxyz.com (Full Name) + + + address@abcxyz.com + + + + If the full name of the intended recipient (or sender) is provided, + that information is included in the resulting + object. + + + + The string that contains the address to parse. + + + A new MailAddress object containing the information from + . + + + + + Simple method that converts an XML escaped string back to its unescaped + format. + + + An html encoded string. + + + The decoded format of the html encoded string. + - - Email address of sender. - + + Email address of sender. + - - Semicolon-separated list of recipient email addresses. - + + Semicolon-separated list of recipient email addresses. + + + + + Reply to email address. + - - Semicolon-separated list of CC: recipient email addresses. - + + Semicolon-separated list of CC: recipient email addresses. + - - Semicolon-separated list of BCC: recipient email addresses. - + + Semicolon-separated list of BCC: recipient email addresses. + - - Host name of mail server. The default is localhost. - + + Host name of mail server. The default is localhost. + + + + + The port number used to connect to the mail server. + The default is 25. + + + + + Indicates whether or not ssl should be used to + connect to the smtp host. + - - Text to send in body of email message. - + + Text to send in body of email message. + - - Text to send in subject line of email message. - + + Text to send in subject line of email message. + + + + + Indicates whether or not the body of the email is in + html format. The default value is false. + + + + + The username to use when connecting to the smtp host. + + + + + The password to use when connecting to the smtp host. + - Format of the message. The default is . + Format of the message. The default is . - - Files that are transmitted as part of the body of the email message. - + + Files that are transmitted as part of the body of the email message. + - - Attachments that are transmitted with the message. - + + Attachments that are transmitted with the message. + + + + + Temporary enum replacement of + to ease transition to newer property flags. + + + + + Indicates the body of the email is formatted in plain text. + + + + + Indicates the body of the email is formatted in html. + - - Creates a directory and any non-existent parent directory if necessary. - - - Create the directory build. - - - ]]> - - - - Create the directory tree one/two/three. - - - ]]> - - + + Creates a directory and any non-existent parent directory if necessary. + + + Create the directory build. + + + ]]> + + + + Create the directory tree one/two/three. + + + ]]> + + @@ -7098,9 +7818,9 @@ The directory could not be created. - - The directory to create. - + + The directory to create. + @@ -7114,8 +7834,38 @@ attribute. - A can be used to select files to move. To use - a , the + Entire directory structures can be moved to a new location. For this + to happen, the following criteria must be met: + + + + + Everything in the fileset is included + + + + + The directory structure is not flattened + + + + + Empty directories are included + + + + + Destination directory does not exist + + + + + If any of these items are not met, then the files within the source + directory will be moved over instead of the entire directory structure. + + + A can be used to select files or directories to move. + To use a , the attribute must be set.

Encoding

@@ -7187,7 +7937,7 @@ + ]]> @@ -7195,24 +7945,24 @@ - - Actually does the file moves. - + + Actually does the file moves. + - - The file to move. - + + The file to move. + - - The file to move to. - + + The file to move to. + - - The directory to move to. - + + The directory to move to. + @@ -7228,38 +7978,38 @@ - - Chain of filters used to alter the file's content as it is moved. - + + Chain of filters used to alter the file's content as it is moved. + - - Creates an XSD File for all available tasks. - - - - This can be used in conjuntion with the command-line option to do XSD - Schema validation on the build file. - - - - Creates a NAnt.xsd file in the current project directory. - - - ]]> - - + + Creates an XSD File for all available tasks. + + + + This can be used in conjuntion with the command-line option to do XSD + Schema validation on the build file. + + + + Creates a NAnt.xsd file in the current project directory. + + + ]]> + + - - Creates a NAnt Schema for given types - - The output stream to save the schema to. If , writing is ignored, no exception generated. - The list of tasks to generate XML Schema for. - The list of datatypes to generate XML Schema for. - The target namespace to output. - The new NAnt Schema. + + Creates a NAnt Schema for given types + + The output stream to save the schema to. If , writing is ignored, no exception generated. + The list of tasks to generate XML Schema for. + The list of datatypes to generate XML Schema for. + The target namespace to output. + The new NAnt Schema. @@ -7278,14 +8028,14 @@ The new instance. - - The name of the output file to which the XSD should be written. - + + The name of the output file to which the XSD should be written. + - - The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd" - + + The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd" + @@ -7378,133 +8128,133 @@ - - The build file to build. - + + The build file to build. + - - The target to execute. To specify more than one target seperate - targets with a space. Targets are executed in order if possible. - The default is to use target specified in the project's default - attribute. - + + The target to execute. To specify more than one target seperate + targets with a space. Targets are executed in order if possible. + The default is to use target specified in the project's default + attribute. + - - Used to specify a set of build files to process. - + + Used to specify a set of build files to process. + - - Specifies whether current property values should be inherited by - the executed project. The default is . - + + Specifies whether current property values should be inherited by + the executed project. The default is . + - - Specifies whether all references will be copied to the new project. - The default is . - + + Specifies whether all references will be copied to the new project. + The default is . + - - Specifies a collection of properties that should be created in the - executed project. Note, existing properties with identical names - that are not read-only will be overwritten. - + + Specifies a collection of properties that should be created in the + executed project. Note, existing properties with identical names + that are not read-only will be overwritten. + - - Sets a property in the current project. - - - NAnt uses a number of predefined properties. - - - - Define a debug property with value . - - - - ]]> - - - - - Use the user-defined debug property. - - - - ]]> - - - - - Define a read-only property. This is just like passing in the param - on the command line. - - - - ]]> - - - - - Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line). - - - - - - - ]]> - - - Executing this build file with the command line option -D:debug=false, - would cause the value specified on the command line to remain unaltered. - - - - - + + Sets a property in the current project. + + + NAnt uses a number of predefined properties. + + + + Define a debug property with value . + + + + ]]> + + + + + Use the user-defined debug property. + + + + ]]> + + + + + Define a read-only property. This is just like passing in the param + on the command line. + + + + ]]> + + + + + Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line). + + + + + + + ]]> + + + Executing this build file with the command line option -D:debug=false, + would cause the value specified on the command line to remain unaltered. + + + + + - - The name of the NAnt property to set. - + + The name of the NAnt property to set. + - - The value to assign to the NAnt property. - + + The value to assign to the NAnt property. + - - Specifies whether the property is read-only or not. - The default is . - + + Specifies whether the property is read-only or not. + The default is . + - - Specifies whether references to other properties should not be - expanded when the value of the property is set, but expanded when - the property is actually used. By default, properties will be - expanded when set. - + + Specifies whether references to other properties should not be + expanded when the value of the property is set, but expanded when + the property is actually used. By default, properties will be + expanded when set. + - - Specifies whether the value of a property should be overwritten if - the property already exists (unless the property is read-only). - The default is . - + + Specifies whether the value of a property should be overwritten if + the property already exists (unless the property is read-only). + The default is . + @@ -7565,21 +8315,21 @@ - - Executes the task. - + + Executes the task. + - - Represents the regular expression to be evalued. - - - The regular expression to be evalued. - - - The pattern must contain one or more named constructs, which may - not contain any punctuation and cannot begin with a number. - + + Represents the regular expression to be evalued. + + + The regular expression to be evalued. + + + The pattern must contain one or more named constructs, which may + not contain any punctuation and cannot begin with a number. + @@ -7588,12 +8338,12 @@ - - Represents the input for the regular expression. - - - The input for the regular expression. - + + Represents the input for the regular expression. + + + The input for the regular expression. + @@ -7658,219 +8408,191 @@ - - - Win32 DllImport for the SetEnvironmentVariable function. - - - - - - - - *nix dllimport for the setenv function. - - - - - - 0 if the execution is successful; otherwise, -1. - - - - - Deletes all instances of the variable name. - - The variable to unset. - - 0 if the execution is successful; otherwise, -1. - - - - Checks whether the task is initialized with valid attributes. - + + Checks whether the task is initialized with valid attributes. + - - Set the environment variables - + + Set the environment variables + - - Do the actual work here. - - The name of the environment variable. - The value of the environment variable. + + Do the actual work here. + + The name of the environment variable. + The value of the environment variable. - - The name of a single Environment variable to set - + + The name of a single Environment variable to set + - - The literal value for the environment variable. - + + The literal value for the environment variable. + - - The value for a file-based environment variable. NAnt will convert - it to an absolute filename. - + + The value for a file-based environment variable. NAnt will convert + it to an absolute filename. + - - The value for a directory-based environment variable. NAnt will - convert it to an absolute path. - + + The value for a directory-based environment variable. NAnt will + convert it to an absolute path. + - - The value for a PATH like environment variable. You can use - : or ; as path separators and NAnt will convert it to - the platform's local conventions. - + + The value for a PATH like environment variable. You can use + : or ; as path separators and NAnt will convert it to + the platform's local conventions. + - - A task for sleeping a specified period of time, useful when a build or deployment process - requires an interval between tasks. - - - Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds. - - - ]]> - - - - Sleep 123 milliseconds. - - - ]]> - - + + A task for sleeping a specified period of time, useful when a build or deployment process + requires an interval between tasks. + + + Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds. + + + ]]> + + + + Sleep 123 milliseconds. + + + ]]> + + - - Verify parameters. - + + Verify parameters. + - - Return time to sleep. - + + Return time to sleep. + - - Sleeps for the specified number of milliseconds. - - Number of milliseconds to sleep. + + Sleeps for the specified number of milliseconds. + + Number of milliseconds to sleep. - - Hours to add to the sleep time. - + + Hours to add to the sleep time. + - - Minutes to add to the sleep time. - + + Minutes to add to the sleep time. + - - Seconds to add to the sleep time. - + + Seconds to add to the sleep time. + - - Milliseconds to add to the sleep time. - + + Milliseconds to add to the sleep time. + - - Processes a document via XSLT. - - - Create a report in HTML. - - - ]]> - - - - Create a report in HTML, with a param. - - - - - - - ]]> - - - - Create a report in HTML, with a expanded param. - - - - - - - ]]> - - - - Create some code based on a directory of templates. - - - - - - - - - - ]]> - - + + Processes a document via XSLT. + + + Create a report in HTML. + + + ]]> + + + + Create a report in HTML, with a param. + + + + + + + ]]> + + + + Create a report in HTML, with a expanded param. + + + + + + + ]]> + + + + Create some code based on a directory of templates. + + + + + + + + + + ]]> + + - - Directory in which to store the results. The default is the project - base directory. - + + Directory in which to store the results. The default is the project + base directory. + - - Desired file extension to be used for the targets. The default is - html. - + + Desired file extension to be used for the targets. The default is + html. + - - URI or path that points to the stylesheet to use. If given as path, it can - be relative to the project's basedir or absolute. - + + URI or path that points to the stylesheet to use. If given as path, it can + be relative to the project's basedir or absolute. + @@ -7885,24 +8607,24 @@ - - Specifies a group of input files to which to apply the stylesheet. - + + Specifies a group of input files to which to apply the stylesheet. + - - XSLT parameters to be passed to the XSLT transformation. - + + XSLT parameters to be passed to the XSLT transformation. + - - XSLT extension objects to be passed to the XSLT transformation. - + + XSLT extension objects to be passed to the XSLT transformation. + - - The network proxy to use to access the Internet resource. - + + The network proxy to use to access the Internet resource. + @@ -8026,70 +8748,265 @@ - - The string to prefix the property names with. The default is "sys.". - + + The string to prefix the property names with. The default is "sys.". + - - Touches a file or set of files -- corresponds to the Unix touch command. - - - - If the file specified does not exist, the task will create it. - - - - Touch the Main.cs file. The current time is used. - - - ]]> - - - - - Touch all executable files in the project base directory and its - subdirectories. - - - - - - - - - ]]> - - + + Touches a file or set of files -- corresponds to the Unix touch command. + + + + If the file specified does not exist, the task will create it. + + + + Touch the Main.cs file. The current time is used. + + + ]]> + + + + + Touch all executable files in the project base directory and its + subdirectories. + + + + + + + + + ]]> + + - - Ensures the supplied attributes are valid. - + + Ensures the supplied attributes are valid. + - - The file to touch. - + + The file to touch. + - - Specifies the new modification time of the file(s) in milliseconds - since midnight Jan 1 1970. - + + Specifies the new modification time of the file(s) in milliseconds + since midnight Jan 1 1970. + - - Specifies the new modification time of the file in the format - MM/DD/YYYY HH:MM:SS. - + + Specifies the new modification time of the file in the format + MM/DD/YYYY HH:MM:SS. + - - Used to select files that should be touched. - + + Used to select files that should be touched. + + + + + Executes a set of tasks, and optionally catches a build exception to + allow recovery or rollback steps to be taken, or to define some steps + to be taken regardless if the tasks succeed or fail, or both. + + + + The tasks defined in the <> block + will be executed in turn, as they normally would in a target. + + + If a <> block is defined, the + tasks in that block will be executed in turn only if one of the tasks + in the <> block fails. This + failure will then be suppressed by the <> + block. + + + The message associated with the failure can also be caught in a + property for use within the <> + block. The original contents of the property will be restored upon + exiting the <> block. + + + If a <> block is defined, the + tasks in that block will be executed after the tasks in both the + <> and <> + blocks have been executed, regardless of whether any task fails in + either block. + + + + + + + + + + + + + + + + + ]]> + + + The output of this example will be: + + + In try + In catch + Finally done + + + The failure in the <> block will + not cause the build to fail. + + + + + + + + + + + + + + + + + + ]]> + + + The output of this example will be: + + + In try + Caught failure: Just because... + Finally done + Build failed: Bad catch + + + Like the above, the failure in the <> + block does not cause the build to fail. The failure in the + <> block does, however. + Note that the <> block is + executed even though the <> + block failed. + + + + + + + + + + + + + + + + + + ]]> + + + The output of this example will be: + + + In try + Caught failure yet again + Build failed: Property 'failure' has not been set. + + + The in the <> + block failed because the "failure" property was not defined + after exiting the <> block. + Note that the failure in the <> + block has eclipsed the failure in the <> + block. + + + + + + + + + + + + + + + + + + ]]> + + + A more concrete example, that will always clean up the generated + temporary file after it has been created. + + + + + + The tasks in this block will be executed as a normal part of + the build script. + + + + + The tasks in this block will be executed if any task in the try + block fails. + + + + + The tasks in this block will always be executed, regardless of + what happens in the try and catch blocks. + + + Note that any failure in any of the tasks in this block will + prevent any subsequent tasks from executing. + + + + + Defines the name of the property to save the message describing + the failure that has been caught. + + + + The failure message is only available in the context of the catch + block. If you wish to preserve the message, you will need to save + it into another property. + + + Readonly properties cannot be overridden by this mechanism. + + @@ -8141,77 +9058,77 @@ - - The property to receive the date/time string in the given pattern. - + + The property to receive the date/time string in the given pattern. + - The date/time pattern to be used. - - The following table lists the standard format characters for each standard pattern. The format characters are case-sensitive; for example, 'g' and 'G' represent slightly different patterns. - - - Format Character - Description Example Format Pattern (en-US) - - dMM/dd/yyyy - Ddddd, dd MMMM yyyy - fdddd, dd MMMM yyyy HH:mm - Fdddd, dd MMMM yyyy HH:mm:ss - gMM/dd/yyyy HH:mm - GMM/dd/yyyy HH:mm:ss - m, MMMMM dd - r, Rddd, dd MMM yyyy HH':'mm':'ss 'GMT' - syyyy'-'MM'-'dd'T'HH':'mm':'ss - tHH:mm - THH:mm:ss - uyyyy'-'MM'-'dd HH':'mm':'ss'Z' - Udddd, dd MMMM yyyy HH:mm:ss - y, Yyyyy MMMM - - The following table lists the patterns that can be combined to construct custom patterns. The patterns are case-sensitive; for example, "MM" is recognized, but "mm" is not. If the custom pattern contains white-space characters or characters enclosed in single quotation marks, the output string will also contain those characters. Characters not defined as part of a format pattern or as format characters are reproduced literally. - - - Format - Pattern Description - - dThe day of the month. Single-digit days will not have a leading zero. - ddThe day of the month. Single-digit days will have a leading zero. - dddThe abbreviated name of the day of the week. - ddddThe full name of the day of the week. - MThe numeric month. Single-digit months will not have a leading zero. - MMThe numeric month. Single-digit months will have a leading zero. - MMMThe abbreviated name of the month. - MMMMThe full name of the month. - yThe year without the century. If the year without the century is less than 10, the year is displayed with no leading zero. - yyThe year without the century. If the year without the century is less than 10, the year is displayed with a leading zero. - yyyyThe year in four digits, including the century. - ggThe period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string. - hThe hour in a 12-hour clock. Single-digit hours will not have a leading zero. - hhThe hour in a 12-hour clock. Single-digit hours will have a leading zero. - HThe hour in a 24-hour clock. Single-digit hours will not have a leading zero. - HHThe hour in a 24-hour clock. Single-digit hours will have a leading zero. - mThe minute. Single-digit minutes will not have a leading zero. - mmThe minute. Single-digit minutes will have a leading zero. - sThe second. Single-digit seconds will not have a leading zero. - ssThe second. Single-digit seconds will have a leading zero. - fThe fraction of a second in single-digit precision. The remaining digits are truncated. - ffThe fraction of a second in double-digit precision. The remaining digits are truncated. - fffThe fraction of a second in three-digit precision. The remaining digits are truncated. - ffffThe fraction of a second in four-digit precision. The remaining digits are truncated. - fffffThe fraction of a second in five-digit precision. The remaining digits are truncated. - ffffffThe fraction of a second in six-digit precision. The remaining digits are truncated. - fffffffThe fraction of a second in seven-digit precision. The remaining digits are truncated. - tThe first character in the AM/PM designator. - ttThe AM/PM designator. - zThe time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8". - zzThe time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08". - zzzThe full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00". - :The default time separator. - /The default date separator. - \ cPattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". - - + The date/time pattern to be used. + + The following table lists the standard format characters for each standard pattern. The format characters are case-sensitive; for example, 'g' and 'G' represent slightly different patterns. + + + Format Character + Description Example Format Pattern (en-US) + + dMM/dd/yyyy + Ddddd, dd MMMM yyyy + fdddd, dd MMMM yyyy HH:mm + Fdddd, dd MMMM yyyy HH:mm:ss + gMM/dd/yyyy HH:mm + GMM/dd/yyyy HH:mm:ss + m, MMMMM dd + r, Rddd, dd MMM yyyy HH':'mm':'ss 'GMT' + syyyy'-'MM'-'dd'T'HH':'mm':'ss + tHH:mm + THH:mm:ss + uyyyy'-'MM'-'dd HH':'mm':'ss'Z' + Udddd, dd MMMM yyyy HH:mm:ss + y, Yyyyy MMMM + + The following table lists the patterns that can be combined to construct custom patterns. The patterns are case-sensitive; for example, "MM" is recognized, but "mm" is not. If the custom pattern contains white-space characters or characters enclosed in single quotation marks, the output string will also contain those characters. Characters not defined as part of a format pattern or as format characters are reproduced literally. + + + Format + Pattern Description + + dThe day of the month. Single-digit days will not have a leading zero. + ddThe day of the month. Single-digit days will have a leading zero. + dddThe abbreviated name of the day of the week. + ddddThe full name of the day of the week. + MThe numeric month. Single-digit months will not have a leading zero. + MMThe numeric month. Single-digit months will have a leading zero. + MMMThe abbreviated name of the month. + MMMMThe full name of the month. + yThe year without the century. If the year without the century is less than 10, the year is displayed with no leading zero. + yyThe year without the century. If the year without the century is less than 10, the year is displayed with a leading zero. + yyyyThe year in four digits, including the century. + ggThe period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string. + hThe hour in a 12-hour clock. Single-digit hours will not have a leading zero. + hhThe hour in a 12-hour clock. Single-digit hours will have a leading zero. + HThe hour in a 24-hour clock. Single-digit hours will not have a leading zero. + HHThe hour in a 24-hour clock. Single-digit hours will have a leading zero. + mThe minute. Single-digit minutes will not have a leading zero. + mmThe minute. Single-digit minutes will have a leading zero. + sThe second. Single-digit seconds will not have a leading zero. + ssThe second. Single-digit seconds will have a leading zero. + fThe fraction of a second in single-digit precision. The remaining digits are truncated. + ffThe fraction of a second in double-digit precision. The remaining digits are truncated. + fffThe fraction of a second in three-digit precision. The remaining digits are truncated. + ffffThe fraction of a second in four-digit precision. The remaining digits are truncated. + fffffThe fraction of a second in five-digit precision. The remaining digits are truncated. + ffffffThe fraction of a second in six-digit precision. The remaining digits are truncated. + fffffffThe fraction of a second in seven-digit precision. The remaining digits are truncated. + tThe first character in the AM/PM designator. + ttThe AM/PM designator. + zThe time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8". + zzThe time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08". + zzzThe full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00". + :The default time separator. + /The default date separator. + \ cPattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". + + @@ -8241,10 +9158,10 @@ - - Property that will be set to or depending on the - result of the date check. - + + Property that will be set to or depending on the + result of the date check. + @@ -8257,55 +9174,55 @@ - - Extracts text from an XML file at the location specified by an XPath - expression. - - - - If the XPath expression specifies multiple nodes the node index is used - to determine which of the nodes' text is returned. - - - - - The example provided assumes that the following XML file (App.config) - exists in the current build directory. - - - - - - - - - ]]> - - - - - The example will read the server value from the above - configuration file. - - - - - - - - ]]> - - + + Extracts text from an XML file at the location specified by an XPath + expression. + + + + If the XPath expression specifies multiple nodes the node index is used + to determine which of the nodes' text is returned. + + + + + The example provided assumes that the following XML file (App.config) + exists in the current build directory. + + + + + + + + + ]]> + + + + + The example will read the server value from the above + configuration file. + + + + + + + + ]]> + + - - Executes the XML peek task. - + + Executes the XML peek task. + @@ -8318,126 +9235,126 @@ - - Gets the contents of the node specified by the XPath expression. - - The XPath expression used to determine which nodes to choose from. - The XML document to select the nodes from. - The node index in the case where multiple nodes satisfy the expression. - - The contents of the node specified by the XPath expression. - + + Gets the contents of the node specified by the XPath expression. + + The XPath expression used to determine which nodes to choose from. + The XML document to select the nodes from. + The node index in the case where multiple nodes satisfy the expression. + + The contents of the node specified by the XPath expression. + - - The name of the file that contains the XML document - that is going to be peeked at. - + + The name of the file that contains the XML document + that is going to be peeked at. + - - The index of the node that gets its text returned when the query - returns multiple nodes. - + + The index of the node that gets its text returned when the query + returns multiple nodes. + - - The property that receives the text representation of the XML inside - the node returned from the XPath expression. - + + The property that receives the text representation of the XML inside + the node returned from the XPath expression. + - - The XPath expression used to select which node to read. - + + The XPath expression used to select which node to read. + - - Namespace definitions to resolve prefixes in the XPath expression. - + + Namespace definitions to resolve prefixes in the XPath expression. + - - Replaces text in an XML file at the location specified by an XPath - expression. - - - - The location specified by the XPath expression must exist, it will - not create the parent elements for you. However, provided you have - a root element you could use a series of the tasks to build the - XML file up if necessary. - - - - - Change the server setting in the configuration from testhost.somecompany.com - to productionhost.somecompany.com. - - XML file: - - - - - - - - ]]> - - Build fragment: - - - ]]> - - - - - Modify the noNamespaceSchemaLocation in an XML file. - - XML file: - - - - - ]]> - - Build fragment: - - - - - - - ]]> - - + + Replaces text in an XML file at the location specified by an XPath + expression. + + + + The location specified by the XPath expression must exist, it will + not create the parent elements for you. However, provided you have + a root element you could use a series of the tasks to build the + XML file up if necessary. + + + + + Change the server setting in the configuration from testhost.somecompany.com + to productionhost.somecompany.com. + + XML file: + + + + + + + + ]]> + + Build fragment: + + + ]]> + + + + + Modify the noNamespaceSchemaLocation in an XML file. + + XML file: + + + + + ]]> + + Build fragment: + + + + + + + ]]> + + - - Executes the XML poke task. - + + Executes the XML poke task. + - - Loads an XML document from a file on disk. - - - The file name of the file to load the XML document from. - - - Value for XmlDocument.PreserveWhitespace that is set before the xml is loaded. - - - An containing - the document object model representing the file. - + + Loads an XML document from a file on disk. + + + The file name of the file to load the XML document from. + + + Value for XmlDocument.PreserveWhitespace that is set before the xml is loaded. + + + An containing + the document object model representing the file. + @@ -8460,48 +9377,50 @@ - - Given a node list, replaces the XML within those nodes. - - - The list of nodes to replace the contents of. - - - The text to replace the contents with. - + + Given a node list, replaces the XML within those nodes. + + + The list of nodes to replace the contents of. + + + The text to replace the contents with. + - - Saves the XML document to a file. - - The XML document to be saved. - The file name to save the XML document under. + + Saves the XML document to a file. + + The XML document to be saved. + The file name to save the XML document under. - - The name of the file that contains the XML document that is going - to be poked. - + + The name of the file that contains the XML document that is going + to be poked. + - - The XPath expression used to select which nodes are to be modified. - + + The XPath expression used to select which nodes are to be modified. + - - The value that replaces the contents of the selected nodes. - + + The value that replaces the contents of the selected nodes. + - - Namespace definitions to resolve prefixes in the XPath expression. - + + Namespace definitions to resolve prefixes in the XPath expression. + - - Namespace definitions to resolve prefixes in the XPath expression. - + + If then the whitespace in the resulting + document will be preserved; otherwise the whitespace will be removed. + The default is . + @@ -8581,76 +9500,76 @@ - - Quotes a command line argument if it contains a single quote or a - space. - - The command line argument. - - A quoted command line argument if - contains a single quote or a space; otherwise, - . - + + Quotes a command line argument if it contains a single quote or a + space. + + The command line argument. + + A quoted command line argument if + contains a single quote or a space; otherwise, + . + - - A single command-line argument; can contain space characters. - + + A single command-line argument; can contain space characters. + - - The name of a file as a single command-line argument; will be - replaced with the absolute filename of the file. - + + The name of a file as a single command-line argument; will be + replaced with the absolute filename of the file. + - - The value for a directory-based command-line argument; will be - replaced with the absolute path of the directory. - + + The value for a directory-based command-line argument; will be + replaced with the absolute path of the directory. + - - The value for a PATH-like command-line argument; you can use - : or ; as path separators and NAnt will convert it - to the platform's local conventions, while resolving references to - environment variables. - - - Individual parts will be replaced with the absolute path, resolved - relative to the project base directory. - + + The value for a PATH-like command-line argument; you can use + : or ; as path separators and NAnt will convert it + to the platform's local conventions, while resolving references to + environment variables. + + + Individual parts will be replaced with the absolute path, resolved + relative to the project base directory. + - - Sets a single command-line argument and treats it like a PATH - ensures - the right separator for the local platform is used. - + + Sets a single command-line argument and treats it like a PATH - ensures + the right separator for the local platform is used. + - - List of command-line arguments; will be passed to the executable - as is. - + + List of command-line arguments; will be passed to the executable + as is. + - - Indicates if the argument should be passed to the external program. - If then the argument will be passed; - otherwise, skipped. The default is . - + + Indicates if the argument should be passed to the external program. + If then the argument will be passed; + otherwise, skipped. The default is . + - - Indicates if the argument should not be passed to the external - program. If then the argument will be - passed; otherwise, skipped. The default is . - + + Indicates if the argument should not be passed to the external + program. If then the argument will be + passed; otherwise, skipped. The default is . + - - Gets string value corresponding with the argument. - + + Gets string value corresponding with the argument. + @@ -8716,11 +9635,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -8753,10 +9672,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -8777,33 +9696,33 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Provides credentials for password-based authentication schemes. - + + Provides credentials for password-based authentication schemes. + @@ -8823,35 +9742,35 @@ - - The domain or computer name that verifies the credentials. - + + The domain or computer name that verifies the credentials. + - - The password for the user name associated with the credentials. - + + The password for the user name associated with the credentials. + - - The user name associated with the credentials. - + + The user name associated with the credentials. + - - Indicates if the credentials should be used to provide authentication - information to the external resource. If then - the credentials will be passed; otherwise, not. The default is - . - + + Indicates if the credentials should be used to provide authentication + information to the external resource. If then + the credentials will be passed; otherwise, not. The default is + . + - - Indicates if the credentials should not be used to provide authentication - information to the external resource. If then the - credentials will be passed; otherwise, not. The default is - . - + + Indicates if the credentials should not be used to provide authentication + information to the external resource. If then the + credentials will be passed; otherwise, not. The default is + . + @@ -9065,10 +9984,10 @@ - - copy constructor - - + + copy constructor + + @@ -9079,9 +9998,9 @@ - - Adds a nested set of patterns, or references a standalone patternset. - + + Adds a nested set of patterns, or references a standalone patternset. + @@ -9090,37 +10009,37 @@ - - Determines if a file has a more recent last write time than the - given time, or no longer exists. - - A file to check the last write time against. - The datetime to compare against. - - The name of the file that has a last write time greater than - or that no longer exists; - otherwise, . - + + Determines if a file has a more recent last write time than the + given time, or no longer exists. + + A file to check the last write time against. + The datetime to compare against. + + The name of the file that has a last write time greater than + or that no longer exists; + otherwise, . + - - Determines if one of the given files has a more recent last write - time than the given time. If one of the given files no longer exists, - the target will be considered out-of-date. - - A collection of filenames to check the last write time against. - The datetime to compare against. - - The name of the first file that has a last write time greater than - ; otherwise, null. - + + Determines if one of the given files has a more recent last write + time than the given time. If one of the given files no longer exists, + the target will be considered out-of-date. + + A collection of filenames to check the last write time against. + The datetime to compare against. + + The name of the first file that has a last write time greater than + ; otherwise, null. + - - Indicates whether include and exclude patterns must be treated in a - case-sensitive way. The default is on Unix; - otherwise, . - + + Indicates whether include and exclude patterns must be treated in a + case-sensitive way. The default is on Unix; + otherwise, . + @@ -9130,26 +10049,26 @@ - - Indicates whether default excludes should be used or not. - The default is . - + + Indicates whether default excludes should be used or not. + The default is . + - - The base of the directory of this fileset. The default is the project - base directory. - + + The base of the directory of this fileset. The default is the project + base directory. + - - Gets the collection of include patterns. - + + Gets the collection of include patterns. + - - Gets the collection of exclude patterns. - + + Gets the collection of exclude patterns. + @@ -9177,51 +10096,51 @@ - - Gets the collection of directory names that were scanned for files. - - - A collection that contains the directory names that were scanned for - files. - + + Gets the collection of directory names that were scanned for files. + + + A collection that contains the directory names that were scanned for + files. + - - The items to include in the fileset. - + + The items to include in the fileset. + - - The items to include in the fileset. - + + The items to include in the fileset. + - - The items to exclude from the fileset. - + + The items to exclude from the fileset. + - - The items to exclude from the fileset. - + + The items to exclude from the fileset. + - - The files from which a list of patterns or files to include should - be obtained. - + + The files from which a list of patterns or files to include should + be obtained. + - - The files from which a list of patterns or files to include should - be obtained. - + + The files from which a list of patterns or files to include should + be obtained. + - - The files from which a list of patterns or files to exclude should - be obtained. - + + The files from which a list of patterns or files to exclude should + be obtained. + @@ -9231,16 +10150,22 @@ The of the file that has the newest (closest to present) last write time. + + + Indicates whether or not every file and directory is included in + the fileset list. + + - - The pattern or file name to exclude. - + + The pattern or file name to exclude. + - - If then the pattern will be excluded; - otherwise, skipped. The default is . - + + If then the pattern will be excluded; + otherwise, skipped. The default is . + @@ -9257,21 +10182,21 @@ - - If then the file will be searched for - on the path. The default is . - + + If then the file will be searched for + on the path. The default is . + - - The pattern or file name to include. - + + The pattern or file name to include. + - - If then the pattern will be included; - otherwise, skipped. The default is . - + + If then the pattern will be included; + otherwise, skipped. The default is . + @@ -9286,10 +10211,10 @@ - - If then the patterns will be excluded; - otherwise, skipped. The default is . - + + If then the patterns will be excluded; + otherwise, skipped. The default is . + @@ -9299,10 +10224,10 @@ - - The name of a file; each line of this file is taken to be a - pattern. - + + The name of a file; each line of this file is taken to be a + pattern. + @@ -9313,16 +10238,16 @@ - - If then the patterns in the include file - will be searched for on the path. The default is . - + + If then the patterns in the include file + will be searched for on the path. The default is . + - - If then the patterns will be included; - otherwise, skipped. The default is . - + + If then the patterns will be included; + otherwise, skipped. The default is . + @@ -9345,9 +10270,9 @@ A instance to create a from. - - Represents an environment variable. - + + Represents an environment variable. + @@ -9363,75 +10288,75 @@ - - The name of the environment variable. - + + The name of the environment variable. + - - The literal value for the environment variable. - + + The literal value for the environment variable. + - - The value for a file-based environment variable. NAnt will convert - it to an absolute filename. - + + The value for a file-based environment variable. NAnt will convert + it to an absolute filename. + - - The value for a directory-based environment variable. NAnt will - convert it to an absolute path. - + + The value for a directory-based environment variable. NAnt will + convert it to an absolute path. + - - The value for a PATH like environment variable. You can use - : or ; as path separators and NAnt will convert it to - the platform's local conventions. - + + The value for a PATH like environment variable. You can use + : or ; as path separators and NAnt will convert it to + the platform's local conventions. + - - Sets a single environment variable and treats it like a PATH - - ensures the right separator for the local platform is used. - + + Sets a single environment variable and treats it like a PATH - + ensures the right separator for the local platform is used. + - - Gets the value of the environment variable. - + + Gets the value of the environment variable. + - - Indicates if the environment variable should be passed to the - external program. If then the environment - variable will be passed; otherwise, skipped. The default is - . - + + Indicates if the environment variable should be passed to the + external program. If then the environment + variable will be passed; otherwise, skipped. The default is + . + - - Indicates if the environment variable should not be passed to the - external program. If then the environment - variable will be passed; otherwise, skipped. The default is - . - + + Indicates if the environment variable should not be passed to the + external program. If then the environment + variable will be passed; otherwise, skipped. The default is + . + - - A set of environment variables. - + + A set of environment variables. + - - Environment variable to pass to a program. - + + Environment variable to pass to a program. + - - Environment variable to pass to a program. - + + Environment variable to pass to a program. + @@ -9497,11 +10422,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -9534,10 +10459,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -9558,52 +10483,52 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - The name of the NAnt property to set. - + + The name of the NAnt property to set. + - - The string pattern to use to format the property. - + + The string pattern to use to format the property. + - - Indicates if the formatter should be used to format the timestamp. - If then the formatter will be used; - otherwise, skipped. The default is . - + + Indicates if the formatter should be used to format the timestamp. + If then the formatter will be used; + otherwise, skipped. The default is . + - - Indicates if the formatter should be not used to format the - timestamp. If then the formatter will be - used; otherwise, skipped. The default is . - + + Indicates if the formatter should be not used to format the + timestamp. If then the formatter will be + used; otherwise, skipped. The default is . + @@ -9657,11 +10582,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -9694,10 +10619,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -9712,28 +10637,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -9769,21 +10694,21 @@ - - Do not threat the program as a managed application. - + + Do not threat the program as a managed application. + - - Leave it up to the CLR to determine which specific version of - the CLR will be used to run the application. - + + Leave it up to the CLR to determine which specific version of + the CLR will be used to run the application. + - - Forces an application to run against the currently targeted - version of a given CLR. - + + Forces an application to run against the currently targeted + version of a given CLR. + @@ -9812,45 +10737,45 @@ - - Represents an option. - + + Represents an option. + - - name, value constructor - - - + + name, value constructor + + + - - Default constructor - + + Default constructor + - - Name of the option. - + + Name of the option. + - - Value of the option. The default is . - + + Value of the option. The default is . + - - Indicates if the option should be passed to the task. - If then the option will be passed; - otherwise, skipped. The default is . - + + Indicates if the option should be passed to the task. + If then the option will be passed; + otherwise, skipped. The default is . + - - Indicates if the option should not be passed to the task. - If then the option will be passed; - otherwise, skipped. The default is . - + + Indicates if the option should not be passed to the task. + If then the option will be passed; + otherwise, skipped. The default is . + @@ -9915,11 +10840,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -9952,10 +10877,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -9976,59 +10901,59 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Represents a nested path element. - + + Represents a nested path element. + - - The name of a file to add to the path. Will be replaced with - the absolute path of the file. - + + The name of a file to add to the path. Will be replaced with + the absolute path of the file. + - - The name of a directory to add to the path. Will be replaced with - the absolute path of the directory. - + + The name of a directory to add to the path. Will be replaced with + the absolute path of the directory. + - - A string that will be treated as a path-like string. You can use - : or ; as path separators and NAnt will convert it - to the platform's local conventions, while resolving references - to environment variables. - + + A string that will be treated as a path-like string. You can use + : or ; as path separators and NAnt will convert it + to the platform's local conventions, while resolving references + to environment variables. + - - If then the entry will be added to the - path; otherwise, skipped. The default is . - + + If then the entry will be added to the + path; otherwise, skipped. The default is . + @@ -10047,27 +10972,27 @@ - - - Paths are groups of files and/or directories that need to be passed as a single - unit. The order in which parts of the path are specified in the build file is - retained, and duplicate parts are automatically suppressed. - - - - - Define a global <path> that can be referenced by other - tasks or types. - - - - - - - ]]> - - + + + Paths are groups of files and/or directories that need to be passed as a single + unit. The order in which parts of the path are specified in the build file is + retained, and duplicate parts are automatically suppressed. + + + + + Define a global <path> that can be referenced by other + tasks or types. + + + + + + + ]]> + + @@ -10083,13 +11008,13 @@ The string representing a path. - - Returns a textual representation of the path, which can be used as - PATH environment variable definition. - - - A textual representation of the path. - + + Returns a textual representation of the path, which can be used as + PATH environment variable definition. + + + A textual representation of the path. + @@ -10104,12 +11029,12 @@ The to add. - - Returns all path elements defined by this path object. - - - A list of path elements. - + + Returns all path elements defined by this path object. + + + A list of path elements. + @@ -10129,21 +11054,21 @@ - - The name pattern to include/exclude. - + + The name pattern to include/exclude. + - - If then the pattern will be used; - otherwise, skipped. The default is . - + + If then the pattern will be used; + otherwise, skipped. The default is . + - - If then the pattern will be used; - otherwise, skipped. The default is . - + + If then the pattern will be used; + otherwise, skipped. The default is . + @@ -10190,12 +11115,12 @@ - - Copies the entire collection to a compatible one-dimensional array, - starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, + starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -10228,10 +11153,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -10246,36 +11171,36 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -10472,9 +11397,9 @@ The to add. - - Defines a single pattern for files to include. - + + Defines a single pattern for files to include. + @@ -10483,9 +11408,9 @@ - - Defines a single pattern for files to exclude. - + + Defines a single pattern for files to exclude. + @@ -10494,10 +11419,10 @@ - - Contains HTTP proxy settings used to process requests to Internet - resources. - + + Contains HTTP proxy settings used to process requests to Internet + resources. + @@ -10516,9 +11441,9 @@ - - The name of the proxy host. - + + The name of the proxy host. + @@ -10526,40 +11451,40 @@ - - Specifies whether to bypass the proxy server for local addresses. - The default is . - + + Specifies whether to bypass the proxy server for local addresses. + The default is . + - - The credentials to submit to the proxy server for authentication. - + + The credentials to submit to the proxy server for authentication. + - - Indicates if the proxy should be used to connect to the external - resource. If then the proxy will be used; - otherwise, not. The default is . - + + Indicates if the proxy should be used to connect to the external + resource. If then the proxy will be used; + otherwise, not. The default is . + - - Indicates if the proxy should not be used to connect to the external - resource. If then the proxy will be used; - otherwise, not. The default is . - + + Indicates if the proxy should not be used to connect to the external + resource. If then the proxy will be used; + otherwise, not. The default is . + - - Represents an element of which the XML is processed by its parent task - or type. - + + Represents an element of which the XML is processed by its parent task + or type. + - - Gets the XML that this element represents. - + + Gets the XML that this element represents. + @@ -10573,48 +11498,48 @@ - - ReplaceTokens filter token. - + + ReplaceTokens filter token. + - - Token to be replaced. - + + Token to be replaced. + - - New value of token. - + + New value of token. + - - Indicates if the token should be used to replace values. - If then the token will be used; - otherwise, not. The default is . - + + Indicates if the token should be used to replace values. + If then the token will be used; + otherwise, not. The default is . + - - Indicates if the token should not be used to replace values. - If then the token will be used; - otherwise, not. The default is . - + + Indicates if the token should not be used to replace values. + If then the token will be used; + otherwise, not. The default is . + - - Represents an XML namespace. - + + Represents an XML namespace. + - - The prefix to associate with the namespace. - + + The prefix to associate with the namespace. + - - The associated XML namespace URI. - + + The associated XML namespace URI. + @@ -10694,11 +11619,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -10731,10 +11656,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -10755,35 +11680,35 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Represents an XSLT extension object. The object should have a default - parameterless constructor and the return value should be one of the - four basic XPath data types of number, string, Boolean or node set. - + + Represents an XSLT extension object. The object should have a default + parameterless constructor and the return value should be one of the + four basic XPath data types of number, string, Boolean or node set. + @@ -10801,28 +11726,28 @@ - - The full type name of the XSLT extension object. - + + The full type name of the XSLT extension object. + - - The assembly which contains the XSLT extension object. - + + The assembly which contains the XSLT extension object. + - - Indicates if the extension object should be added to the XSLT argument - list. If then the extension object will be - added; otherwise, skipped. The default is . - + + Indicates if the extension object should be added to the XSLT argument + list. If then the extension object will be + added; otherwise, skipped. The default is . + - - Indicates if the extension object should not be added to the XSLT argument - list. If then the extension object will be - added; otherwise, skipped. The default is . - + + Indicates if the extension object should not be added to the XSLT argument + list. If then the extension object will be + added; otherwise, skipped. The default is . + @@ -10899,15 +11824,15 @@ - - Copies the entire collection to a compatible one-dimensional array, - starting at the specified index of the target array. - - The one-dimensional array that is the - destination of the elements copied from the collection. The array - must have zero-based indexing. - The zero-based index in - at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, + starting at the specified index of the target array. + + The one-dimensional array that is the + destination of the elements copied from the collection. The array + must have zero-based indexing. + The zero-based index in + at which copying begins. @@ -10949,11 +11874,11 @@ from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get - or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get + or set. @@ -10978,33 +11903,33 @@ enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Represents an XSLT parameter. - + + Represents an XSLT parameter. + @@ -11040,18 +11965,18 @@ - - Indicates if the parameter should be added to the XSLT argument list. - If then the parameter will be added; - otherwise, skipped. The default is . - + + Indicates if the parameter should be added to the XSLT argument list. + If then the parameter will be added; + otherwise, skipped. The default is . + - - Indicates if the parameter should not be added to the XSLT argument - list. If then the parameter will be - added; otherwise, skipped. The default is . - + + Indicates if the parameter should not be added to the XSLT argument + list. If then the parameter will be + added; otherwise, skipped. The default is . + @@ -11117,11 +12042,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -11154,10 +12079,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -11178,33 +12103,33 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Resolves assemblies by caching assemblies that were loaded. - + + Resolves assemblies by caching assemblies that were loaded. + @@ -11221,13 +12146,13 @@ Installs the assembly resolver by hooking up to the - event. + event. - - Uninstalls the assembly resolver. - + + Uninstalls the assembly resolver. + @@ -11261,9 +12186,9 @@ - - Holds the loaded assemblies. - + + Holds the loaded assemblies. + @@ -11277,9 +12202,9 @@ - - Represents a valid command-line argument. - + + Represents a valid command-line argument. + @@ -11346,12 +12271,12 @@ - - Gets the property that backs the argument. - - - The property that backs the arguments. - + + Gets the property that backs the argument. + + + The property that backs the arguments. + @@ -11366,61 +12291,61 @@ - - Gets the long name of the argument. - - The long name of the argument. + + Gets the long name of the argument. + + The long name of the argument. - - Gets the short name of the argument. - - The short name of the argument. + + Gets the short name of the argument. + + The short name of the argument. - - Gets the description of the argument. - - The description of the argument. + + Gets the description of the argument. + + The description of the argument. - - Gets a value indicating whether the argument is required. - - - if the argument is required; otherwise, - . - + + Gets a value indicating whether the argument is required. + + + if the argument is required; otherwise, + . + - - Gets a value indicating whether a mathing command-line argument - was already found. - - - if a matching command-line argument was - already found; otherwise, . - + + Gets a value indicating whether a mathing command-line argument + was already found. + + + if a matching command-line argument was + already found; otherwise, . + - - Gets a value indicating whether the argument can be specified multiple - times. - - - if the argument may be specified multiple - times; otherwise, . - + + Gets a value indicating whether the argument can be specified multiple + times. + + + if the argument may be specified multiple + times; otherwise, . + - - Gets a value indicating whether the argument can only be specified once - with a certain value. - - - if the argument should always have a unique - value; otherwise, . - + + Gets a value indicating whether the argument can only be specified once + with a certain value. + + + if the argument should always have a unique + value; otherwise, . + @@ -11455,37 +12380,37 @@ - - Gets a value indicating whether the argument is array-based. - - - if the argument is backed by an array; - otherwise, . - + + Gets a value indicating whether the argument is array-based. + + + if the argument is backed by an array; + otherwise, . + - - Gets a value indicating whether the argument is the default argument. - - - if the argument is the default argument; - otherwise, . - + + Gets a value indicating whether the argument is the default argument. + + + if the argument is the default argument; + otherwise, . + - - Gets a value indicating whether the argument cannot be combined with - other arguments. - - - if the argument cannot be combined with other - arguments; otherwise, . - + + Gets a value indicating whether the argument cannot be combined with + other arguments. + + + if the argument cannot be combined with other + arguments; otherwise, . + - - Allows control of command line parsing. - + + Allows control of command line parsing. + @@ -11495,28 +12420,28 @@ Specifies the checking to be done on the argument. - - Gets or sets the checking to be done on the argument. - - The checking that should be done on the argument. + + Gets or sets the checking to be done on the argument. + + The checking that should be done on the argument. - - Gets or sets the long name of the argument. - - The long name of the argument. + + Gets or sets the long name of the argument. + + The long name of the argument. - - Gets or sets the short name of the argument. - - The short name of the argument. + + Gets or sets the short name of the argument. + + The short name of the argument. - - Gets or sets the description of the argument. - - The description of the argument. + + Gets or sets the description of the argument. + + The description of the argument. @@ -11570,11 +12495,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -11607,10 +12532,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -11631,34 +12556,34 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - The exception that is thrown when one of the command-line arguments provided - is not valid. - + + The exception that is thrown when one of the command-line arguments provided + is not valid. + @@ -11689,50 +12614,50 @@ The that contains contextual information about the source or destination. - - Used to control parsing of command-line arguments. - + + Used to control parsing of command-line arguments. + - - Indicates that this field is required. An error will be displayed - if it is not present when parsing arguments. - + + Indicates that this field is required. An error will be displayed + if it is not present when parsing arguments. + - - Only valid in conjunction with Multiple. - Duplicate values will result in an error. - + + Only valid in conjunction with Multiple. + Duplicate values will result in an error. + - - Inidicates that the argument may be specified more than once. - Only valid if the argument is a collection - + + Inidicates that the argument may be specified more than once. + Only valid if the argument is a collection + - - Inidicates that if this argument is specified, no other arguments may be specified. - + + Inidicates that if this argument is specified, no other arguments may be specified. + - - The default type for non-collection arguments. - The argument is not required, but an error will be reported if it is specified more than once. - + + The default type for non-collection arguments. + The argument is not required, but an error will be reported if it is specified more than once. + - - The default type for collection arguments. - The argument is permitted to occur multiple times, but duplicate - values will cause an error to be reported. - + + The default type for collection arguments. + The argument is permitted to occur multiple times, but duplicate + values will cause an error to be reported. + - - Commandline parser. - + + Commandline parser. + @@ -11753,27 +12678,27 @@ The of does not match the argument specification that was used to initialize the parser. - - Splits a string and removes any empty strings from the - result. Same functionality as the - public string[] Split(char[] separator, StringSplitOptions options) - method in .Net 2.0. Replace with that call when 2.0 is standard. - - - - the array of strings + + Splits a string and removes any empty strings from the + result. Same functionality as the + public string[] Split(char[] separator, StringSplitOptions options) + method in .Net 2.0. Replace with that call when 2.0 is standard. + + + + the array of strings - - Read a response file and parse the arguments as usual. - - The response file to load arguments + + Read a response file and parse the arguments as usual. + + The response file to load arguments - - Parse the argument list using the - - + + Parse the argument list using the + + @@ -11797,22 +12722,22 @@ - - Gets the usage instructions. - - The usage instructions. + + Gets the usage instructions. + + The usage instructions. - - Gets a value indicating whether no arguments were specified on the - command line. - + + Gets a value indicating whether no arguments were specified on the + command line. + - - Marks a command-line option as being the default option. When the name of - a command-line argument is not specified, this option will be assumed. - + + Marks a command-line option as being the default option. When the name of + a command-line argument is not specified, this option will be assumed. + @@ -11822,42 +12747,121 @@ Specifies the checking to be done on the argument. - - Provides modified version for Copy and Move from the File class that - allow for filter chain processing. - + + Provides modified version for Copy and Move from the File class that + allow for filter chain processing. + + + + + Constant buffer size for copy/move functions. + + Default value is 8k - - Copies a file filtering its content through the filter chain. - - The file to copy - The file to copy to - Chain of filters to apply when copying, or is no filters should be applied. - The encoding used to read the soure file. - The encoding used to write the destination file. + + Copies a file filtering its content through the filter chain. + + + The file to copy + + + The file to copy to + + + Chain of filters to apply when copying, or is no + filters should be applied. + + + The encoding used to read the soure file. + + + The encoding used to write the destination file. + - - Moves a file filtering its content through the filter chain. - - The file to move. - The file to move move to. - Chain of filters to apply when moving, or is no filters should be applied. - The encoding used to read the soure file. - The encoding used to write the destination file. + + Moves a file filtering its content through the filter chain. + + + The file to move. + + + The file to move move to. + + + Chain of filters to apply when moving, or is no + filters should be applied. + + + The encoding used to read the soure file. + + + The encoding used to write the destination file. + + + + + Copies a directory while filtering its file content through the filter chain. + + + Source directory to copy from. + + + Destination directory to copy to. + + + Chain of filters to apply when copying, or is no + filters should be applied. + + + The encoding used to read the soure file. + + + The encoding used to write the destination file. + + + + + Moves a directory while filtering its file content through the filter chain. + + + Source directory to move from. + + + Destination directory to move to. + + + Chain of filters to apply when copying, or is no + filters should be applied. + + + The encoding used to read the soure file. + + + The encoding used to write the destination file. + + + + + Generates a new temporary directory name based on the system's + temporary path. + + + The temp directory name. + - - Reads a file filtering its content through the filter chain. - - The file to read. - Chain of filters to apply when reading, or is no filters should be applied. - The encoding used to read the file. - - If is , - then the system's ANSI code page will be used to read the file. - + + Reads a file filtering its content through the filter chain. + + The file to read. + Chain of filters to apply when reading, or is no filters should be applied. + The encoding used to read the file. + + If is , + then the system's ANSI code page will be used to read the file. + @@ -11899,33 +12903,33 @@ is . - - Returns the home directory of the current user. - - - The home directory of the current user. - + + Returns the home directory of the current user. + + + The home directory of the current user. + - - Scans a list of directories for the specified filename. - - The list of directories to search. - The name of the file to look for. - Specifies whether the directory should be searched recursively. - - The directories are scanned in the order in which they are defined. - - - The absolute path to the specified file, or null if the file was - not found. - + + Scans a list of directories for the specified filename. + + The list of directories to search. + The name of the file to look for. + Specifies whether the directory should be searched recursively. + + The directories are scanned in the order in which they are defined. + + + The absolute path to the specified file, or null if the file was + not found. + - - Helper class for determining whether assemblies are located in the - Global Assembly Cache. - + + Helper class for determining whether assemblies are located in the + Global Assembly Cache. + @@ -11985,9 +12989,9 @@ - - Holds a value indicating whether the object has been disposed. - + + Holds a value indicating whether the object has been disposed. + @@ -12010,21 +13014,21 @@ - - Determines whether an assembly is installed in the Global - Assembly Cache given its file name or path. - - The name or path of the file that contains the manifest of the assembly. - - if is - installed in the Global Assembly Cache; otherwise, - . - + + Determines whether an assembly is installed in the Global + Assembly Cache given its file name or path. + + The name or path of the file that contains the manifest of the assembly. + + if is + installed in the Global Assembly Cache; otherwise, + . + - - Provides a set of helper methods related to reflection. - + + Provides a set of helper methods related to reflection. + @@ -12056,10 +13060,10 @@ - - Provides resource support to NAnt assemblies. This class cannot - be inherited from. - + + Provides resource support to NAnt assemblies. This class cannot + be inherited from. + @@ -12068,142 +13072,142 @@ - - Registers the assembly to be used as the fallback if resources - aren't found in the local satellite assembly. - - - A that represents the - assembly to register. - - - The following example shows how to register a shared satellite - assembly. - - - - + + Registers the assembly to be used as the fallback if resources + aren't found in the local satellite assembly. + + + A that represents the + assembly to register. + + + The following example shows how to register a shared satellite + assembly. + + + + - - Returns the value of the specified string resource. - - - A that contains the name of the - resource to get. - - - A that contains the value of the - resource localized for the current culture. - - - The returned resource is localized for the cultural settings of the - current . - - The GetString method is thread-safe. - - - - The following example demonstrates the GetString method using - the cultural settings of the current . - - - - + + Returns the value of the specified string resource. + + + A that contains the name of the + resource to get. + + + A that contains the value of the + resource localized for the current culture. + + + The returned resource is localized for the cultural settings of the + current . + + The GetString method is thread-safe. + + + + The following example demonstrates the GetString method using + the cultural settings of the current . + + + + - - Returns the value of the specified string resource localized for - the specified culture. - - - - - A that contains the value of the - resource localized for the specified culture. - - - - The GetString method is thread-safe. - - - - The following example demonstrates the GetString method using - a specific culture. - - - - + + Returns the value of the specified string resource localized for + the specified culture. + + + + + A that contains the value of the + resource localized for the specified culture. + + + + The GetString method is thread-safe. + + + + The following example demonstrates the GetString method using + a specific culture. + + + + - - Returns the value of the specified string resource localized for - the specified culture for the specified assembly. - - - A that contains the name of the - resource to get. - - - A that represents - the culture for which the resource is localized. - - - A - - - A that contains the value of the - resource localized for the specified culture. - - - - The GetString method is thread-safe. - - - - The following example demonstrates the GetString method using - specific culture and assembly. - - - - + + Returns the value of the specified string resource localized for + the specified culture for the specified assembly. + + + A that contains the name of the + resource to get. + + + A that represents + the culture for which the resource is localized. + + + A + + + A that contains the value of the + resource localized for the specified culture. + + + + The GetString method is thread-safe. + + + + The following example demonstrates the GetString method using + specific culture and assembly. + + + + - - Registers the specified assembly. - - - A that represents the - assembly to register. - + + Registers the specified assembly. + + + A that represents the + assembly to register. + - - Determines the manifest resource name of the resource holding the - localized strings. - - The name of the assembly. - - The manifest resource name of the resource holding the localized - strings for the specified assembly. - - - The manifest resource name of the resource holding the localized - strings should match the name of the assembly, minus Tasks - suffix. - + + Determines the manifest resource name of the resource holding the + localized strings. + + The name of the assembly. + + The manifest resource name of the resource holding the localized + strings for the specified assembly. + + + The manifest resource name of the resource holding the localized + strings should match the name of the assembly, minus Tasks + suffix. + @@ -12244,24 +13248,24 @@ - - Converts an empty string ("") to . - - The value to convert. - - if is an empty - string ("") or ; otherwise, . - + + Converts an empty string ("") to . + + The value to convert. + + if is an empty + string ("") or ; otherwise, . + - - Converts to an empty string. - - The value to convert. - - An empty string if is ; - otherwise, . - + + Converts to an empty string. + + The value to convert. + + An empty string if is ; + otherwise, . + @@ -12298,14 +13302,14 @@ - - Thrown whenever an error occurs during the build. - + + Thrown whenever an error occurs during the build. + - - The location of the exception in the build document (xml file). - + + The location of the exception in the build document (xml file). + @@ -12362,155 +13366,164 @@ The destination for this serialization. - - Creates and returns a string representation of the current - exception. - - - A string representation of the current exception. - + + Creates and returns a string representation of the current + exception. + + + A string representation of the current exception. + - - Gets the raw message as specified when the exception was - constructed. - - - The raw message as specified when the exception was - constructed. - + + Gets the raw message as specified when the exception was + constructed. + + + The raw message as specified when the exception was + constructed. + - - Gets the location in the build file of the element from which the - exception originated. - - - The location in the build file of the element from which the - exception originated. - + + Gets the location in the build file of the element from which the + exception originated. + + + The location in the build file of the element from which the + exception originated. + - - Gets a message that describes the current exception. - - - The error message that explains the reason for the exception. - - - Adds location information to the message, if available. - + + Gets a message that describes the current exception. + + + The error message that explains the reason for the exception. + + + Adds location information to the message, if available. + - - Represents the set of command-line options supported by NAnt. - + + Represents the set of command-line options supported by NAnt. + - - Gets or sets the target framework to use (overrides - NAnt.exe.config settings) - - - The framework that should be used. - - - For a list of possible frameworks, see NAnt.exe.config, possible - values include "net-1.0", "net-1.1", etc. - + + Gets or sets the target framework to use (overrides + NAnt.exe.config settings) + + + The framework that should be used. + + + For a list of possible frameworks, see NAnt.exe.config, possible + values include "net-1.0", "net-1.1", etc. + - - Gets or sets the target framework to use (overrides - NAnt.exe.config settings) - - - The framework that should be used. - - - For a list of possible frameworks, see NAnt.exe.config, possible - values include "net-1.0", "net-1.1", etc. - + + Gets or sets the target framework to use (overrides + NAnt.exe.config settings) + + + The framework that should be used. + + + For a list of possible frameworks, see NAnt.exe.config, possible + values include "net-1.0", "net-1.1", etc. + - - Gets or sets the buildfile that should be executed. - - - The buildfile that should be executed. - - - Can be both a file or an URI. - + + Gets or sets the buildfile that should be executed. + + + The buildfile that should be executed. + + + Can be both a file or an URI. + + + + + Pauses before program ends. + + + for pausing on program end; + otherwise, . The default is . + - - Gets or sets a value indicating whether more information should be - displayed during the build process. - - - if more information should be displayed; - otherwise, . The default is . - + + Gets or sets a value indicating whether more information should be + displayed during the build process. + + + if more information should be displayed; + otherwise, . The default is . + - - Gets or sets a value indicating whether debug information should be - displayed during the build process. - - - if debug information should be displayed; - otherwise, . The default is . - + + Gets or sets a value indicating whether debug information should be + displayed during the build process. + + + if debug information should be displayed; + otherwise, . The default is . + - - Gets or sets a value indicating whether only error and debug debug messages should be - displayed during the build process. - - - if only error or warning messages should be - displayed; otherwise, . The default is - . - + + Gets or sets a value indicating whether only error and debug debug messages should be + displayed during the build process. + + + if only error or warning messages should be + displayed; otherwise, . The default is + . + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - if output is to be unadorned so that emacs - and other editors can parse files names, etc. The default is - . - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + if output is to be unadorned so that emacs + and other editors can parse files names, etc. The default is + . + - - Gets a value indicating whether parent directories should be searched - for a buildfile. - - - if parent directories should be searched for - a build file; otherwise, . The default is - . - + + Gets a value indicating whether parent directories should be searched + for a buildfile. + + + if parent directories should be searched for + a build file; otherwise, . The default is + . + - - Gets or sets the indentation level of the build output. - - - The indentation level of the build output. The default is 0. - + + Gets or sets the indentation level of the build output. + + + The indentation level of the build output. The default is 0. + - - Gets or sets the list of properties that should be set. - - - The list of properties that should be set. - + + Gets or sets the list of properties that should be set. + + + The list of properties that should be set. + @@ -12526,12 +13539,12 @@ - - Gets or sets the name of the file to log output to. - - - The name of the file to log output to. - + + Gets or sets the name of the file to log output to. + + + The name of the file to log output to. + @@ -12545,12 +13558,12 @@ - - Gets a collection of assemblies to load extensions from. - - - A collection of assemblies to load extensions from. - + + Gets a collection of assemblies to load extensions from. + + + A collection of assemblies to load extensions from. + @@ -12564,75 +13577,75 @@ - - Gets or sets a value indicating whether the logo banner should be - printed. - - - if the logo banner should be printed; otherwise, - . The default is . - + + Gets or sets a value indicating whether the logo banner should be + printed. + + + if the logo banner should be printed; otherwise, + . The default is . + - - Gets or sets a value indicating whether the NAnt help should be - printed. - - - if NAnt help should be printed; otherwise, - . The default is . - + + Gets or sets a value indicating whether the NAnt help should be + printed. + + + if NAnt help should be printed; otherwise, + . The default is . + - - Gets a collection containing the targets that should be executed. - - - A collection that contains the targets that should be executed. - + + Gets a collection containing the targets that should be executed. + + + A collection that contains the targets that should be executed. + - - Custom configuration section handler for the element. - + + Custom configuration section handler for the element. + - - This just passed things through. Return the node read from the config file. - + + This just passed things through. Return the node read from the config file. + - - Main entry point to NAnt that is called by the ConsoleStub. - + + Main entry point to NAnt that is called by the ConsoleStub. + - - Starts NAnt. This is the Main entry point. - - Command Line args, or whatever you want to pass it. They will treated as Command Line args. - - The exit code. - + + Starts NAnt. This is the Main entry point. + + Command Line args, or whatever you want to pass it. They will treated as Command Line args. + + The exit code. + - - Prints the projecthelp to the console. - - The build file to show help for. - - is loaded and transformed with - ProjectHelp.xslt, which is an embedded resource. - + + Prints the projecthelp to the console. + + The build file to show help for. + + is loaded and transformed with + ProjectHelp.xslt, which is an embedded resource. + - - Gets the file name for the build file in the specified directory. - - The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory. - Look for a build file with this pattern or name. If null look for a file that matches the default build pattern (*.build). - Whether or not to search the parent directories for a build file. - The path to the build file or null if no build file could be found. + + Gets the file name for the build file in the specified directory. + + The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory. + Look for a build file with this pattern or name. If null look for a file that matches the default build pattern (*.build). + Whether or not to search the parent directories for a build file. + The path to the build file or null if no build file could be found. @@ -12681,9 +13694,9 @@ The to add listeners to. - - Spits out generic help info to the console. - + + Spits out generic help info to the console. + @@ -12798,11 +13811,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -12835,10 +13848,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -12859,28 +13872,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -12894,45 +13907,50 @@ - - Inherits Properties from an existing property - dictionary Instance - - DataType list to inherit + + Inherits Properties from an existing property + dictionary Instance + + DataType list to inherit - - Used for searching filesystem based on given include/exclude rules. - - - Simple client code for testing the class. - - while (true) { - DirectoryScanner scanner = new DirectoryScanner(); - Console.Write("Scan Basedirectory : "); - string s = Console.ReadLine(); - if (s.Length == 0) break; - scanner.BaseDirectory = s; - while(true) { - Console.Write("Include pattern : "); - s = Console.ReadLine(); - if (s.Length == 0) break; - scanner.Includes.Add(s); - } - while(true) { - Console.Write("Exclude pattern : "); - s = Console.ReadLine(); - if (s.Length == 0) break; - scanner.Excludes.Add(s); - } - foreach (string name in scanner.FileNames) - Console.WriteLine("file:" + name); - foreach (string name in scanner.DirectoryNames) - Console.WriteLine("dir :" + name); - Console.WriteLine(""); - } - - + + Used for searching filesystem based on given include/exclude rules. + + + Simple client code for testing the class. + + while (true) { + DirectoryScanner scanner = new DirectoryScanner(); + + Console.Write("Scan Basedirectory : "); + string s = Console.ReadLine(); + if (s.Length == 0) break; + scanner.BaseDirectory = s; + + while(true) { + Console.Write("Include pattern : "); + s = Console.ReadLine(); + if (s.Length == 0) break; + scanner.Includes.Add(s); + } + + while(true) { + Console.Write("Exclude pattern : "); + s = Console.ReadLine(); + if (s.Length == 0) break; + scanner.Excludes.Add(s); + } + + foreach (string name in scanner.FileNames) + Console.WriteLine("file:" + name); + foreach (string name in scanner.DirectoryNames) + Console.WriteLine("dir :" + name); + + Console.WriteLine(""); + } + + @@ -12965,57 +13983,57 @@ - - Parses specified NAnt search patterns for search directories and - corresponding regex patterns. - - In. NAnt patterns. Absolute or relative paths. - Out. Regex patterns. Absolute canonical paths. - Out. Non-regex files. Absolute canonical paths. - In. Whether to allow a pattern to add search directories. + + Parses specified NAnt search patterns for search directories and + corresponding regex patterns. + + In. NAnt patterns. Absolute or relative paths. + Out. Regex patterns. Absolute canonical paths. + Out. Non-regex files. Absolute canonical paths. + In. Whether to allow a pattern to add search directories. - - Given a NAnt search pattern returns a search directory and an regex - search pattern. - - Whether this pattern is an include or exclude pattern - NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported) - Out. Absolute canonical path to the directory to be searched - Out. Whether the pattern is potentially recursive or not - Out. Whether this is a regex pattern or not - Out. Regex search pattern (absolute canonical path) + + Given a NAnt search pattern returns a search directory and an regex + search pattern. + + Whether this pattern is an include or exclude pattern + NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported) + Out. Absolute canonical path to the directory to be searched + Out. Whether the pattern is potentially recursive or not + Out. Whether this is a regex pattern or not + Out. Regex search pattern (absolute canonical path) - - Searches a directory recursively for files and directories matching - the search criteria. - - Directory in which to search (absolute canonical path) - Whether to scan recursively or not + + Searches a directory recursively for files and directories matching + the search criteria. + + Directory in which to search (absolute canonical path) + Whether to scan recursively or not - - Converts search pattern to a regular expression pattern. - - Search pattern relative to the search directory. - Regular expresssion + + Converts search pattern to a regular expression pattern. + + Search pattern relative to the search directory. + Regular expresssion - - Gets or set a value indicating whether or not to use case-sensitive - pattern matching. - + + Gets or set a value indicating whether or not to use case-sensitive + pattern matching. + - - Gets the collection of include patterns. - + + Gets the collection of include patterns. + - - Gets the collection of exclude patterns. - + + Gets the collection of exclude patterns. + @@ -13024,19 +14042,25 @@ - - Gets the list of files that match the given patterns. - + + Gets the list of files that match the given patterns. + - - Gets the list of directories that match the given patterns. - + + Gets the list of directories that match the given patterns. + - - Gets the list of directories that were scanned for files. - + + Gets the list of directories that were scanned for files. + + + + + Indicates whether or not the directory scanner included everything + that it scanned. + @@ -13047,12 +14071,12 @@ - - Creates a string representing a list of the strings in the collection. - - - A string that represents the contents. - + + Creates a string representing a list of the strings in the collection. + + + A string that represents the contents. + @@ -13102,53 +14126,53 @@ - - Gets a value indicating whether string comparison is case-sensitive. - - - A value indicating whether string comparison is case-sensitive. - + + Gets a value indicating whether string comparison is case-sensitive. + + + A value indicating whether string comparison is case-sensitive. + - - Gets the value of the specified property. - - The name of the property to get the value of. - - The value of the specified property. - + + Gets the value of the specified property. + + The name of the property to get the value of. + + The value of the specified property. + - - Splits an input string into a sequence of tokens used during parsing. - + + Splits an input string into a sequence of tokens used during parsing. + - - Available tokens - + + Available tokens + - - Encalsulates information about installed frameworks incuding version - information and directory locations for finding tools. - + + Encalsulates information about installed frameworks incuding version + information and directory locations for finding tools. + - - Resolves the specified assembly to a full path by matching it - against the reference assemblies. - - The file name of the assembly to resolve (without path information). - - An absolute path to the assembly, or if the - assembly could not be found or no reference assemblies are configured - for the current framework. - - - Whether the file name is matched case-sensitively depends on the - operating system. - + + Resolves the specified assembly to a full path by matching it + against the reference assemblies. + + The file name of the assembly to resolve (without path information). + + An absolute path to the assembly, or if the + assembly could not be found or no reference assemblies are configured + for the current framework. + + + Whether the file name is matched case-sensitively depends on the + operating system. + @@ -13172,47 +14196,47 @@ - - Gets the value of the specified attribute from the specified node. - - The node of which the attribute value should be retrieved. - The attribute of which the value should be returned. - - The value of the attribute with the specified name or - if the attribute does not exist or has no value. - + + Gets the value of the specified attribute from the specified node. + + The node of which the attribute value should be retrieved. + The attribute of which the value should be returned. + + The value of the attribute with the specified name or + if the attribute does not exist or has no value. + - - Gets the name of the framework. - - - The name of the framework. - + + Gets the name of the framework. + + + The name of the framework. + - - Gets the family of the framework. - - - The family of the framework. - + + Gets the family of the framework. + + + The family of the framework. + - - Gets the description of the framework. - - - The description of the framework. - + + Gets the description of the framework. + + + The description of the framework. + - - Gets the vendor of the framework. - - - The vendor of the framework. - + + Gets the vendor of the framework. + + + The vendor of the framework. + @@ -13322,13 +14346,13 @@ The framework is not valid. - - Returns a value indicating whether the current framework is valid. - - - if the framework is installed and correctly - configured; otherwise, . - + + Returns a value indicating whether the current framework is valid. + + + if the framework is installed and correctly + configured; otherwise, . + @@ -13372,134 +14396,134 @@ - - Defines the types of frameworks. - + + Defines the types of frameworks. + - - Frameworks that are supported on the current platform, but are not - installed. - + + Frameworks that are supported on the current platform, but are not + installed. + - - Frameworks that are installed on the current system. - + + Frameworks that are installed on the current system. + - - Retrieves installation state attributes. - + + Retrieves installation state attributes. + - - Frameworks that typically target full desktop devices. - + + Frameworks that typically target full desktop devices. + - - Frameworks that target compact devices. - + + Frameworks that target compact devices. + - - Frameworks that run in a browser. - + + Frameworks that run in a browser. + - - Retrieves device attributes. - + + Retrieves device attributes. + - - Frameworks released as part of the open-source Mono - project. - + + Frameworks released as part of the open-source Mono + project. + - - Frameworks released by Microsoft. - + + Frameworks released by Microsoft. + - - Retrieves vendor attributes. - + + Retrieves vendor attributes. + - - All frameworks supported on the current platform, regarless of their - installation state, target device or vendor. - + + All frameworks supported on the current platform, regarless of their + installation state, target device or vendor. + - - Stores the file name, line number and column number to record a position - in a text file. - + + Stores the file name, line number and column number to record a position + in a text file. + - - Creates a location consisting of a file name, line number and - column number. - - - can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt. - + + Creates a location consisting of a file name, line number and + column number. + + + can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt. + - - Creates a location consisting of a file name. - - - can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt. - + + Creates a location consisting of a file name. + + + can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt. + - - Creates an "unknown" location. - + + Creates an "unknown" location. + - Private Init function. + Private Init function. - - Returns the file name, line number and a trailing space. An error - message can be appended easily. For unknown locations, returns - an empty string. - + + Returns the file name, line number and a trailing space. An error + message can be appended easily. For unknown locations, returns + an empty string. + - - Gets a string containing the file name for the location. - - - The file name includes both the file path and the extension. - + + Gets a string containing the file name for the location. + + + The file name includes both the file path and the extension. + - - Gets the line number for the location. - - - Lines start at 1. Will be zero if not specified. - + + Gets the line number for the location. + + + Lines start at 1. Will be zero if not specified. + - - Gets the column number for the location. - - - Columns start a 1. Will be zero if not specified. - + + Gets the column number for the location. + + + Columns start a 1. Will be zero if not specified. + - - Maps XML nodes to the text positions from their original source. - + + Maps XML nodes to the text positions from their original source. + @@ -13507,14 +14531,14 @@ - - Determines if a file has been loaded by the current project. - - The file to check. - - if the specified file has already been loaded - by the current project; otherwise, . - + + Determines if a file has been loaded by the current project. + + The file to check. + + if the specified file has already been loaded + by the current project; otherwise, . + @@ -13534,9 +14558,9 @@ - - Represents a position in the build file. - + + Represents a position in the build file. + @@ -13547,47 +14571,47 @@ The column coordinate of the position. - - The line coordinate of the position. - + + The line coordinate of the position. + - - The column coordinate of the position. - + + The column coordinate of the position. + - - Defines the set of levels recognised by the NAnt logging system. - + + Defines the set of levels recognised by the NAnt logging system. + - - Designates fine-grained informational events that are most useful - to debug a build process. - + + Designates fine-grained informational events that are most useful + to debug a build process. + - - Designates events that offer a more detailed view of the build - process. - + + Designates events that offer a more detailed view of the build + process. + - - Designates informational events that are useful for getting a - high-level view of the build process. - + + Designates informational events that are useful for getting a + high-level view of the build process. + - - Designates potentionally harmful events. - + + Designates potentionally harmful events. + - - Designates error events. - + + Designates error events. + @@ -13671,20 +14695,20 @@ The that emitted the event. - - Gets or sets the message associated with this event. - - - The message associated with this event. - + + Gets or sets the message associated with this event. + + + The message associated with this event. + - - Gets or sets the priority level associated with this event. - - - The priority level associated with this event. - + + Gets or sets the priority level associated with this event. + + + The priority level associated with this event. + @@ -13729,10 +14753,10 @@ A that contains the event data. - - Instances of classes that implement this interface can register to be - notified when things happen during a build. - + + Instances of classes that implement this interface can register to be + notified when things happen during a build. + @@ -13806,30 +14830,30 @@ - - Flushes buffered build events or messages to the underlying storage. - + + Flushes buffered build events or messages to the underlying storage. + - - Gets or sets the highest level of message this logger should respond - to. - - The highest level of message this logger should respond to. - - Only messages with a message level higher than or equal to the given - level should actually be written to the log. - + + Gets or sets the highest level of message this logger should respond + to. + + The highest level of message this logger should respond to. + + Only messages with a message level higher than or equal to the given + level should actually be written to the log. + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - if output is to be unadorned so that emacs - and other editors can parse files names, etc. - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + if output is to be unadorned so that emacs + and other editors can parse files names, etc. + @@ -13844,9 +14868,9 @@ - - Flushes buffered build events or messages to the underlying storage. - + + Flushes buffered build events or messages to the underlying storage. + @@ -13914,11 +14938,11 @@ - - Empty implementation which allows derived classes to receive the - output that is generated in this logger. - - The message being logged. + + Empty implementation which allows derived classes to receive the + output that is generated in this logger. + + The message being logged. @@ -13948,33 +14972,33 @@ The number of characters that the message should be indented. - - Holds a stack of reports for all running builds. - + + Holds a stack of reports for all running builds. + - - Gets or sets the highest level of message this logger should respond - to. - - - The highest level of message this logger should respond to. - - - Only messages with a message level higher than or equal to the given - level should be written to the log. - + + Gets or sets the highest level of message this logger should respond + to. + + + The highest level of message this logger should respond to. + + + Only messages with a message level higher than or equal to the given + level should be written to the log. + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - if output is to be unadorned so that emacs - and other editors can parse files names, etc. The default is - . - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + if output is to be unadorned so that emacs + and other editors can parse files names, etc. The default is + . + @@ -13986,100 +15010,100 @@ - - Used to store information about a build, to allow better reporting to - the user. - + + Used to store information about a build, to allow better reporting to + the user. + - - Errors encountered so far. - + + Errors encountered so far. + - - Warnings encountered so far. - + + Warnings encountered so far. + - - The start time of the build process. - + + The start time of the build process. + - - Buffers log messages from DefaultLogger, and sends an e-mail with the - results. - - - The following properties are used to send the mail : - - - Property - Description - - - MailLogger.mailhost - Mail server to use. [default: localhost] - - - MailLogger.from - The address of the e-mail sender. - - - MailLogger.failure.notify - Send build failure e-mails ? [default: true] - - - MailLogger.success.notify - Send build success e-mails ? [default: true] - - - MailLogger.failure.to - The address to send build failure messages to. - - - MailLogger.success.to - The address to send build success messages to. - - - MailLogger.failure.subject - The subject of build failure messages. [default: "Build Failure"] - - - MailLogger.success.subject - The subject of build success messages. [default: "Build Success"] - - - MailLogger.success.attachments - The ID of a fileset holdng set of files to attach when the build is successful. - - - MailLogger.failure.attachments - The ID of a fileset holdng set of files to attach when the build fails. - - - MailLogger.body.encoding - The encoding type of the body of the e-mail message. [default: system's ANSI code page] - - - MailLogger.smtp.username - The name of the user to login to the SMTP server. - - - MailLogger.smtp.password - The password of the specified user. - - - MailLogger.smtp.enablessl - Specifies whether to use SSL to encrypt the connection. [default: false] - - - MailLogger.smtp.port - The SMTP server port to connect to. [default: 25] - - - + + Buffers log messages from DefaultLogger, and sends an e-mail with the + results. + + + The following properties are used to send the mail : + + + Property + Description + + + MailLogger.mailhost + Mail server to use. [default: localhost] + + + MailLogger.from + The address of the e-mail sender. + + + MailLogger.failure.notify + Send build failure e-mails ? [default: true] + + + MailLogger.success.notify + Send build success e-mails ? [default: true] + + + MailLogger.failure.to + The address to send build failure messages to. + + + MailLogger.success.to + The address to send build success messages to. + + + MailLogger.failure.subject + The subject of build failure messages. [default: "Build Failure"] + + + MailLogger.success.subject + The subject of build success messages. [default: "Build Success"] + + + MailLogger.success.attachments + The ID of a fileset holdng set of files to attach when the build is successful. + + + MailLogger.failure.attachments + The ID of a fileset holdng set of files to attach when the build fails. + + + MailLogger.body.encoding + The encoding type of the body of the e-mail message. [default: system's ANSI code page] + + + MailLogger.smtp.username + The name of the user to login to the SMTP server. + + + MailLogger.smtp.password + The password of the specified user. + + + MailLogger.smtp.enablessl + Specifies whether to use SSL to encrypt the connection. [default: false] + + + MailLogger.smtp.port + The SMTP server port to connect to. [default: 25] + + + @@ -14106,10 +15130,10 @@ A object that contains the event data. - - Receives and buffers log messages. - - The message being logged. + + Receives and buffers log messages. + + The message being logged. @@ -14126,14 +15150,14 @@ is , and the specified property is not present and no default value has been given. - - Buffer in which the message is constructed prior to sending. - + + Buffer in which the message is constructed prior to sending. + - - Holds the stack of currently executing projects. - + + Holds the stack of currently executing projects. + @@ -14189,11 +15213,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -14226,10 +15250,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -14244,28 +15268,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -14284,46 +15308,46 @@ An object that controls formatting. - - Writes a character array to the buffer. - - The character array to write to the text stream. + + Writes a character array to the buffer. + + The character array to write to the text stream. - - Writes a string to the buffer. - - + + Writes a string to the buffer. + + - - Writes an empty string to the logging infrastructure. - + + Writes an empty string to the logging infrastructure. + - - Writes a string to the logging infrastructure. - - The string to write. If is a null reference, only the line termination characters are written. + + Writes a string to the logging infrastructure. + + The string to write. If is a null reference, only the line termination characters are written. - - Writes out a formatted string using the same semantics as - . - - The formatting string. - The object array to write into format string. + + Writes out a formatted string using the same semantics as + . + + The formatting string. + The object array to write into format string. - - Causes any buffered data to be written to the logging infrastructure. - + + Causes any buffered data to be written to the logging infrastructure. + - - Closes the current writer and releases any system resources - associated with the writer. - + + Closes the current writer and releases any system resources + associated with the writer. + @@ -14353,19 +15377,19 @@ - - Used to search for files on the PATH. - - - - The local directory is not searched (since this would already be covered - by normal use of the includes element). - - - Also, advanced pattern matching isn't supported: you need to know the - exact name of the file. - - + + Used to search for files on the PATH. + + + + The local directory is not searched (since this would already be covered + by normal use of the includes element). + + + Also, advanced pattern matching isn't supported: you need to know the + exact name of the file. + + @@ -14384,28 +15408,28 @@ - - Adds a file to the list of files to be scanned for. - - The filename or search pattern to add to the list. + + Adds a file to the list of files to be scanned for. + + The filename or search pattern to add to the list. - - Scans all direcetories in the PATH environment variable for files. - - - List of matching files found in the PATH. - + + Scans all direcetories in the PATH environment variable for files. + + + List of matching files found in the PATH. + - - Scans all directories in the given environment variable for files. - - The environment variable of which the directories should be scanned. - - List of matching files found in the directory of the given - environment variable. - + + Scans all directories in the given environment variable for files. + + The environment variable of which the directories should be scanned. + + List of matching files found in the directory of the given + environment variable. + @@ -14417,35 +15441,35 @@ - - Returns a value indicating whether NAnt is running in 64-bit mode. - - - if NAnt is running in 64-bit mode; otherwise, - . - + + Returns a value indicating whether NAnt is running in 64-bit mode. + + + if NAnt is running in 64-bit mode; otherwise, + . + - - Returns a value indicating whether NAnt is running in 32-bit mode. - - - Note that even if the platform is 64-bit, NAnt may be running in - 32-bit mode. - - - if NAnt is running in 32-bit mode; otherwise, - . - + + Returns a value indicating whether NAnt is running in 32-bit mode. + + + Note that even if the platform is 64-bit, NAnt may be running in + 32-bit mode. + + + if NAnt is running in 32-bit mode; otherwise, + . + - - Returns a value indicating whether NAnt is running on Windows. - - - if NAnt is running on Windows; - otherwise, . - + + Returns a value indicating whether NAnt is running on Windows. + + + if NAnt is running on Windows; + otherwise, . + @@ -14477,26 +15501,26 @@ - - Constant for the "visiting" state, used when traversing a DFS of - target dependencies. - + + Constant for the "visiting" state, used when traversing a DFS of + target dependencies. + - - Constant for the "visited" state, used when traversing a DFS of - target dependencies. - + + Constant for the "visited" state, used when traversing a DFS of + target dependencies. + - - Holds the logger for this class. - + + Holds the logger for this class. + - - Holds the default threshold for build loggers. - + + Holds the default threshold for build loggers. + @@ -14644,7 +15668,7 @@ - Dispatches a event to the build listeners + Dispatches a event to the build listeners for this . The source of the event. @@ -14652,7 +15676,7 @@ - Dispatches a event to the build listeners + Dispatches a event to the build listeners for this . The source of the event. @@ -14660,7 +15684,7 @@ - Dispatches a event to the build listeners + Dispatches a event to the build listeners for this . The source of the event. @@ -14668,7 +15692,7 @@ - Dispatches a event to the build listeners + Dispatches a event to the build listeners for this . The source of the event. @@ -14676,7 +15700,7 @@ - Dispatches a event to the build listeners + Dispatches a event to the build listeners for this . The source of the event. @@ -14684,7 +15708,7 @@ - Dispatches the event to the build listeners + Dispatches the event to the build listeners for this . The source of the event. @@ -14692,7 +15716,7 @@ - Dispatches a event to the build listeners + Dispatches a event to the build listeners for this . A that contains the event data. @@ -14742,33 +15766,33 @@ - - Executes a specific target, and its dependencies. - - The name of the target to execute. - - Global tasks are not executed. - + + Executes a specific target, and its dependencies. + + The name of the target to execute. + + Global tasks are not executed. + - - Executes a specific target. - - The name of the target to execute. - Whether dependencies should be forced to execute - - Global tasks are not executed. - + + Executes a specific target. + + The name of the target to execute. + Whether dependencies should be forced to execute + + Global tasks are not executed. + - - Executes the default target and wraps in error handling and time - stamping. - - - if the build was successful; otherwise, - . - + + Executes the default target and wraps in error handling and time + stamping. + + + if the build was successful; otherwise, + . + @@ -14971,20 +15995,20 @@ - - Gets or sets the indentation size of the build output. - - - The indendation size of the build output. - + + Gets or sets the indentation size of the build output. + + + The indendation size of the build output. + - - Gets or sets the default threshold level for build loggers. - - - The default threshold level for build loggers. - + + Gets or sets the default threshold level for build loggers. + + + The default threshold level for build loggers. + @@ -15031,20 +16055,20 @@ - - Gets a collection of available .NET frameworks. - - - A collection of available .NET frameworks. - + + Gets a collection of available .NET frameworks. + + + A collection of available .NET frameworks. + - - Gets the framework in which NAnt is currently running. - - - The framework in which NAnt is currently running. - + + Gets the framework in which NAnt is currently running. + + + The framework in which NAnt is currently running. + @@ -15083,22 +16107,22 @@ NAnt does not support the current platform. - - Gets the current target. - - - The current target, or if no target is - executing. - + + Gets the current target. + + + The current target, or if no target is + executing. + - - Gets the path to the build file. - - - The path to the build file, or if the build - document is not file backed. - + + Gets the path to the build file. + + + The path to the build file, or if the build + document is not file backed. + @@ -15119,70 +16143,70 @@ - - Gets the name of the target that will be executed when no other - build targets are specified. - - - The name of the target that will be executed when no other - build targets are specified, or if no - default target is specified in the build file. - + + Gets the name of the target that will be executed when no other + build targets are specified. + + + The name of the target that will be executed when no other + build targets are specified, or if no + default target is specified in the build file. + - - Gets a value indicating whether tasks should output more build log - messages. - - - if tasks should output more build log message; - otherwise, . - + + Gets a value indicating whether tasks should output more build log + messages. + + + if tasks should output more build log message; + otherwise, . + - - The list of targets to build. - - - Targets are built in the order they appear in the collection. If - the collection is empty the default target will be built. - + + The list of targets to build. + + + Targets are built in the order they appear in the collection. If + the collection is empty the default target will be built. + - - Gets the properties defined in this project. - - The properties defined in this project. - - - This is the collection of properties that are defined by the system - and property task statements. - - - These properties can be used in expansion. - - + + Gets the properties defined in this project. + + The properties defined in this project. + + + This is the collection of properties that are defined by the system + and property task statements. + + + These properties can be used in expansion. + + - - Gets the framework-neutral properties defined in the NAnt - configuration file. - - - The framework-neutral properties defined in the NAnt configuration - file. - - - - This is the collection of read-only properties that are defined in - the NAnt configuration file. - - - These properties can only be used for expansion in framework-specific - and framework-neutral configuration settings. These properties are - not available for expansion in the build file. - - + + Gets the framework-neutral properties defined in the NAnt + configuration file. + + + The framework-neutral properties defined in the NAnt configuration + file. + + + + This is the collection of read-only properties that are defined in + the NAnt configuration file. + + + These properties can only be used for expansion in framework-specific + and framework-neutral configuration settings. These properties are + not available for expansion in the build file. + + @@ -15199,51 +16223,51 @@ - - Gets the targets defined in this project. - - - The targets defined in this project. - + + Gets the targets defined in this project. + + + The targets defined in this project. + - - Gets the build listeners for this project. - - - The build listeners for this project. - + + Gets the build listeners for this project. + + + The build listeners for this project. + - - Allow the project construction to be optimized. - - - Use this with care! - + + Allow the project construction to be optimized. + + + Use this with care! + - - Do not perform any optimizations. - + + Do not perform any optimizations. + - - The project base directory must not be automatically scanned - for extension assemblies. - + + The project base directory must not be automatically scanned + for extension assemblies. + - - Do not scan the project configuration for frameworks, and - do not configure the runtime and target framework. - + + Do not scan the project configuration for frameworks, and + do not configure the runtime and target framework. + - - Holds a value indicating whether a scan for tasks, types and functions - has already been performed for the current runtime framework. - + + Holds a value indicating whether a scan for tasks, types and functions + has already been performed for the current runtime framework. + @@ -15272,15 +16296,15 @@ An representing global properties. - - Gets the value of the specified attribute from the specified node. - - The node of which the attribute value should be retrieved. - The attribute of which the value should be returned. - - The value of the attribute with the specified name or - if the attribute does not exist or has no value. - + + Gets the value of the specified attribute from the specified node. + + The node of which the attribute value should be retrieved. + The attribute of which the value should be returned. + + The value of the attribute with the specified name or + if the attribute does not exist or has no value. + @@ -15303,16 +16327,16 @@ - - Constant for the "visiting" state, used when traversing a DFS of - property references. - + + Constant for the "visiting" state, used when traversing a DFS of + property references. + - - Constant for the "visited" state, used when travesing a DFS of - property references. - + + Constant for the "visited" state, used when travesing a DFS of + property references. + @@ -15339,12 +16363,12 @@ The value of the element to remove. - - Performs additional custom processes when validating the element - with the specified key and value. - - The key of the element to validate. - The value of the element to validate. + + Performs additional custom processes when validating the element + with the specified key and value. + + The key of the element to validate. + The value of the element to validate. @@ -15358,45 +16382,45 @@ - - Marks a property as a property of which the value is expanded at - execution time. - - The name of the property to mark as dynamic. + + Marks a property as a property of which the value is expanded at + execution time. + + The name of the property to mark as dynamic. - - Adds a property to the collection. - - The name of the property. - The value to assign to the property. + + Adds a property to the collection. + + The name of the property. + The value to assign to the property. - - Determines whether the specified property is listed as read-only. - - The name of the property to check. - - if the property is listed as read-only; - otherwise, . - + + Determines whether the specified property is listed as read-only. + + The name of the property to check. + + if the property is listed as read-only; + otherwise, . + - - Determines whether the specified property is listed as dynamic. - - The name of the property to check. - - if the property is listed as dynamic; - otherwise, . - + + Determines whether the specified property is listed as dynamic. + + The name of the property to check. + + if the property is listed as dynamic; + otherwise, . + - - Inherits properties from an existing property dictionary Instance. - - Property list to inherit. - The list of properties to exclude during inheritance. + + Inherits properties from an existing property dictionary Instance. + + Property list to inherit. + The list of properties to exclude during inheritance. @@ -15407,20 +16431,20 @@ The expanded and replaced string. - - Determines whether a property already exists. - - The name of the property to check. - - if the specified property already exists; - otherwise, . - + + Determines whether a property already exists. + + The name of the property to check. + + if the specified property already exists; + otherwise, . + - - Removes the property with the specified name. - - The name of the property to remove. + + Removes the property with the specified name. + + The name of the property to remove. @@ -15433,20 +16457,20 @@ The expanded and replaced string. - - Evaluates the given expression string and returns the result - - - - - - + + Evaluates the given expression string and returns the result + + + + + + - - Checks whether the specified property is deprecated. - - The property to check. + + Checks whether the specified property is deprecated. + + The property to check. @@ -15461,33 +16485,33 @@ - - Maintains a list of the property names that are readonly. - + + Maintains a list of the property names that are readonly. + - - Maintains a list of the property names of which the value is expanded - on usage, not at initalization. - + + Maintains a list of the property names of which the value is expanded + on usage, not at initalization. + - - The project for which the dictionary holds properties. - + + The project for which the dictionary holds properties. + - - Indexer property. - + + Indexer property. + - - Gets the project for which the dictionary holds properties. - - - The project for which the dictionary holds properties. - + + Gets the project for which the dictionary holds properties. + + + The project for which the dictionary holds properties. + @@ -15511,14 +16535,14 @@ - - Executes dependent targets first, then the target. - + + Executes dependent targets first, then the target. + - - This indicates whether the target has already executed. - + + This indicates whether the target has already executed. + @@ -15536,19 +16560,19 @@ - - If then the target will be executed; - otherwise, skipped. The default is . - + + If then the target will be executed; + otherwise, skipped. The default is . + - - Gets a value indicating whether the target should be executed. - - - if the target should be executed; otherwise, - . - + + Gets a value indicating whether the target should be executed. + + + if the target should be executed; otherwise, + . + @@ -15558,29 +16582,29 @@ - - Gets a value indicating whether the target should NOT be executed. - - - if the target should NOT be executed; - otherwise, . - + + Gets a value indicating whether the target should NOT be executed. + + + if the target should NOT be executed; + otherwise, . + - - The description of the target. - + + The description of the target. + - - Space separated list of targets that this target depends on. - + + Space separated list of targets that this target depends on. + - - A collection of target names that must be executed before this - target. - + + A collection of target names that must be executed before this + target. + @@ -15719,11 +16743,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -15756,10 +16780,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -15780,34 +16804,34 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Comprises all of the loaded, and available, tasks. - Use these static methods to register, initialize and create a task. - + + Comprises all of the loaded, and available, tasks. + Use these static methods to register, initialize and create a task. + @@ -15836,11 +16860,11 @@ indicating whether scanning of the directory should halt on first error. - - Adds any task assemblies in the project base directory - and its tasks subdirectory. - - The project to work from. + + Adds any task assemblies in the project base directory + and its tasks subdirectory. + + The project to work from. @@ -15995,14 +17019,14 @@ The that contains contextual information about the source or destination. - - Used to wrap log messages in xml <message/> elements. - + + Used to wrap log messages in xml <message/> elements. + - - Holds the stack of currently executing projects. - + + Holds the stack of currently executing projects. + @@ -16026,9 +17050,9 @@ The destination for this serialization. - - Returns the contents of log captured. - + + Returns the contents of log captured. + @@ -16096,31 +17120,31 @@ - - Flushes buffered build events or messages to the underlying storage. - + + Flushes buffered build events or messages to the underlying storage. + - - Gets or sets the highest level of message this logger should respond - to. - - - The highest level of message this logger should respond to. - - - Only messages with a message level higher than or equal to the given - level should be written to the log. - + + Gets or sets the highest level of message this logger should respond + to. + + + The highest level of message this logger should respond to. + + + Only messages with a message level higher than or equal to the given + level should be written to the log. + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - as it has no meaning in XML format. - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + as it has no meaning in XML format. + diff --git a/Tools/nant/bin/NAnt.DotNetTasks.dll b/Tools/nant/bin/NAnt.DotNetTasks.dll index 00e3918..7e2b702 100755 Binary files a/Tools/nant/bin/NAnt.DotNetTasks.dll and b/Tools/nant/bin/NAnt.DotNetTasks.dll differ diff --git a/Tools/nant/bin/NAnt.DotNetTasks.xml b/Tools/nant/bin/NAnt.DotNetTasks.xml index afce140..a94a73a 100755 --- a/Tools/nant/bin/NAnt.DotNetTasks.xml +++ b/Tools/nant/bin/NAnt.DotNetTasks.xml @@ -63,9 +63,9 @@ - - Generates an AssemblyInfo file. - + + Generates an AssemblyInfo file. + @@ -79,66 +79,66 @@ - - Name of the AssemblyInfo file to generate. - - - The name of the AssemblyInfo file to generate. - + + Name of the AssemblyInfo file to generate. + + + The name of the AssemblyInfo file to generate. + - - The code language in which the AssemblyInfo file should be - generated. - + + The code language in which the AssemblyInfo file should be + generated. + - - The assembly-level attributes to generate. - - - The assembly-level attributes to generate. - + + The assembly-level attributes to generate. + + + The assembly-level attributes to generate. + - - The namespaces to import. - - - The namespaces to import. - + + The namespaces to import. + + + The namespaces to import. + - - Assembly files used to locate the types of the specified attributes. - + + Assembly files used to locate the types of the specified attributes. + - - Defines the supported code languages for generating an AssemblyInfo - file. - + + Defines the supported code languages for generating an AssemblyInfo + file. + - - A value for generating C# code. - + + A value for generating C# code. + - - A value for generating JScript code. - + + A value for generating JScript code. + - - A value for generating Visual Basic code. - + + A value for generating Visual Basic code. + - - Encapsulates functionality to generate a code file with imports - and assembly-level attributes. - + + Encapsulates functionality to generate a code file with imports + and assembly-level attributes. + @@ -215,67 +215,85 @@ A identified by could not be located or loaded. + + + Finds a given type from a given list of assemblies and import statements. + + + A list of assemblies to search for a given type. + + + A list of import statements to search for a given type. + + + The name of the type to locate. + + + The type object found from assemblies and import statements based + on the name of the type. + + - - Wraps al.exe, the assembly linker for the .NET Framework. - - - - All specified sources will be embedded using the /embed flag. - Other source types are not supported. - - - - - Create a library containing all icon files in the current directory. - - - - - - - - ]]> - - - - - Create an executable assembly manifest from modules. - - - - - - - - - ]]> - - + + Wraps al.exe, the assembly linker for the .NET Framework. + + + + All specified sources will be embedded using the /embed flag. + Other source types are not supported. + + + + + Create a library containing all icon files in the current directory. + + + + + + + + ]]> + + + + + Create an executable assembly manifest from modules. + + + + + + + + + ]]> + + - - Generates an assembly manifest. - + + Generates an assembly manifest. + - - Determines whether the assembly manifest needs compiling or is - uptodate. - - - if the assembly manifest needs compiling; - otherwise, . - + + Determines whether the assembly manifest needs compiling or is + uptodate. + + + if the assembly manifest needs compiling; + otherwise, . + - - Specifies an algorithm (in hexadecimal) to hash all files in a - multifile assembly except the file that contains the assembly - manifest. The default algorithm is CALG_SHA1. - + + Specifies an algorithm (in hexadecimal) to hash all files in a + multifile assembly except the file that contains the assembly + manifest. The default algorithm is CALG_SHA1. + @@ -314,21 +332,21 @@ - - The culture string associated with the output assembly. - The string must be in RFC 1766 format, such as "en-US". - - - - Corresponds with the /c[ulture]: flag. - - + + The culture string associated with the output assembly. + The string must be in RFC 1766 format, such as "en-US". + + + + Corresponds with the /c[ulture]: flag. + + - - Specifies whether the assembly should be partially signed. The default - is . - + + Specifies whether the assembly should be partially signed. The default + is . + @@ -343,199 +361,199 @@ - - Security evidence file to embed. - - - The security evidence file to embed. - - - - Corresponds with the /e[vidence] flag. - - + + Security evidence file to embed. + + + The security evidence file to embed. + + + + Corresponds with the /e[vidence] flag. + + - - Specifies a string for the File Version field in the assembly. - - - A string for the File Version field in the assembly. - + + Specifies a string for the File Version field in the assembly. + + + A string for the File Version field in the assembly. + - - Specifies a value (in hexadecimal) for the Flags field in - the assembly. - - - A value (in hexadecimal) for the Flags field in the assembly. - + + Specifies a value (in hexadecimal) for the Flags field in + the assembly. + + + A value (in hexadecimal) for the Flags field in the assembly. + - - Specifies a container that holds a key pair. - + + Specifies a container that holds a key pair. + - - Specifies a file (filename) that contains a key pair or - just a public key to sign an assembly. - - - The complete path to the key file. - - - - Corresponds with the /keyf[ile]: flag. - - + + Specifies a file (filename) that contains a key pair or + just a public key to sign an assembly. + + + The complete path to the key file. + + + + Corresponds with the /keyf[ile]: flag. + + - - Specifies the fully-qualified name (class.method) of the method to - use as an entry point when converting a module to an executable file. - - - The fully-qualified name (class.method) of the method to use as an - entry point when converting a module to an executable file. - + + Specifies the fully-qualified name (class.method) of the method to + use as an entry point when converting a module to an executable file. + + + The fully-qualified name (class.method) of the method to use as an + entry point when converting a module to an executable file. + - - One or more modules to be compiled into an assembly. - + + One or more modules to be compiled into an assembly. + - - The name of the output file for the assembly manifest. - - - The complete output path for the assembly manifest. - - - - Corresponds with the /out flag. - - + + The name of the output file for the assembly manifest. + + + The complete output path for the assembly manifest. + + + + Corresponds with the /out flag. + + - - The target type (one of lib, exe, or winexe). - - - - Corresponds with the /t[arget]: flag. - - + + The target type (one of lib, exe, or winexe). + + + + Corresponds with the /t[arget]: flag. + + - - Specifies a string for the Product field in the assembly. - - - A string for the Product field in the assembly. - + + Specifies a string for the Product field in the assembly. + + + A string for the Product field in the assembly. + - - Specifies a string for the Product Version field in the assembly. - - - A string for the Product Version field in the assembly. - + + Specifies a string for the Product Version field in the assembly. + + + A string for the Product Version field in the assembly. + - - The set of resources to embed. - + + The set of resources to embed. + - - The set of compiled resources to embed. - - - Do not yet expose this to build authors. - + + The set of compiled resources to embed. + + + Do not yet expose this to build authors. + - - Indicates whether the assembly linker for a given target framework - supports the "template" option, which takes an assembly from which - to get all options except the culture field. - The default is . - - - TODO: remove this once Mono bug #74814 is fixed. - + + Indicates whether the assembly linker for a given target framework + supports the "template" option, which takes an assembly from which + to get all options except the culture field. + The default is . + + + TODO: remove this once Mono bug #74814 is fixed. + - - Specifies an assembly from which to get all options except the - culture field. - - - The complete path to the assembly template. - - - - Corresponds with the /template: flag. - - + + Specifies an assembly from which to get all options except the + culture field. + + + The complete path to the assembly template. + + + + Corresponds with the /template: flag. + + - - Specifies a string for the Title field in the assembly. - - - A string for the Title field in the assembly. - + + Specifies a string for the Title field in the assembly. + + + A string for the Title field in the assembly. + - - Specifies a string for the Trademark field in the assembly. - - - A string for the Trademark field in the assembly. - + + Specifies a string for the Trademark field in the assembly. + + + A string for the Trademark field in the assembly. + - - Specifies version information for the assembly. The format of the - version string is major.minor.build.revision. - + + Specifies version information for the assembly. The format of the + version string is major.minor.build.revision. + - - Icon to associate with the assembly. - + + Icon to associate with the assembly. + - - Inserts a Win32 resource (.res file) in the output file. - + + Inserts a Win32 resource (.res file) in the output file. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program or - if the task is not being executed. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program or + if the task is not being executed. + - - Provides the abstract base class for compiler tasks. - + + Provides the abstract base class for compiler tasks. + - - Contains a list of extensions for all file types that should be treated as - 'code-behind' when looking for resources. Ultimately this will determine - if we use the "namespace+filename" or "namespace+classname" algorithm, since - code-behind will use the "namespace+classname" algorithm. - + + Contains a list of extensions for all file types that should be treated as + 'code-behind' when looking for resources. Ultimately this will determine + if we use the "namespace+filename" or "namespace+classname" algorithm, since + code-behind will use the "namespace+classname" algorithm. + @@ -552,9 +570,9 @@ - - Compiles the sources and resources. - + + Compiles the sources and resources. + @@ -585,14 +603,14 @@ - - Extracts the associated namespace/classname linkage found in the - given stream. - - The read-only stream of the source file to search. - - The namespace/classname of the source file matching the resource. - + + Extracts the associated namespace/classname linkage found in the + given stream. + + The read-only stream of the source file to search. + + The namespace/classname of the source file matching the resource. + @@ -654,39 +672,39 @@ - - Determines whether compilation is needed. - + + Determines whether compilation is needed. + - - Finds the correct namespace/classname for a resource file from the - given dependent source file. - - The file from which the resource linkage of the resource file should be determined. - The culture of the resource file for which the resource linkage should be determined. - - The namespace/classname of the source file matching the resource or - if the dependent source file does not exist. - - - This behaviour may be overidden by each particular compiler to - support the namespace/classname syntax for that language. - + + Finds the correct namespace/classname for a resource file from the + given dependent source file. + + The file from which the resource linkage of the resource file should be determined. + The culture of the resource file for which the resource linkage should be determined. + + The namespace/classname of the source file matching the resource or + if the dependent source file does not exist. + + + This behaviour may be overidden by each particular compiler to + support the namespace/classname syntax for that language. + - - Link a list of files into a resource assembly. - - The collection of resources. - Resource assembly to generate - Culture of the generated assembly. + + Link a list of files into a resource assembly. + + The collection of resources. + Resource assembly to generate + Culture of the generated assembly. - - Compiles a set of resx files to a .resources files. - - The set of resx files to compile. + + Compiles a set of resx files to a .resources files. + + The set of resx files to compile. @@ -701,157 +719,157 @@ - - Generate debug output. The default is . - - - Only used for <jsc> tasks, but retained for backward - compatibility (Clover.NET). - + + Generate debug output. The default is . + + + Only used for <jsc> tasks, but retained for backward + compatibility (Clover.NET). + - - The output file created by the compiler. - + + The output file created by the compiler. + - - Output type. Possible values are exe, winexe, - library or module. - + + Output type. Possible values are exe, winexe, + library or module. + - - Define conditional compilation symbol(s). - - - - Corresponds to /d[efine]: flag. - - + + Define conditional compilation symbol(s). + + + + Corresponds to /d[efine]: flag. + + - - Icon to associate with the application. - - - - Corresponds to /win32icon: flag. - - + + Icon to associate with the application. + + + + Corresponds to /win32icon: flag. + + - - Specifies a Win32 resource file (.res). - - - - Corresponds to /win32res[ource]: flag. - - + + Specifies a Win32 resource file (.res). + + + + Corresponds to /win32res[ource]: flag. + + - - Instructs the compiler to treat all warnings as errors. The default - is . - - - - Corresponds to the /warnaserror[+|-] flag of the compiler. - - - When this property is set to , any messages - that would ordinarily be reported as warnings will instead be - reported as errors. - - + + Instructs the compiler to treat all warnings as errors. The default + is . + + + + Corresponds to the /warnaserror[+|-] flag of the compiler. + + + When this property is set to , any messages + that would ordinarily be reported as warnings will instead be + reported as errors. + + - - Controls which warnings should be reported as errors. - + + Controls which warnings should be reported as errors. + - - Specifies a comma-separated list of warnings that should be suppressed - by the compiler. - - - Comma-separated list of warnings that should be suppressed by the - compiler. - - - - Corresponds with the /nowarn flag. - - + + Specifies a comma-separated list of warnings that should be suppressed + by the compiler. + + + Comma-separated list of warnings that should be suppressed by the + compiler. + + + + Corresponds with the /nowarn flag. + + - - Specifies a list of warnings that you want the compiler to suppress. - + + Specifies a list of warnings that you want the compiler to suppress. + - - Instructs NAnt to recompile the output file regardless of the file timestamps. - - - When this parameter is to , NAnt will always - run the compiler to rebuild the output file, regardless of the file timestamps. - + + Instructs NAnt to recompile the output file regardless of the file timestamps. + + + When this parameter is to , NAnt will always + run the compiler to rebuild the output file, regardless of the file timestamps. + - - Specifies which type contains the Main method that you want to use - as the entry point into the program. - - - - Corresponds to the /m[ain]: flag of the compiler. - - - Use this property when creating an executable file. If this property - is not set, the compiler searches for a valid Main method in all - public classes. - - + + Specifies which type contains the Main method that you want to use + as the entry point into the program. + + + + Corresponds to the /m[ain]: flag of the compiler. + + + Use this property when creating an executable file. If this property + is not set, the compiler searches for a valid Main method in all + public classes. + + - - Specifies the key pair container used to strongname the assembly. - + + Specifies the key pair container used to strongname the assembly. + - - Specifies a strong name key file. - + + Specifies a strong name key file. + - - Specifies whether to delay sign the assembly using only the public - portion of the strong name key. The default is - . - - + + Specifies whether to delay sign the assembly using only the public + portion of the strong name key. The default is + . + + - - Additional directories to search in for assembly references. - - - - Corresponds with the /lib[path]: flag. - - + + Additional directories to search in for assembly references. + + + + Corresponds with the /lib[path]: flag. + + - - Reference metadata from the specified assembly files. - + + Reference metadata from the specified assembly files. + - - Specifies list of packages to reference. - + + Specifies list of packages to reference. + @@ -881,85 +899,85 @@ - - Link the specified modules into this assembly. - + + Link the specified modules into this assembly. + - - The set of source files for compilation. - + + The set of source files for compilation. + - - Indicates whether package references are supported by compiler for - a given target framework. The default is . - + + Indicates whether package references are supported by compiler for + a given target framework. The default is . + - - Indicates whether the compiler for a given target framework supports - the "warnaserror" option that takes a list of warnings. The default - is . - + + Indicates whether the compiler for a given target framework supports + the "warnaserror" option that takes a list of warnings. The default + is . + - - Indicates whether the compiler for a given target framework supports - a command line option that allows a list of warnings to be - suppressed. The default is . - + + Indicates whether the compiler for a given target framework supports + a command line option that allows a list of warnings to be + suppressed. The default is . + - - Indicates whether the compiler for a given target framework supports - the "keycontainer" option. The default is . - + + Indicates whether the compiler for a given target framework supports + the "keycontainer" option. The default is . + - - Indicates whether the compiler for a given target framework supports - the "keyfile" option. The default is . - + + Indicates whether the compiler for a given target framework supports + the "keyfile" option. The default is . + - - Indicates whether the compiler for a given target framework supports - the "delaysign" option. The default is . - + + Indicates whether the compiler for a given target framework supports + the "delaysign" option. The default is . + - - Gets the file extension required by the current compiler. - - - The file extension required by the current compiler. - + + Gets the file extension required by the current compiler. + + + The file extension required by the current compiler. + - - Gets the class name regular expression for the language of the current compiler. - - class name regular expression for the language of the current compiler + + Gets the class name regular expression for the language of the current compiler. + + class name regular expression for the language of the current compiler - - Gets the namespace regular expression for the language of the current compiler. - - namespace regular expression for the language of the current compiler + + Gets the namespace regular expression for the language of the current compiler. + + namespace regular expression for the language of the current compiler - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Holds class and namespace information for resource (*.resx) linkage. - + + Holds class and namespace information for resource (*.resx) linkage. + @@ -970,12 +988,12 @@ The class name the resource is associated with. - - Returns the resource linkage as a string. - - - A string representation of the resource linkage. - + + Returns the resource linkage as a string. + + + A string representation of the resource linkage. + @@ -1010,29 +1028,29 @@ - - Gets the name of namespace the resource is under. - - - The name of namespace the resource is under. - + + Gets the name of namespace the resource is under. + + + The name of namespace the resource is under. + - - Gets the name of the class (most likely a form) that the resource - is associated with. - - - The name of the class the resource is associated with. - + + Gets the name of the class (most likely a form) that the resource + is associated with. + + + The name of the class the resource is associated with. + - - Gets the culture that the resource is associated with. - - - The culture that the resource is associated with. - + + Gets the culture that the resource is associated with. + + + The culture that the resource is associated with. + @@ -1079,29 +1097,29 @@ to which the compiler options should be written. - - Determines whether compilation is needed. - + + Determines whether compilation is needed. + - - The preferred base address at which to load a DLL. The default base - address for a DLL is set by the .NET Framework common language - runtime. - - - The preferred base address at which to load a DLL. - - - This address can be specified as a decimal, hexadecimal, or octal - number. - + + The preferred base address at which to load a DLL. The default base + address for a DLL is set by the .NET Framework common language + runtime. + + + The preferred base address at which to load a DLL. + + + This address can be specified as a decimal, hexadecimal, or octal + number. + - - Specifies the type of debugging information generated by the - compiler. The default is . - + + Specifies the type of debugging information generated by the + compiler. The default is . + @@ -1110,184 +1128,184 @@ - - The name of the XML documentation file to generate. - - - - Corresponds with the /doc: flag. - - + + The name of the XML documentation file to generate. + + + + Corresponds with the /doc: flag. + + - - Specifies the size of sections in the output file. Valid values are - 512, 1024, 2048, 4096, and 8192. - - - The size of sections in the output file. - + + Specifies the size of sections in the output file. Valid values are + 512, 1024, 2048, 4096, and 8192. + + + The size of sections in the output file. + - - Instructs the compiler not to import mscorlib.dll. The default is - . - - - - Corresponds with the /nostdlib[+|-] flag. - - + + Instructs the compiler not to import mscorlib.dll. The default is + . + + + + Corresponds with the /nostdlib[+|-] flag. + + - - Instructs the compiler not to use implicit references to assemblies. - The default is . - - - - Corresponds with the /noconfig flag. - - + + Instructs the compiler not to use implicit references to assemblies. + The default is . + + + + Corresponds with the /noconfig flag. + + - - Specifies whether an integer arithmetic statement that is not in - the scope of the checked or unchecked keywords and - that results in a value outside the range of the data type should - cause a run-time exception. The default is . - - - - Corresponds with the /checked[+|-] flag. - - + + Specifies whether an integer arithmetic statement that is not in + the scope of the checked or unchecked keywords and + that results in a value outside the range of the data type should + cause a run-time exception. The default is . + + + + Corresponds with the /checked[+|-] flag. + + - - Instructs the compiler to allow code that uses the unsafe - keyword. The default is . - - - - Corresponds with the /unsafe[+|-] flag. - - + + Instructs the compiler to allow code that uses the unsafe + keyword. The default is . + + + + Corresponds with the /unsafe[+|-] flag. + + - - Causes the compiler to only accept syntax that is included in a - given specification. - - - - Corresponds with the /langversion flag. - - + + Causes the compiler to only accept syntax that is included in a + given specification. + + + + Corresponds with the /langversion flag. + + - - Specifies whether the compiler should perform optimizations to the - make output files smaller, faster, and more effecient. The default - is . - - - if the compiler should perform optimizations; - otherwise, . - - - - Corresponds with the /optimize[+|-] flag. - - + + Specifies whether the compiler should perform optimizations to the + make output files smaller, faster, and more effecient. The default + is . + + + if the compiler should perform optimizations; + otherwise, . + + + + Corresponds with the /optimize[+|-] flag. + + - - Specifies which platform version of common language runtime (CLR) - can run the output file. - - - The platform version of common language runtime (CLR) that can run - the output file. - - - - Corresponds with the /platform flag. - - + + Specifies which platform version of common language runtime (CLR) + can run the output file. + + + The platform version of common language runtime (CLR) that can run + the output file. + + + + Corresponds with the /platform flag. + + - - Specifies the warning level for the compiler to display. Valid values - are 0-4. The default is 4. - - - The warning level for the compiler to display. - - - - Corresponds with the /warn flag. - - + + Specifies the warning level for the compiler to display. Valid values + are 0-4. The default is 4. + + + The warning level for the compiler to display. + + + + Corresponds with the /warn flag. + + - - Specifies the code page to use for all source code files in the - compilation. - - - - Corresponds with the /codepage flag. - - + + Specifies the code page to use for all source code files in the + compilation. + + + + Corresponds with the /codepage flag. + + - - Specifies whether the compiler for the active target framework - supports generation of XML Documentation file. The default is - . - + + Specifies whether the compiler for the active target framework + supports generation of XML Documentation file. The default is + . + - - Specifies whether the compiler for the active target framework - supports limiting the platform on which the compiled code can run. - The default is . - + + Specifies whether the compiler for the active target framework + supports limiting the platform on which the compiled code can run. + The default is . + - - Specifies whether the compiler for the active target framework - supports accepting only a specific language syntax. - The default is . - + + Specifies whether the compiler for the active target framework + supports accepting only a specific language syntax. + The default is . + - - Gets the file extension required by the current compiler. - - - For the C# compiler, the file extension is always cs. - + + Gets the file extension required by the current compiler. + + + For the C# compiler, the file extension is always cs. + - - Gets the class name regular expression for the language of the - current compiler. - - - Class name regular expression for the language of the current - compiler. - + + Gets the class name regular expression for the language of the + current compiler. + + + Class name regular expression for the language of the current + compiler. + - - Gets the namespace regular expression for the language of the current compiler. - - - Namespace regular expression for the language of the current - compiler. - + + Gets the namespace regular expression for the language of the current compiler. + + + Namespace regular expression for the language of the current + compiler. + @@ -1315,61 +1333,61 @@ - - Converts a single file or group of files. - + + Converts a single file or group of files. + - - List of assemblies/executables to sign. - + + List of assemblies/executables to sign. + - - Specifies the filesystem path to the signing key. - + + Specifies the filesystem path to the signing key. + - - Specifies the key container. - + + Specifies the key container. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Compiles ILASM programs. - - - - Compiles helloworld.il to helloworld.exe. - - - - - - - - ]]> - - + + Compiles ILASM programs. + + + + Compiles helloworld.il to helloworld.exe. + + + + + + + + ]]> + + - - Compiles the sources. - + + Compiles the sources. + - - Writes the compiler options. - + + Writes the compiler options. + @@ -1402,262 +1420,262 @@ - - Determines whether or not compilation is needed. - - - if compilation is needed; otherwise, - . - + + Determines whether or not compilation is needed. + + + if compilation is needed; otherwise, + . + - - Specifies whether or not the compiler should measure and report - the compilation times. - - - if the compilation times should be - measured and reported; otherwise, . The - default is . - - - - Corresponds to the /CLOCK flag. - - + + Specifies whether or not the compiler should measure and report + the compilation times. + + + if the compilation times should be + measured and reported; otherwise, . The + default is . + + + + Corresponds to the /CLOCK flag. + + - - Specifies whether or not the compiler should generate debug - information. - - - if debug information should be generated; - otherwise, . The default is - . - - - - Corresponds to the /DEBUG flag. - - + + Specifies whether or not the compiler should generate debug + information. + + + if debug information should be generated; + otherwise, . The default is + . + + + + Corresponds to the /DEBUG flag. + + - - Specifies whether or not the compiler should attempt to create a - PE file even if compilation errors have been reported. - - - if a PE file has to be created even if - compilation errors have been reported; otherwise, - . The default is . - - - - Corresponds to the /ERROR flag. - - + + Specifies whether or not the compiler should attempt to create a + PE file even if compilation errors have been reported. + + + if a PE file has to be created even if + compilation errors have been reported; otherwise, + . The default is . + + + + Corresponds to the /ERROR flag. + + - - Instructs NAnt to recompile the output file regardless of the file - timestamps. - - - if the output file should be recompiled - regardless of its timestamps; otherwise . - The default is . - + + Instructs NAnt to recompile the output file regardless of the file + timestamps. + + + if the output file should be recompiled + regardless of its timestamps; otherwise . + The default is . + - - Specifies whether or not the compiler should type a formatted - listing of the compilation result. - - - if a formatted listing of the compilation - result should be typed; otherwise, . The - default is . - - - - Corresponds to the /LISTING flag. - - + + Specifies whether or not the compiler should type a formatted + listing of the compilation result. + + + if a formatted listing of the compilation + result should be typed; otherwise, . The + default is . + + + + Corresponds to the /LISTING flag. + + - - Instructs the compiler to set the FileAlignment value in - the PE header. - - - An that represents the FileAlignment - value to set in the PE header. The value must be a power of 2, in - range from 512 to 65536. - - - - Corresponds to the /ALIGNMENT flag. - - + + Instructs the compiler to set the FileAlignment value in + the PE header. + + + An that represents the FileAlignment + value to set in the PE header. The value must be a power of 2, in + range from 512 to 65536. + + + + Corresponds to the /ALIGNMENT flag. + + - - Instructs the compiler to set the ImageBase value in - the PE header. - - - A that represents the ImageBase - value to set in the PE header. - - - - Corresponds to the /BASE flag. - - + + Instructs the compiler to set the ImageBase value in + the PE header. + + + A that represents the ImageBase + value to set in the PE header. + + + + Corresponds to the /BASE flag. + + - - Instructs the compiler to set the Flags value in the CLR - header. - - - An that represents the Flags - value to set in the CLR header. The most frequently value are 1 - (pre-IL code) and 2 (mixed code). The third bit indicating that - the PE file is strong signed, is ignored. - - - - Corresponds to the /FLAGS flag. - - + + Instructs the compiler to set the Flags value in the CLR + header. + + + An that represents the Flags + value to set in the CLR header. The most frequently value are 1 + (pre-IL code) and 2 (mixed code). The third bit indicating that + the PE file is strong signed, is ignored. + + + + Corresponds to the /FLAGS flag. + + - - Instructs the compiler to set the Subsystem value in the PE - header. - - - An that represents the Subsystem - value to set in the PE header. The most frequently value are 3 - (console application) and 2 (GUI application). - - - - Corresponds to the /SUBSYSTEM flag. - - + + Instructs the compiler to set the Subsystem value in the PE + header. + + + An that represents the Subsystem + value to set in the PE header. The most frequently value are 3 + (console application) and 2 (GUI application). + + + + Corresponds to the /SUBSYSTEM flag. + + - - Specifies which output type should be generated. - - - A that contains the target type. - Possible values are dll and exe. - - - - Corresponds to the /OUTPUT flag. - - + + Specifies which output type should be generated. + + + A that contains the target type. + Possible values are dll and exe. + + + + Corresponds to the /OUTPUT flag. + + - - Instructs the compiler to generate a strong signature of the PE - file. - - - A that contains the private - encryption key. - - - - Corresponds to the /KEY=keysource]]> - flag. - - + + Instructs the compiler to generate a strong signature of the PE + file. + + + A that contains the private + encryption key. + + + + Corresponds to the /KEY=keysource]]> + flag. + + - - Instructs the compiler to generate a strong signature of the PE - file. - - - A that represents the file - containing the private encryption key. - - - - Corresponds to the /KEY=keyfile]]> - flag. - - + + Instructs the compiler to generate a strong signature of the PE + file. + + + A that represents the file + containing the private encryption key. + + + + Corresponds to the /KEY=keyfile]]> + flag. + + - - Specifies the name of the output file created by the compiler. - - - A that represents the name of - the output file. - - - - Corresponds to the /OUTPUT flag. - - + + Specifies the name of the output file created by the compiler. + + + A that represents the name of + the output file. + + + + Corresponds to the /OUTPUT flag. + + - - Instructs the compiler to link the specified unmanaged resource - file into the resulting PE file. - - - A that represents the unmanaged - resource file to link. - - - - Corresponds to the /RESOURCE flag. - - + + Instructs the compiler to link the specified unmanaged resource + file into the resulting PE file. + + + A that represents the unmanaged + resource file to link. + + + + Corresponds to the /RESOURCE flag. + + - - Specifies the set of source files to compile. - - - A that represents the set - of source files to compile. - + + Specifies the set of source files to compile. + + + A that represents the set + of source files to compile. + - - Gets the command-line arguments for the external program. - - - A that contains the command-line - arguments for the external program. - + + Gets the command-line arguments for the external program. + + + A that contains the command-line + arguments for the external program. + - - Compiles JScript.NET programs. - - - Compile helloworld.js to helloworld.exe. - - - - - - - ]]> - - + + Compiles JScript.NET programs. + + + Compile helloworld.js to helloworld.exe. + + + + + + + ]]> + + @@ -1672,16 +1690,16 @@ to which the compiler options should be written. - - Automatically references assemblies if they have the same name as - an imported namespace or as a type annotation when declaring a - variable. The default is . - - - - Corresponds with the /autoref flag. - - + + Automatically references assemblies if they have the same name as + an imported namespace or as a type annotation when declaring a + variable. The default is . + + + + Corresponds with the /autoref flag. + + @@ -1696,216 +1714,216 @@ - - Specifies which platform version of common language runtime (CLR) - can run the output file. - - - The platform version of common language runtime (CLR) that can run - the output file. - - - - Corresponds with the /platform flag. - - + + Specifies which platform version of common language runtime (CLR) + can run the output file. + + + The platform version of common language runtime (CLR) that can run + the output file. + + + + Corresponds with the /platform flag. + + - - Causes the compiler to generate errors for implicit method - overrides. The default is . - - - - Corresponds with the /versionsafe flag. - - + + Causes the compiler to generate errors for implicit method + overrides. The default is . + + + + Corresponds with the /versionsafe flag. + + - - Specifies the warning level for the compiler to display. Valid - values are 0-4. The default is 4. - - - The warning level for the compiler to display. - - - - Corresponds with the /warn flag. - - + + Specifies the warning level for the compiler to display. Valid + values are 0-4. The default is 4. + + + The warning level for the compiler to display. + + + + Corresponds with the /warn flag. + + - - Controls which warnings should be reported as errors. - - - Override to avoid exposing this to build authors, as the JScript.NET - compiler does not allow control over which warnings should be - reported as errors. - + + Controls which warnings should be reported as errors. + + + Override to avoid exposing this to build authors, as the JScript.NET + compiler does not allow control over which warnings should be + reported as errors. + - - Specifies a comma-separated list of warnings that should be suppressed - by the compiler. - - - Override to avoid exposing this to build authors, as the JScript.NET - compiler does not support package references. - + + Specifies a comma-separated list of warnings that should be suppressed + by the compiler. + + + Override to avoid exposing this to build authors, as the JScript.NET + compiler does not support package references. + - - Specifies a list of warnings that you want the compiler to suppress. - - - Override to avoid exposing this to build authors, as the JScript.NET - compiler does not support suppressing warnings. - + + Specifies a list of warnings that you want the compiler to suppress. + + + Override to avoid exposing this to build authors, as the JScript.NET + compiler does not support suppressing warnings. + - - Specifies the code page to use for all source code files in the - compilation. - - - - Corresponds with the /codepage flag. - - + + Specifies the code page to use for all source code files in the + compilation. + + + + Corresponds with the /codepage flag. + + - - Specifies the key pair container used to strongname the assembly. - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Specifies the key pair container used to strongname the assembly. + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Specifies a strong name key file. - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Specifies a strong name key file. + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Specifies whether to delay sign the assembly using only the public - portion of the strong name key. - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Specifies whether to delay sign the assembly using only the public + portion of the strong name key. + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Indicates whether the compiler for a given target framework supports - the "keycontainer" option. The default is . - - - . - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Indicates whether the compiler for a given target framework supports + the "keycontainer" option. The default is . + + + . + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Indicates whether the compiler for a given target framework supports - the "keyfile" option. The default is . - - - . - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Indicates whether the compiler for a given target framework supports + the "keyfile" option. The default is . + + + . + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Indicates whether the compiler for a given target framework supports - the "delaysign" option. The default is . - - - . - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Indicates whether the compiler for a given target framework supports + the "delaysign" option. The default is . + + + . + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Specifies whether the compiler for the active target framework - supports limiting the platform on which the compiled code can run. - The default is . - + + Specifies whether the compiler for the active target framework + supports limiting the platform on which the compiled code can run. + The default is . + - - Link the specified modules into this assembly. - - - Override to avoid exposing this to build authors, as the JScript.NET - compiler does not support linking modules. - + + Link the specified modules into this assembly. + + + Override to avoid exposing this to build authors, as the JScript.NET + compiler does not support linking modules. + - - Gets the file extension required by the current compiler. - - - For the JScript.NET compiler, the file extension is always js. - + + Gets the file extension required by the current compiler. + + + For the JScript.NET compiler, the file extension is always js. + - - Gets the class name regular expression for the language of the - current compiler. - - - Class name regular expression for the language of the current - compiler. - + + Gets the class name regular expression for the language of the + current compiler. + + + Class name regular expression for the language of the current + compiler. + - - Gets the namespace regular expression for the language of the - current compiler. - - - Namespace regular expression for the language of the current - compiler. - + + Gets the namespace regular expression for the language of the + current compiler. + + + Namespace regular expression for the language of the current + compiler. + - - Generates a .licence file from a .licx file. - - - - If no output file is specified, the default filename is the name of the - target file with the extension .licenses appended. - - - - - Generate the file component.exe.licenses file from component.licx. - - - - ]]> - - + + Generates a .licence file from a .licx file. + + + + If no output file is specified, the default filename is the name of the + target file with the extension .licenses appended. + + + + + Generate the file component.exe.licenses file from component.licx. + + + + ]]> + + @@ -1920,104 +1938,104 @@ The of which the should be updated. - - Generates the license file. - + + Generates the license file. + - - Determines whether the .licenses file needs to be recompiled - or is uptodate. - - The .licenses file. - - if the .licenses file needs compiling; - otherwise, . - + + Determines whether the .licenses file needs to be recompiled + or is uptodate. + + The .licenses file. + + if the .licenses file needs compiling; + otherwise, . + - - Input file to process. - + + Input file to process. + - - Name of the license file to output. - + + Name of the license file to output. + - - Names of the references to scan for the licensed component. - + + Names of the references to scan for the licensed component. + - - Specifies the executable for which the .licenses file is generated. - + + Specifies the executable for which the .licenses file is generated. + - - Specifies the executable for which the .licenses file is generated. - + + Specifies the executable for which the .licenses file is generated. + - - Indicates whether assembly references are supported by the current - target framework. The default is . - - - Applies only to frameworks having a command line tool for compiling - licenses files. - + + Indicates whether assembly references are supported by the current + target framework. The default is . + + + Applies only to frameworks having a command line tool for compiling + licenses files. + - - Indicates whether the current target framework has a command line - tool for compiling licenses files. The default is - . - + + Indicates whether the current target framework has a command line + tool for compiling licenses files. The default is + . + - - Gets the working directory for the application. - - - The working directory for the application. - + + Gets the working directory for the application. + + + The working directory for the application. + - - The command-line arguments for the external program. - - - Override to avoid exposing these elements in build file. - + + The command-line arguments for the external program. + + + Override to avoid exposing these elements in build file. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Gets the filename of the external program to start. - - - The filename of the external program. - - - Override in derived classes to explicitly set the location of the - external tool. - + + Gets the filename of the external program to start. + + + The filename of the external program. + + + Override in derived classes to explicitly set the location of the + external tool. + - - Responsible for reading the license and writing them to a license - file. - + + Responsible for reading the license and writing them to a license + file. + @@ -2039,15 +2057,15 @@ The .licenses file to create. - - Determines whether the given object is serializable in binary - format. - - The object to check. - - if is - serializable in binary format; otherwise, . - + + Determines whether the given object is serializable in binary + format. + + The object to check. + + if is + serializable in binary format; otherwise, . + @@ -2124,14 +2142,14 @@ - - Initializes the taks and verifies the parameters. - + + Initializes the taks and verifies the parameters. + - - Generates an NDoc project and builds the documentation. - + + Generates an NDoc project and builds the documentation. + @@ -2167,119 +2185,119 @@ for which expansion should be performed. - - Use Reflection to set HtmplHelp._htmlHelpCompiler private field for MSDN Documentor. - Ndoc could not handle 64bit installations and is not actively developed anymore. - - Active documentor - Path to hhc.exe + + Use Reflection to set HtmplHelp._htmlHelpCompiler private field for MSDN Documentor. + Ndoc could not handle 64bit installations and is not actively developed anymore. + + Active documentor + Path to hhc.exe - - Searches in %ProgramFiles(x86)%\HTML Help Workshop and %ProgramFiles%\HTML Help Workshop - for hhc.exe. If not found let ndoc msdn documentor search itself - - the path to hhc.exe if found, null otherwise + + Searches in %ProgramFiles(x86)%\HTML Help Workshop and %ProgramFiles%\HTML Help Workshop + for hhc.exe. If not found let ndoc msdn documentor search itself + + the path to hhc.exe if found, null otherwise - - The set of assemblies to document. - + + The set of assemblies to document. + - - The set of namespace summary files. - + + The set of namespace summary files. + - - Specifies the formats in which the documentation should be generated. - + + Specifies the formats in which the documentation should be generated. + - - Collection of additional directories to search for referenced - assemblies. - + + Collection of additional directories to search for referenced + assemblies. + - - Installs or removes .NET Services. - - - - This tasks provides the same functionality as the regsvcs tool - provided in the .NET SDK. - - - It performs the following actions: - - - - Loads and registers an assembly. - - - Generates, registers, and installs a type library into a specified COM+ application. - - - Configures services that are added programmatically to your class. - - - - Refer to the .NET Services Installation Tool (Regsvcs.exe) for more information. - - - - - Adds all public classes contained in myTest.dll to a COM+ - application and produces the myTest.tlb type library. If the - application already exists, it is overwritten. - - - - ]]> - - - - - Adds all public classes contained in myTest.dll to myTargetApp - and produces the myTest.tlb type library. If the application already - exists, it is overwritten. - - - - ]]> - - - - - Adds all public classes contained in myTest.dll to a COM+ - application and produces the myTest.tlb type library. A new - application is always created. - - - - ]]> - - - - - Uninstalls the COM+ application contained in myTest.dll. - - - - ]]> - - + + Installs or removes .NET Services. + + + + This tasks provides the same functionality as the regsvcs tool + provided in the .NET SDK. + + + It performs the following actions: + + + + Loads and registers an assembly. + + + Generates, registers, and installs a type library into a specified COM+ application. + + + Configures services that are added programmatically to your class. + + + + Refer to the .NET Services Installation Tool (Regsvcs.exe) for more information. + + + + + Adds all public classes contained in myTest.dll to a COM+ + application and produces the myTest.tlb type library. If the + application already exists, it is overwritten. + + + + ]]> + + + + + Adds all public classes contained in myTest.dll to myTargetApp + and produces the myTest.tlb type library. If the application already + exists, it is overwritten. + + + + ]]> + + + + + Adds all public classes contained in myTest.dll to a COM+ + application and produces the myTest.tlb type library. A new + application is always created. + + + + ]]> + + + + + Uninstalls the COM+ application contained in myTest.dll. + + + + ]]> + + - - Performs the specified action. - + + Performs the specified action. + @@ -2288,78 +2306,78 @@ - - The source assembly file. - - - The assembly must be signed with a strong name. - + + The source assembly file. + + + The assembly must be signed with a strong name. + - - Specifies the type library file to install. - + + Specifies the type library file to install. + - - Uses an existing type library. The default is . - + + Uses an existing type library. The default is . + - - Do not reconfigure an existing target application. - The default is . - + + Do not reconfigure an existing target application. + The default is . + - - Configures components only; ignores methods and interfaces. - The default is . - + + Configures components only; ignores methods and interfaces. + The default is . + - - Expect an existing application. The default is . - + + Expect an existing application. The default is . + - - Specifies the name of the COM+ application to either find or create. - + + Specifies the name of the COM+ application to either find or create. + - - Specifies the name or id of the COM+ application to either find or - create. - + + Specifies the name or id of the COM+ application to either find or + create. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Defines the possible actions for a .NET Service. - + + Defines the possible actions for a .NET Service. + - - Finds or creates the target application. - + + Finds or creates the target application. + - - Creates the target application. - + + Creates the target application. + - - Uninstalls the target application. - + + Uninstalls the target application. + @@ -2405,155 +2423,155 @@ The of which the should be updated. - - Converts a single file or group of files. - + + Converts a single file or group of files. + - - Cleans up generated files. - + + Cleans up generated files. + - - Determines whether the specified input file needs to be compiled. - - The input file. - The output file. - - if the input file need to be compiled; - otherwise . - + + Determines whether the specified input file needs to be compiled. + + The input file. + The output file. + + if the input file need to be compiled; + otherwise . + - - Determines the full path and extension for the output file. - - The output file for which the full path and extension should be determined. - - The full path (with extensions) for the specified file. - + + Determines the full path and extension for the output file. + + The output file for which the full path and extension should be determined. + + The full path (with extensions) for the specified file. + - - Determines whether the specified resource file references third - party assemblies by checking whether a <data> element exists - with a "type" attribute that does not start with - "System.". - - The resource file to check. - - if the resource file references third party - assemblies, or an error occurred; otherwise, . - - - This check will only be accurate for 1.0 resource file, but the - 2.0 resx files can only be compiled with a resgen tool that supports - assembly references, so this method will not be used anyway. - + + Determines whether the specified resource file references third + party assemblies by checking whether a <data> element exists + with a "type" attribute that does not start with + "System.". + + The resource file to check. + + if the resource file references third party + assemblies, or an error occurred; otherwise, . + + + This check will only be accurate for 1.0 resource file, but the + 2.0 resx files can only be compiled with a resgen tool that supports + assembly references, so this method will not be used anyway. + - - Returns a list of external file references for the specified file. - - The resx file for which a list of external file references should be returned. - - A list of external file references for the specified file, or - if does not - exist or does not support external file references. - + + Returns a list of external file references for the specified file. + + The resx file for which a list of external file references should be returned. + + A list of external file references for the specified file, or + if does not + exist or does not support external file references. + - - Input file to process. - - - The full path to the input file. - + + Input file to process. + + + The full path to the input file. + - - The resource file to output. - + + The resource file to output. + - - The target type. The default is resources. - + + The target type. The default is resources. + - - The directory to which outputs will be stored. - + + The directory to which outputs will be stored. + - - Use each source file's directory as the current directory for - resolving relative file paths. The default is . - Only supported when targeting .NET 2.0 (or higher). - + + Use each source file's directory as the current directory for + resolving relative file paths. The default is . + Only supported when targeting .NET 2.0 (or higher). + - - Takes a list of .resx or .txt files to convert to .resources files. - + + Takes a list of .resx or .txt files to convert to .resources files. + - - Reference metadata from the specified assembly files. - + + Reference metadata from the specified assembly files. + - - Indicates whether assembly references are supported by the - resgen tool for the current target framework. The default - is . - + + Indicates whether assembly references are supported by the + resgen tool for the current target framework. The default + is . + - - Indicates whether external file references are supported by the - resgen tool for the current target framework. The default - is . - + + Indicates whether external file references are supported by the + resgen tool for the current target framework. The default + is . + - - For internal use only ! - + + For internal use only ! + - - Gets the working directory for the application. - - - The working directory for the application. - + + Gets the working directory for the application. + + + The working directory for the application. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Gets the filename of the external program to start. - - - The filename of the external program. - - - Override in derived classes to explicitly set the location of the - external tool. - + + Gets the filename of the external program to start. + + + The filename of the external program. + + + Override in derived classes to explicitly set the location of the + external tool. + - - For internal use only ! - + + For internal use only ! + @@ -2564,254 +2582,261 @@ The compiled resource. - - Gets the resource file to compile. - - - The resource file to compile. - + + Gets the resource file to compile. + + + The resource file to compile. + - - Gets the compiled resource file. - - - The compiled resource file. - - - - Executes the code contained within the task. + Gets the compiled resource file. - -
Code
- - The must contain a single code - element, which in turn contains the script code. - - - This code can include extensions such as functions, or tasks. Once - the script task has executed those extensions will be available for - use in the buildfile. - - - If no extensions have been defined, a static entry point named - ScriptMain - which must have a single - argument - is required. - -
Namespaces
- - The following namespaces are imported by default: - - - - System - - - System.Collections - - - System.IO - - - System.Text - - - NAnt.Core - - - NAnt.Core.Attributes - - -
Assembly References
- - The assembly references that are specified will be used to compile - the script, and will be loaded into the NAnt appdomain. - - - By default, only the NAnt.Core and mscorlib assemblies - are referenced. - - - - Run C# code that writes a message to the build log. - - <script language="C#"> - <code> - <![CDATA[ - public static void ScriptMain(Project project) { - project.Log(Level.Info, "Hello World from a script task using C#"); - } - ]]> - </code> - </script> - - - - Define a custom function and call it using C#. - - <script language="C#" prefix="test" > - <code> - <![CDATA[ - [Function("test-func")] - public static string Testfunc( ) { - return "some result !!!!!!!!"; - } - ]]> - </code> - </script> - <echo message='${test::test-func()}'/> - - - - Use a custom namespace in C# to create a database - - <script language="C#" > - <references> - <include name="System.Data.dll" /> - </references> - <imports> - <import namespace="System.Data.SqlClient" /> - </imports> - <code> - <![CDATA[ - public static void ScriptMain(Project project) { - string dbUserName = "nant"; - string dbPassword = "nant"; - string dbServer = "(local)"; - string dbDatabaseName = "NAntSample"; - string connectionString = String.Format("Server={0};uid={1};pwd={2};", dbServer, dbUserName, dbPassword); - - SqlConnection connection = new SqlConnection(connectionString); - string createDbQuery = "CREATE DATABASE " + dbDatabaseName; - SqlCommand createDatabaseCommand = new SqlCommand(createDbQuery); - createDatabaseCommand.Connection = connection; - - connection.Open(); - - try { - createDatabaseCommand.ExecuteNonQuery(); - project.Log(Level.Info, "Database added successfully: " + dbDatabaseName); - } catch (Exception e) { - project.Log(Level.Error, e.ToString()); - } finally { - connection.Close(); - } - } - ]]> - </code> - </script> - - - - - Run Visual Basic.NET code that writes a message to the build log. - - - <script language="VB"> - <code> - <![CDATA[ - Public Shared Sub ScriptMain(project As Project) - project.Log(Level.Info, "Hello World from a script task using Visual Basic.NET") - End Sub - ]]> - </code> - </script> - - - - Define a custom task and call it using C#. - - <script language="C#" prefix="test" > - <code> - <![CDATA[ - [TaskName("usertask")] - public class TestTask : Task { - #region Private Instance Fields - private string _message; - #endregion Private Instance Fields - #region Public Instance Properties - [TaskAttribute("message", Required=true)] - public string FileName { - get { return _message; } - set { _message = value; } - } - #endregion Public Instance Properties - #region Override implementation of Task - protected override void ExecuteTask() { - Log(Level.Info, _message.ToUpper()); - } - #endregion Override implementation of Task - } - ]]> - </code> - </script> - <usertask message='Hello from UserTask'/> - - - - - Define a custom function and call it using Boo. - - - <script language="Boo.CodeDom.BooCodeProvider, Boo.CodeDom, Version=1.0.0.0, Culture=neutral, PublicKeyToken=32c39770e9a21a67" - failonerror="true"> - <code> - <![CDATA[ - - [Function("test-func")] - def MyFunc(): - return "Hello from Boo !!!!!!" - ]]> - </code> - </script> - <echo message='${script::test-func()}'/> - - + + The compiled resource file. + + + + + Executes the code contained within the task. + + +
Code
+ + The must contain a single code + element, which in turn contains the script code. + + + This code can include extensions such as functions, or tasks. Once + the script task has executed those extensions will be available for + use in the buildfile. + + + If no extensions have been defined, a static entry point named + ScriptMain - which must have a single + argument - is required. + +
Namespaces
+ + The following namespaces are imported by default: + + + + System + + + System.Collections + + + System.IO + + + System.Text + + + NAnt.Core + + + NAnt.Core.Attributes + + +
Assembly References
+ + The assembly references that are specified will be used to compile + the script, and will be loaded into the NAnt appdomain. + + + By default, only the NAnt.Core and mscorlib assemblies + are referenced. + + + + Run C# code that writes a message to the build log. + + <script language="C#"> + <code> + <![CDATA[ + public static void ScriptMain(Project project) { + project.Log(Level.Info, "Hello World from a script task using C#"); + } + ]]> + </code> + </script> + + + + Define a custom function and call it using C#. + + <script language="C#" prefix="test" > + <code> + <![CDATA[ + [Function("test-func")] + public static string Testfunc( ) { + return "some result !!!!!!!!"; + } + ]]> + </code> + </script> + <echo message='${test::test-func()}'/> + + + + Use a custom namespace in C# to create a database + + <script language="C#" > + <references> + <include name="System.Data.dll" /> + </references> + <imports> + <import namespace="System.Data.SqlClient" /> + </imports> + <code> + <![CDATA[ + public static void ScriptMain(Project project) { + string dbUserName = "nant"; + string dbPassword = "nant"; + string dbServer = "(local)"; + string dbDatabaseName = "NAntSample"; + string connectionString = String.Format("Server={0};uid={1};pwd={2};", dbServer, dbUserName, dbPassword); + + SqlConnection connection = new SqlConnection(connectionString); + string createDbQuery = "CREATE DATABASE " + dbDatabaseName; + SqlCommand createDatabaseCommand = new SqlCommand(createDbQuery); + createDatabaseCommand.Connection = connection; + + connection.Open(); + + try { + createDatabaseCommand.ExecuteNonQuery(); + project.Log(Level.Info, "Database added successfully: " + dbDatabaseName); + } catch (Exception e) { + project.Log(Level.Error, e.ToString()); + } finally { + connection.Close(); + } + } + ]]> + </code> + </script> + + + + + Run Visual Basic.NET code that writes a message to the build log. + + + <script language="VB"> + <code> + <![CDATA[ + Public Shared Sub ScriptMain(project As Project) + project.Log(Level.Info, "Hello World from a script task using Visual Basic.NET") + End Sub + ]]> + </code> + </script> + + + + Define a custom task and call it using C#. + + <script language="C#" prefix="test" > + <code> + <![CDATA[ + [TaskName("usertask")] + public class TestTask : Task { + #region Private Instance Fields + + private string _message; + + #endregion Private Instance Fields + + #region Public Instance Properties + + [TaskAttribute("message", Required=true)] + public string FileName { + get { return _message; } + set { _message = value; } + } + + #endregion Public Instance Properties + + #region Override implementation of Task + + protected override void ExecuteTask() { + Log(Level.Info, _message.ToUpper()); + } + #endregion Override implementation of Task + } + ]]> + </code> + </script> + <usertask message='Hello from UserTask'/> + + + + + Define a custom function and call it using Boo. + + + <script language="Boo.CodeDom.BooCodeProvider, Boo.CodeDom, Version=1.0.0.0, Culture=neutral, PublicKeyToken=32c39770e9a21a67" + failonerror="true"> + <code> + <![CDATA[ + + [Function("test-func")] + def MyFunc(): + return "Hello from Boo !!!!!!" + ]]> + </code> + </script> + <echo message='${script::test-func()}'/> + + - - Initializes the task. - + + Initializes the task. + - - Executes the script block. - + + Executes the script block. + - - The language of the script block. Possible values are "VB", "vb", "VISUALBASIC", "C#", "c#", "CSHARP". - "JS", "js", "JSCRIPT" "VJS", "vjs", "JSHARP" or a fully-qualified name for a class implementing - . - + + The language of the script block. Possible values are "VB", "vb", "VISUALBASIC", "C#", "c#", "CSHARP". + "JS", "js", "JSCRIPT" "VJS", "vjs", "JSHARP" or a fully-qualified name for a class implementing + . + - - Any required references. - + + Any required references. + - - The name of the main class containing the static ScriptMain - entry point. - + + The name of the main class containing the static ScriptMain + entry point. + - - The namespace prefix for any custom functions defined in the script. - If ommitted the prefix will default to 'script' - + + The namespace prefix for any custom functions defined in the script. + If ommitted the prefix will default to 'script' + - - The namespaces to import. - + + The namespaces to import. + - - The code to execute. - + + The code to execute. + @@ -2888,28 +2913,28 @@ to which the compiler options should be written. - - Determines whether compilation is needed. - + + Determines whether compilation is needed. + - - The preferred base address at which to load a DLL. The default base - address for a DLL is set by the .NET Framework common language - runtime. - - - The preferred base address at which to load a DLL. - - - This address must be specified as a hexadecimal number. - + + The preferred base address at which to load a DLL. The default base + address for a DLL is set by the .NET Framework common language + runtime. + + + The preferred base address at which to load a DLL. + + + This address must be specified as a hexadecimal number. + - - Specifies the type of debugging information generated by the - compiler. The default is . - + + Specifies the type of debugging information generated by the + compiler. The default is . + @@ -2918,179 +2943,179 @@ - - The name of the XML documentation file to generate. Only supported - when targeting .NET 2.0 (or higher). - - - - Corresponds with the /doc: flag. - - + + The name of the XML documentation file to generate. Only supported + when targeting .NET 2.0 (or higher). + + + + Corresponds with the /doc: flag. + + - - Specifies whether the /imports option gets passed to the - compiler. - - - The value of this attribute is a string that contains one or more - namespaces separated by commas. - - - See the Microsoft.NET Framework SDK documentation for details. - - Example of an imports attribute - - + + Specifies whether the /imports option gets passed to the + compiler. + + + The value of this attribute is a string that contains one or more + namespaces separated by commas. + + + See the Microsoft.NET Framework SDK documentation for details. + + Example of an imports attribute + + - - The namespaces to import. - + + The namespaces to import. + - - Instructs the compiler not to reference standard libraries - (system.dll and VBC.RSP). The default is . - Only supported when targeting .NET 2.0 (or higher). - - - - Corresponds with the /nostdlib flag. - - + + Instructs the compiler not to reference standard libraries + (system.dll and VBC.RSP). The default is . + Only supported when targeting .NET 2.0 (or higher). + + + + Corresponds with the /nostdlib flag. + + - - Specifies whether /optioncompare option gets passed to the - compiler. - - - text, binary, or an empty string. If the value is - or an empty string, the option will not be - passed to the compiler. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether /optioncompare option gets passed to the + compiler. + + + text, binary, or an empty string. If the value is + or an empty string, the option will not be + passed to the compiler. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the /optionexplicit option gets passed to - the compiler. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /optionexplicit option gets passed to + the compiler. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the /optimize option gets passed to the - compiler. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /optimize option gets passed to the + compiler. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the /optionstrict option gets passed to - the compiler. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /optionstrict option gets passed to + the compiler. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies which platform version of common language runtime (CLR) - can run the output file. - - - The platform version of common language runtime (CLR) that can run - the output file. - - - - Corresponds with the /platform flag. - - + + Specifies which platform version of common language runtime (CLR) + can run the output file. + + + The platform version of common language runtime (CLR) that can run + the output file. + + + + Corresponds with the /platform flag. + + - - Specifies whether the /removeintchecks option gets passed to - the compiler. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /removeintchecks option gets passed to + the compiler. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the /rootnamespace option gets passed to - the compiler. - - - The value of this attribute is a string that contains the root - namespace of the project. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /rootnamespace option gets passed to + the compiler. + + + The value of this attribute is a string that contains the root + namespace of the project. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the compiler for the active target framework - supports generation of XML Documentation file. The default is - . - + + Specifies whether the compiler for the active target framework + supports generation of XML Documentation file. The default is + . + - - Specifies whether the compiler for the active target framework - supports NOT referencing standard libraries (system.dll and VBC.RSP). - The default is . - + + Specifies whether the compiler for the active target framework + supports NOT referencing standard libraries (system.dll and VBC.RSP). + The default is . + - - Specifies whether the compiler for the active target framework - supports limiting the platform on which the compiled code can run. - The default is . - + + Specifies whether the compiler for the active target framework + supports limiting the platform on which the compiled code can run. + The default is . + - - Gets the file extension required by the current compiler. - - - For the VB.NET compiler, the file extension is always vb. - + + Gets the file extension required by the current compiler. + + + For the VB.NET compiler, the file extension is always vb. + - - Gets the class name regular expression for the language of the - current compiler. - - - Class name regular expression for the language of the current - compiler. - + + Gets the class name regular expression for the language of the + current compiler. + + + Class name regular expression for the language of the current + compiler. + - - Gets the namespace regular expression for the language of the - current compiler. - - - Namespace regular expression for the language of the current - compiler. - + + Gets the namespace regular expression for the language of the + current compiler. + + + Namespace regular expression for the language of the current + compiler. + @@ -3142,24 +3167,24 @@ to which the compiler options should be written. - - The preferred base address at which to load a DLL. The default base - address for a DLL is set by the .NET Framework common language - runtime. - - - The preferred base address at which to load a DLL. - - - This address can be specified as a decimal, hexadecimal, or octal - number. - + + The preferred base address at which to load a DLL. The default base + address for a DLL is set by the .NET Framework common language + runtime. + + + The preferred base address at which to load a DLL. + + + This address can be specified as a decimal, hexadecimal, or octal + number. + - - Specifies the type of debugging information generated by the - compiler. The default is . - + + Specifies the type of debugging information generated by the + compiler. The default is . + @@ -3168,185 +3193,185 @@ - - Specifies whether package-scoped members are accessible outside of - the assembly. In other words, package scope is treated as assembly - scope when emitting metadata. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - - - Corresponds to the /securescoping flag. - - - See the Visual J# Reference for details. - - - - ]]> - + + Specifies whether package-scoped members are accessible outside of + the assembly. In other words, package scope is treated as assembly + scope when emitting metadata. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + + + Corresponds to the /securescoping flag. + + + See the Visual J# Reference for details. + + + + ]]> + - - Specifies whether to disable language extensions. - - - The value of this property must be either all, net, - or an empty string. - - - - Corresponds to the /x flag. - - - See the Visual J# Reference for details. - - - - To disable only the .NET Framework extensions: - ]]> - To disable the .NET Framework extensions and the VJ++ 6.0 extensions: - ]]> - + + Specifies whether to disable language extensions. + + + The value of this property must be either all, net, + or an empty string. + + + + Corresponds to the /x flag. + + + See the Visual J# Reference for details. + + + + To disable only the .NET Framework extensions: + ]]> + To disable the .NET Framework extensions and the VJ++ 6.0 extensions: + ]]> + - - Specifies the location of assemblies referenced by way of the /reference flag. - - - - Corresponds to the /libpath:dir[;dir2] flag. - - - See the Visual J# Reference for details. - - + + Specifies the location of assemblies referenced by way of the /reference flag. + + + + Corresponds to the /libpath:dir[;dir2] flag. + + + See the Visual J# Reference for details. + + - - Associate Java-language/COM package names. - - - The value of this propery. must be package=namespace, @filename, - or an empty string. - - - - Corresponds to the /jcpa:package=namespace and /jcpa:@filename flags. - - - See the Visual J# Reference for details. - - - - Map package 'x' to namespace 'y': - ]]> - + + Associate Java-language/COM package names. + + + The value of this propery. must be package=namespace, @filename, + or an empty string. + + + + Corresponds to the /jcpa:package=namespace and /jcpa:@filename flags. + + + See the Visual J# Reference for details. + + + + Map package 'x' to namespace 'y': + ]]> + - - Specifies the code page to use for all source code files in the - compilation. - - - - Corresponds with the /codepage flag. - - - See the Visual J# Reference for details. - - + + Specifies the code page to use for all source code files in the + compilation. + + + + Corresponds with the /codepage flag. + + + See the Visual J# Reference for details. + + - - Specifies the warning level for the compiler to display. Valid values - are 0-4. The default is 4. - - - The warning level for the compiler to display. - - - - Corresponds with the /warn option. - - + + Specifies the warning level for the compiler to display. Valid values + are 0-4. The default is 4. + + + The warning level for the compiler to display. + + + + Corresponds with the /warn option. + + - - Controls which warnings should be reported as errors. - - - Override to avoid exposing this to build authors, as the Visual J# - compiler does not allow control over which warnings should be - reported as errors. - + + Controls which warnings should be reported as errors. + + + Override to avoid exposing this to build authors, as the Visual J# + compiler does not allow control over which warnings should be + reported as errors. + - - Reference packages - - - Override to avoid exposing this to build authors, as the Visual J# - compiler does not support package references. - + + Reference packages + + + Override to avoid exposing this to build authors, as the Visual J# + compiler does not support package references. + - - Link the specified modules into this assembly. - - - Override to avoid exposing this to build authors, as the Visual J# - compiler does not support linking modules. - + + Link the specified modules into this assembly. + + + Override to avoid exposing this to build authors, as the Visual J# + compiler does not support linking modules. + - - Gets the file extension required by the current compiler. - - - For the J# compiler, the file extension is always jsl. - + + Gets the file extension required by the current compiler. + + + For the J# compiler, the file extension is always jsl. + - - Gets the class name regular expression for the language of the - current compiler. - - - Class name regular expression for the language of the current - compiler. - + + Gets the class name regular expression for the language of the + current compiler. + + + Class name regular expression for the language of the current + compiler. + - - Gets the namespace regular expression for the language of the - current compiler. - - - Namespace regular expression for the language of the current - compiler. - + + Gets the namespace regular expression for the language of the + current compiler. + + + Namespace regular expression for the language of the current + compiler. + - - Override to avoid exposing the configuration setting for this - task as Visual J# will never support package references. - - - , as the Visual J# compiler will never - support package references. - + + Override to avoid exposing the configuration setting for this + task as Visual J# will never support package references. + + + , as the Visual J# compiler will never + support package references. + - - Represents an assembly-level attribute. - + + Represents an assembly-level attribute. + @@ -3355,43 +3380,43 @@ - - Typename of the assembly-level attribute. - + + Typename of the assembly-level attribute. + - - Value of the attribute. - + + Value of the attribute. + - - If then the value of the attribute will be - set as is, without actually looking for a matching constructor or - named properties. The default is . - - - if the value of the attribute should be set - as is; otherwise, . - + + If then the value of the attribute will be + set as is, without actually looking for a matching constructor or + named properties. The default is . + + + if the value of the attribute should be set + as is; otherwise, . + - - Indicates if the attribute should be generated. - - - if the attribute should be generated; - otherwise, . - + + Indicates if the attribute should be generated. + + + if the attribute should be generated; + otherwise, . + - - Indicates if the attribute should be not generated. - - - if the attribute should be not generated; - otherwise, . - + + Indicates if the attribute should be not generated. + + + if the attribute should be not generated; + otherwise, . + @@ -3458,11 +3483,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -3495,10 +3520,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -3519,28 +3544,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -3559,11 +3584,11 @@ - - override this. We will always use the base directory of the parent. - overriding without the TaskAttribute attribute prevents it being set - in the source xml - + + override this. We will always use the base directory of the parent. + overriding without the TaskAttribute attribute prevents it being set + in the source xml + @@ -3657,17 +3682,17 @@ - - copy constructor for FileSet. Required in order to - assign references of FileSet type where - AssemblyFileSets are used - - + + copy constructor for FileSet. Required in order to + assign references of FileSet type where + AssemblyFileSets are used + + - - Do a normal scan and then resolve assemblies. - + + Do a normal scan and then resolve assemblies. + @@ -3676,37 +3701,37 @@ - - Additional directories to search in for assembly references. - - - - loosely Corresponds with the /lib[path]: flag of the various compiler tasks. - - + + Additional directories to search in for assembly references. + + + + loosely Corresponds with the /lib[path]: flag of the various compiler tasks. + + - - Represents a compiler warning. - + + Represents a compiler warning. + - - A warning number, or comma-separated list of warnings, that you want - the compiler to suppress or report. - + + A warning number, or comma-separated list of warnings, that you want + the compiler to suppress or report. + - - If then the element will be processed; - otherwise, skipped. The default is . - + + If then the element will be processed; + otherwise, skipped. The default is . + - - If then the element will be skipped; - otherwise, processed. The default is . - + + If then the element will be skipped; + otherwise, processed. The default is . + @@ -3760,11 +3785,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -3797,10 +3822,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -3815,28 +3840,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -3876,25 +3901,25 @@ - - Create no debug information. - + + Create no debug information. + - - Enable attaching a debugger to the running program. - + + Enable attaching a debugger to the running program. + - - Enable attaching a debugger to the running program. - + + Enable attaching a debugger to the running program. + - - Only display assembler when the running program is attached to the - debugger. - + + Only display assembler when the running program is attached to the + debugger. + @@ -3949,20 +3974,20 @@ - - Not specified. - + + Not specified. + - - Fully sign the assembly. - + + Fully sign the assembly. + - - Only place the public key in the assembly, allowing the signature - to be added later. - + + Only place the public key in the assembly, allowing the signature + to be added later. + @@ -3991,12 +4016,12 @@ - - Represents an embedded resource. - - - Do not yet expose this to build authors. - + + Represents an embedded resource. + + + Do not yet expose this to build authors. + @@ -4007,20 +4032,20 @@ The manifest resource name of the embedded resource. - - Gets the physical location of the resource to embed. - - - The physical location of the resource to embed. - + + Gets the physical location of the resource to embed. + + + The physical location of the resource to embed. + - - Gets the manifest resource name to use when embedding the resource. - - - The manifest resource name to use when embedding the resource. - + + Gets the manifest resource name to use when embedding the resource. + + + The manifest resource name to use when embedding the resource. + @@ -4031,9 +4056,9 @@ - - Base class for collections that needs to be globally referencable. - + + Base class for collections that needs to be globally referencable. + @@ -4059,15 +4084,15 @@ - - Removes an item at a specific index. - - The zero-based index of the item to remove. + + Removes an item at a specific index. + + The zero-based index of the item to remove. - - Removes all items from the collection. - + + Removes all items from the collection. + @@ -4077,53 +4102,53 @@ The instance to verify. - - Checks whether the specified index is within the range of this - collection. - - The index to check. + + Checks whether the specified index is within the range of this + collection. + + The index to check. - - Gets a value indicating whether access to the collection is - synchronized (thread-safe). - - - . - + + Gets a value indicating whether access to the collection is + synchronized (thread-safe). + + + . + - - Gets the number of items in the collection. - - - The number of items in the collection. - + + Gets the number of items in the collection. + + + The number of items in the collection. + - - Gets an object that can be used to synchronize access to the - collection. - - - An object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the + collection. + + + An object that can be used to synchronize access to the collection. + - - Gets a value indicating whether the collection has a fixed size. - - - . - + + Gets a value indicating whether the collection has a fixed size. + + + . + - - Gets a value indicating whether the collection has a fixed size. - - - . - + + Gets a value indicating whether the collection has a fixed size. + + + . + @@ -4254,10 +4279,10 @@ - - Gets or sets the item at the specified index. - - The zero-based index of the item to get or set. + + Gets or sets the item at the specified index. + + The zero-based index of the item to get or set. @@ -4274,11 +4299,11 @@ The of the items in this collection. - - - Gets or sets the item at the specified index. - - The zero-based index of the item to get or set. + + + Gets or sets the item at the specified index. + + The zero-based index of the item to get or set. @@ -4293,61 +4318,61 @@ The collection that should be enumerated. - - Advances the enumerator to the next item of the collection. - - - if the enumerator was successfully advanced - to the next item; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next item of the collection. + + + if the enumerator was successfully advanced + to the next item; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first item in the collection. - + + Sets the enumerator to its initial position, which is before the + first item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Represents a metadata file without assembly manifest. - + + Represents a metadata file without assembly manifest. + - - Returns a textual representation of the module, which can be used as - argument for command-line tools. - - - A textual representation of the path, file[,target]. - + + Returns a textual representation of the module, which can be used as + argument for command-line tools. + + + A textual representation of the path, file[,target]. + - - The path of the module. - + + The path of the module. + - - File name where the module should be copied to before it is compiled - into an assembly. - + + File name where the module should be copied to before it is compiled + into an assembly. + @@ -4387,9 +4412,9 @@ The zero-based index in at which copying begins. - - Removes all items from the collection. - + + Removes all items from the collection. + @@ -4526,48 +4551,48 @@ - - Gets a value indicating whether access to the collection is - synchronized (thread-safe). - - - . - + + Gets a value indicating whether access to the collection is + synchronized (thread-safe). + + + . + - - Gets the number of items in the collection. - - - The number of items in the collection. - + + Gets the number of items in the collection. + + + The number of items in the collection. + - - Gets an object that can be used to synchronize access to the - collection. - - - An object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the + collection. + + + An object that can be used to synchronize access to the collection. + - - Gets a value indicating whether the collection has a fixed size. - - - . - + + Gets a value indicating whether the collection has a fixed size. + + + . + - - Gets a value indicating whether the collection has a fixed size. - - - . - + + Gets a value indicating whether the collection has a fixed size. + + + . + - + Gets or sets the item at the specified index. @@ -4587,57 +4612,57 @@ The collection that should be enumerated. - - Advances the enumerator to the next item of the collection. - - - if the enumerator was successfully advanced - to the next item; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next item of the collection. + + + if the enumerator was successfully advanced + to the next item; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first item in the collection. - + + Sets the enumerator to its initial position, which is before the + first item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - - One or more modules to compile into an assembly. - - - - - Define a global <moduleset> that can be referenced by - other tasks or types. - - - - - - - ]]> - - + + + One or more modules to compile into an assembly. + + + + + Define a global <moduleset> that can be referenced by + other tasks or types. + + + + + + + ]]> + + @@ -4656,9 +4681,9 @@ - - Represents a namespace to import. - + + Represents a namespace to import. + @@ -4675,38 +4700,38 @@ is . - - The name of the namespace to import. - - - The name of the namespace to import. - + + The name of the namespace to import. + + + The name of the namespace to import. + - - The name of the namespace to import. - - - The name of the namespace to import. - + + The name of the namespace to import. + + + The name of the namespace to import. + - - Indicates if the import should be generated. - - - if the import should be generated; otherwise, - . - + + Indicates if the import should be generated. + + + if the import should be generated; otherwise, + . + - - Indicates if the import should be not generated. - - - if the import should be not generated; - otherwise, . - + + Indicates if the import should be not generated. + + + if the import should be not generated; + otherwise, . + @@ -4862,10 +4887,10 @@ - - Gets or sets the item at the specified index. - - The zero-based index of the item to get or set. + + Gets or sets the item at the specified index. + + The zero-based index of the item to get or set. @@ -4881,11 +4906,11 @@ The of the items in this collection. - - - Gets or sets the item at the specified index. - - The zero-based index of the item to get or set. + + + Gets or sets the item at the specified index. + + The zero-based index of the item to get or set. @@ -4900,62 +4925,62 @@ The collection that should be enumerated. - - Advances the enumerator to the next item of the collection. - - - if the enumerator was successfully advanced - to the next item; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next item of the collection. + + + if the enumerator was successfully advanced + to the next item; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first item in the collection. - + + Sets the enumerator to its initial position, which is before the + first item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Represents a package. - + + Represents a package. + - - Name of the package to reference. Multiple package can be specified - with a single element as a semi-colon separated list of - package names. - + + Name of the package to reference. Multiple package can be specified + with a single element as a semi-colon separated list of + package names. + - - Indicates if the package should be passed to the task. - If then the package will be passed; - otherwise, skipped. The default is . - + + Indicates if the package should be passed to the task. + If then the package will be passed; + otherwise, skipped. The default is . + - - Indicates if the package should not be passed to the task. - If then the package will be passed; - otherwise, skipped. The default is . - + + Indicates if the package should not be passed to the task. + If then the package will be passed; + otherwise, skipped. The default is . + @@ -5010,11 +5035,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -5047,10 +5072,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -5065,28 +5090,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -5099,12 +5124,12 @@ - - copy constructor for FileSet. Required in order to - assign references of FileSet type where - ResourceFileSet are used - - + + copy constructor for FileSet. Required in order to + assign references of FileSet type where + ResourceFileSet are used + + @@ -5115,41 +5140,41 @@ - - Gets the manifest resource name for the specified resource file. - - The physical path of the resource file. - - The manifest resource name to be sent to the compiler. - + + Gets the manifest resource name for the specified resource file. + + The physical path of the resource file. + + The manifest resource name to be sent to the compiler. + - - Gets the manifest resource name for the file using both its physical - and logical path. - - The physical path of the resource file. - The logical location of the resource file. - - The manifest resource name to be sent to the compiler. - - - We use the relative path of the logical path, but the filename and - and the extension of the physical path to match VS.NET - + + Gets the manifest resource name for the file using both its physical + and logical path. + + The physical path of the resource file. + The logical location of the resource file. + + The manifest resource name to be sent to the compiler. + + + We use the relative path of the logical path, but the filename and + and the extension of the physical path to match VS.NET + - - Indicates the prefix to prepend to the actual resource. - This is usually the default namspace of the assembly. - + + Indicates the prefix to prepend to the actual resource. + This is usually the default namspace of the assembly. + - - Indicates whether prefixes should be dynamically generated by taking - the path of the resource relative to the basedir and appending it - to the specified prefix. The default is . - + + Indicates whether prefixes should be dynamically generated by taking + the path of the resource relative to the basedir and appending it + to the specified prefix. The default is . + @@ -5220,11 +5245,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -5257,10 +5282,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -5275,59 +5300,59 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Controls the behaviour of a compiler with regards to the reporting of - warnings. - - - - Instruct a compiler to report warning 0519 as an error. - - - - - - ]]> - - - - - Instruct a compiler not to report warning 0519 as an error, if the - release property is . - - - - - - ]]> - - + + Controls the behaviour of a compiler with regards to the reporting of + warnings. + + + + Instruct a compiler to report warning 0519 as an error. + + + + + + ]]> + + + + + Instruct a compiler not to report warning 0519 as an error, if the + release property is . + + + + + + ]]> + + diff --git a/Tools/nant/bin/NAnt.MSNetTasks.dll b/Tools/nant/bin/NAnt.MSNetTasks.dll index 4c6e165..3099966 100755 Binary files a/Tools/nant/bin/NAnt.MSNetTasks.dll and b/Tools/nant/bin/NAnt.MSNetTasks.dll differ diff --git a/Tools/nant/bin/NAnt.MSNetTasks.xml b/Tools/nant/bin/NAnt.MSNetTasks.xml index 51409dc..8327211 100755 --- a/Tools/nant/bin/NAnt.MSNetTasks.xml +++ b/Tools/nant/bin/NAnt.MSNetTasks.xml @@ -50,20 +50,20 @@ - - Checks whether the task is initialized with valid attributes. - + + Checks whether the task is initialized with valid attributes. + - - Disassembles the PE file(s). - + + Disassembles the PE file(s). + - - Disassembles the specified PE file. - - The PE file to disassemble. + + Disassembles the specified PE file. + + The PE file to disassemble. @@ -80,9 +80,9 @@ The path of the output file could not be determined. - - Writes the disassembler options. - + + Writes the disassembler options. + @@ -115,76 +115,76 @@ - - Determines whether or not disassembling is needed. - - - if disassembling is needed; otherwise, - . - + + Determines whether or not disassembling is needed. + + + if disassembling is needed; otherwise, + . + - - Specifies whether or not the disassembler should combine the - /HEADER, /BYTE, and /TOKENS options. The default - is . - - - if the disassembler should combine the - /HEADER, /BYTE, and /TOKENS options; - otherwise, . The default is - . - - - - Corresponds to the /ALL flag. - - + + Specifies whether or not the disassembler should combine the + /HEADER, /BYTE, and /TOKENS options. The default + is . + + + if the disassembler should combine the + /HEADER, /BYTE, and /TOKENS options; + otherwise, . The default is + . + + + + Corresponds to the /ALL flag. + + - - Specifies whether or not the disassembler should generate the - IL stream bytes (in hexadecimal notation) as instruction comments. - The default is . - - - if the IL stream bytes should be generated - as instruction comments; otherwise, . The - default is . - - - - Corresponds to the /BYTE flag. - - + + Specifies whether or not the disassembler should generate the + IL stream bytes (in hexadecimal notation) as instruction comments. + The default is . + + + if the IL stream bytes should be generated + as instruction comments; otherwise, . The + default is . + + + + Corresponds to the /BYTE flag. + + - - Instructs NAnt to rebuild the output file regardless of the file - timestamps. The default is . - - - if the output file should be rebuilt - regardless of its timestamps; otherwise . - The default is . - + + Instructs NAnt to rebuild the output file regardless of the file + timestamps. The default is . + + + if the output file should be rebuilt + regardless of its timestamps; otherwise . + The default is . + - - Specifies whether or not the disassembler should include PE header - information and runtime header information in the output. The default - is . - - - if PE header information and runtime header - information should be included in the output; otherwise, - . The default is . - - - - Corresponds to the /HEADER flag. - - + + Specifies whether or not the disassembler should include PE header + information and runtime header information in the output. The default + is . + + + if PE header information and runtime header + information should be included in the output; otherwise, + . The default is . + + + + Corresponds to the /HEADER flag. + + @@ -196,36 +196,36 @@ - - Specifies whether or not the disassembler should include - references to original source lines. The default is . - - - if references to original source lines - should be included; otherwise, . The - default is . - - - - Corresponds to the /LINENUM flag. - - + + Specifies whether or not the disassembler should include + references to original source lines. The default is . + + + if references to original source lines + should be included; otherwise, . The + default is . + + + + Corresponds to the /LINENUM flag. + + - - Specifies whether or not the disassembler should suppress ILASM - code output. The default is . - - - if ILASM code output should be suppresses; - otherwise, . The default is - . - - - - Corresponds to the /NOIL flag. - - + + Specifies whether or not the disassembler should suppress ILASM + code output. The default is . + + + if ILASM code output should be suppresses; + otherwise, . The default is + . + + + + Corresponds to the /NOIL flag. + + @@ -245,103 +245,103 @@ - - Specifies whether or not the disassembler should enclose all names - in single quotation marks. By default, only names that don't match - the ILASM definition of a simple name are quoted. The default is - . - - - if all names should be enclosed in single - quotation marks; otherwise, . The default - is . - - - - Corresponds to the /QUOTEALLNAMES flag. - - + + Specifies whether or not the disassembler should enclose all names + in single quotation marks. By default, only names that don't match + the ILASM definition of a simple name are quoted. The default is + . + + + if all names should be enclosed in single + quotation marks; otherwise, . The default + is . + + + + Corresponds to the /QUOTEALLNAMES flag. + + - - Specifies whether or not the disassembler should generate - structured exception handling clauses in canonical (label) form. - The default is . - - - if structured exception handling clauses - should be generated in canonical form; otherwise, - . The default is . - - - - Corresponds to the /RAWEH flag. - - + + Specifies whether or not the disassembler should generate + structured exception handling clauses in canonical (label) form. + The default is . + + + if structured exception handling clauses + should be generated in canonical form; otherwise, + . The default is . + + + + Corresponds to the /RAWEH flag. + + - - Specifies whether or not the disassembler should generate - original source lines as comments. The default is . - - - if original source lines should be - generated as comments; otherwise, . - The default is . - - - - Corresponds to the /SOURCE flag. - - + + Specifies whether or not the disassembler should generate + original source lines as comments. The default is . + + + if original source lines should be + generated as comments; otherwise, . + The default is . + + + + Corresponds to the /SOURCE flag. + + - - Specifies whether or not the disassembler should generate metadata - token values as comments. The default is . - - - if metadata token values should be - generated as comments; otherwise, . The - default is . - - - - Corresponds to the /TOKENS flag. - - + + Specifies whether or not the disassembler should generate metadata + token values as comments. The default is . + + + if metadata token values should be + generated as comments; otherwise, . The + default is . + + + + Corresponds to the /TOKENS flag. + + - - Specifies whether or not the disassembler should use the UNICODE - encoding when generating the output. The default is ANSI. - - - if the output should be generated using - the UNICODE encoding; otherwise, . The - default is . - - - - Corresponds to the /UNICODE flag. - - + + Specifies whether or not the disassembler should use the UNICODE + encoding when generating the output. The default is ANSI. + + + if the output should be generated using + the UNICODE encoding; otherwise, . The + default is . + + + + Corresponds to the /UNICODE flag. + + - - Specifies whether or not the disassembler should use the UTF-8 - encoding when generating the output. The default is ANSI. - - - if the output should be generated using - the UTF-8 encoding; otherwise, . The - default is . - - - - Corresponds to the /UTF8 flag. - - + + Specifies whether or not the disassembler should use the UTF-8 + encoding when generating the output. The default is ANSI. + + + if the output should be generated using + the UTF-8 encoding; otherwise, . The + default is . + + + + Corresponds to the /UTF8 flag. + + @@ -408,13 +408,13 @@ - - The command-line arguments for the external program. - - - Overridden to ensure the <arg> elements would not be exposed - to build authors. - + + The command-line arguments for the external program. + + + Overridden to ensure the <arg> elements would not be exposed + to build authors. + @@ -426,25 +426,25 @@ - - Allows a Windows service to be controlled. - - - Starts the World Wide Web Publishing Service on the local computer. - - - ]]> - - - - Stops the Alerter service on computer 'MOTHER'. - - - ]]> - - + + Allows a Windows service to be controlled. + + + Starts the World Wide Web Publishing Service on the local computer. + + + ]]> + + + + Stops the Alerter service on computer 'MOTHER'. + + + ]]> + + @@ -453,9 +453,9 @@ - - Peforms actions on the service in order to reach the desired status. - + + Peforms actions on the service in order to reach the desired status. + @@ -503,77 +503,77 @@ instance for controlling the service identified by and . - - Holds the name of the service that should be controlled. - + + Holds the name of the service that should be controlled. + - - Holds the name of the computer on which the service resides. - + + Holds the name of the computer on which the service resides. + - - Holds the action that should be performed on the service. - + + Holds the action that should be performed on the service. + - - Holds the time, in milliseconds, the task will wait for a service - to reach the desired status. - + + Holds the time, in milliseconds, the task will wait for a service + to reach the desired status. + - - The name of the service that should be controlled. - + + The name of the service that should be controlled. + - - The name of the computer on which the service resides. The default - is the local computer. - + + The name of the computer on which the service resides. The default + is the local computer. + - - The action that should be performed on the service. - + + The action that should be performed on the service. + - - The time, in milliseconds, the task will wait for the service to - reach the desired status. The default is 5000 milliseconds. - + + The time, in milliseconds, the task will wait for the service to + reach the desired status. The default is 5000 milliseconds. + - - Defines the actions that can be performed on a service. - + + Defines the actions that can be performed on a service. + - - Starts a service. - + + Starts a service. + - - Stops a service. - + + Stops a service. + - - Restarts a service. - + + Restarts a service. + - - Pauses a running service. - + + Pauses a running service. + - - Continues a paused service. - + + Continues a paused service. + diff --git a/Tools/nant/bin/NAnt.NUnit.dll b/Tools/nant/bin/NAnt.NUnit.dll index a2731b0..cf7d5dc 100755 Binary files a/Tools/nant/bin/NAnt.NUnit.dll and b/Tools/nant/bin/NAnt.NUnit.dll differ diff --git a/Tools/nant/bin/NAnt.NUnit.xml b/Tools/nant/bin/NAnt.NUnit.xml index e5dfa34..39d46d6 100755 --- a/Tools/nant/bin/NAnt.NUnit.xml +++ b/Tools/nant/bin/NAnt.NUnit.xml @@ -5,31 +5,31 @@ - - Carries data specified through the formatter element. - + + Carries data specified through the formatter element. + - - Gets or sets the type of the formatter. - - The type of the formatter. + + Gets or sets the type of the formatter. + + The type of the formatter. - - Gets or sets a value indicating whether output should be persisted - to a file. - - - if output should be written to a file; otherwise, - . The default is . - + + Gets or sets a value indicating whether output should be persisted + to a file. + + + if output should be written to a file; otherwise, + . The default is . + - - Gets or sets the extension to append to the output filename. - - The extension to append to the output filename. + + Gets or sets the extension to append to the output filename. + + The extension to append to the output filename. @@ -92,11 +92,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -129,10 +129,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -147,64 +147,64 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - The built-in formatter types. - + + The built-in formatter types. + - - A plaintext formatter. - + + A plaintext formatter. + - - An XML formatter. - + + An XML formatter. + - - Represents the FormatterElement of the NUnit task. - + + Represents the FormatterElement of the NUnit task. + - - Type of formatter. - + + Type of formatter. + - - Extension to append to the output filename. - + + Extension to append to the output filename. + - - Determines whether output should be persisted to a file. The default - is . - + + Determines whether output should be persisted to a file. The default + is . + @@ -271,11 +271,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -308,10 +308,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -326,28 +326,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + diff --git a/Tools/nant/bin/NAnt.NUnit1Tasks.dll b/Tools/nant/bin/NAnt.NUnit1Tasks.dll index f0bc28c..a7bda37 100755 Binary files a/Tools/nant/bin/NAnt.NUnit1Tasks.dll and b/Tools/nant/bin/NAnt.NUnit1Tasks.dll differ diff --git a/Tools/nant/bin/NAnt.NUnit1Tasks.xml b/Tools/nant/bin/NAnt.NUnit1Tasks.xml index 1dc317d..941273b 100755 --- a/Tools/nant/bin/NAnt.NUnit1Tasks.xml +++ b/Tools/nant/bin/NAnt.NUnit1Tasks.xml @@ -5,14 +5,14 @@ - - The whole test suite started. - + + The whole test suite started. + - - The whole test suite ended. - + + The whole test suite ended. + @@ -72,11 +72,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -109,10 +109,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -127,42 +127,42 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Prints information about running tests directly to the build log. - + + Prints information about running tests directly to the build log. + - Not used, all output goes to Log class. + Not used, all output goes to Log class. - Called when the whole test suite has started. + Called when the whole test suite has started. - Called when the whole test suite has ended. + Called when the whole test suite has ended. Convert a stack trace line into something that can be clicked on in an IDE output window. @@ -207,35 +207,35 @@ - - Stops running tests when a test causes an error. The default is - . - - - Implies haltonfailure. - + + Stops running tests when a test causes an error. The default is + . + + + Implies haltonfailure. + - - Stops running tests if a test fails (errors are considered failures - as well). The default is . - + + Stops running tests if a test fails (errors are considered failures + as well). The default is . + - - Cancel the individual tests if they do not finish in the specified - time (measured in milliseconds). Ignored if fork is disabled. - + + Cancel the individual tests if they do not finish in the specified + time (measured in milliseconds). Ignored if fork is disabled. + - - Tests to run. - + + Tests to run. + - - Formatters to output results of unit tests. - + + Formatters to output results of unit tests. + @@ -243,25 +243,25 @@ - - Base name of the test result. The full filename is determined by this - attribute and the extension of formatter. - + + Base name of the test result. The full filename is determined by this + attribute and the extension of formatter. + - - Directory to write the reports to. - + + Directory to write the reports to. + - - Class name of the test. - + + Class name of the test. + - - Assembly to load the test from. - + + Assembly to load the test from. + @@ -269,20 +269,20 @@ - - Stop the build process if an error occurs during the test run. - + + Stop the build process if an error occurs during the test run. + - - Stop the build process if a test fails (errors are considered failures - as well). - + + Stop the build process if a test fails (errors are considered failures + as well). + - - The application configuration file to use for the NUnit test domain. - + + The application configuration file to use for the NUnit test domain. + @@ -336,11 +336,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -373,10 +373,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -391,98 +391,98 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Carries data specified through the test element. - + + Carries data specified through the test element. + - - Determines if the unit test needs running. - - - if unit test needs running, otherwise, - . - - - - Determines if the test needs running by looking at the date stamp - of the test assembly and the test results log. - - + + Determines if the unit test needs running. + + + if unit test needs running, otherwise, + . + + + + Determines if the test needs running by looking at the date stamp + of the test assembly and the test results log. + + - - Runs a Suite extracted from a TestCase subclass. - + + Runs a Suite extracted from a TestCase subclass. + - - Creates the formatters to be used when running this test. - + + Creates the formatters to be used when running this test. + - - Returns the output file or null if does not use a file. - + + Returns the output file or null if does not use a file. + - - Returns the test suite from a given class. - - - The assemblyQualifiedName parameter needs to be in form: - "full.qualified.class.name,Assembly" - + + Returns the test suite from a given class. + + + The assemblyQualifiedName parameter needs to be in form: + "full.qualified.class.name,Assembly" + - - Gets the collection of registered formatters. - - Collection of registered formatters. + + Gets the collection of registered formatters. + + Collection of registered formatters. - - Gets the result of the test. - - The result of the test. + + Gets the result of the test. + + The result of the test. - - Prints information about running tests in plain text. - + + Prints information about running tests in plain text. + - Sets the Writer the formatter is supposed to write its results to. + Sets the Writer the formatter is supposed to write its results to. - Called when the whole test suite has started. + Called when the whole test suite has started. - Called when the whole test suite has ended. + Called when the whole test suite has ended. Convert a stack trace line into something that can be clicked on in an IDE output window. @@ -502,15 +502,15 @@ - - Gets or sets the total run-time of a test. - - The total run-time of a test. + + Gets or sets the total run-time of a test. + + The total run-time of a test. - - Prints detailed information about running tests in XML format. - + + Prints detailed information about running tests in XML format. + @@ -525,14 +525,14 @@ - - Called when the whole test suite has started. - + + Called when the whole test suite has started. + - - Called when the whole test suite has ended. - + + Called when the whole test suite has ended. + diff --git a/Tools/nant/bin/NAnt.NUnit2Tasks.dll b/Tools/nant/bin/NAnt.NUnit2Tasks.dll index 547279e..657180c 100755 Binary files a/Tools/nant/bin/NAnt.NUnit2Tasks.dll and b/Tools/nant/bin/NAnt.NUnit2Tasks.dll differ diff --git a/Tools/nant/bin/NAnt.NUnit2Tasks.xml b/Tools/nant/bin/NAnt.NUnit2Tasks.xml index 95682c6..84a171f 100755 --- a/Tools/nant/bin/NAnt.NUnit2Tasks.xml +++ b/Tools/nant/bin/NAnt.NUnit2Tasks.xml @@ -34,36 +34,36 @@ - - Specifies a list of categories to include. - + + Specifies a list of categories to include. + - - Specifies a list of categories to exclude. - + + Specifies a list of categories to exclude. + - - Represents a certain group of test cases or fixtures. - + + Represents a certain group of test cases or fixtures. + - - A name of a category, or comma-separated list of names. - + + A name of a category, or comma-separated list of names. + - - If then the category will be processed; - otherwise, skipped. The default is . - + + If then the category will be processed; + otherwise, skipped. The default is . + - - If then the category will be skipped; - otherwise, processed. The default is . - + + If then the category will be skipped; + otherwise, processed. The default is . + @@ -75,17 +75,33 @@ Initializes a new instance of the class. + + + Initializes a new instance of the + class as a wrapper for + the specified list. + + + The list that is wrapped by the newly created instance. + + Initializes a new instance of the class with the specified instance. + + The collection to use to initialize the new instance with. + Initializes a new instance of the class with the specified array of instances. + + The collection to use to initialize the new instance with. + @@ -96,89 +112,15 @@ if there are no categories. - + - Adds a to the end of the collection. + Adds the elements of a array to the end of the + collection. - The to be added to the end of the collection. - The position into which the new element was inserted. - - - - Adds the elements of a array to the end of the collection. - - The array of elements to be added to the end of the collection. - - - - Adds the elements of a to the end of the collection. - - The to be added to the end of the collection. - - - - Determines whether a is in the collection. - - The to locate in the collection. - - if is found in the - collection; otherwise, . - - - - - Determines whether a with the specified - value is in the collection. - - The argument value to locate in the collection. - - if a with value - is found in the collection; otherwise, - . - - - - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. - - - - Retrieves the index of a specified object in the collection. - - The object for which the index is returned. - - The index of the specified . If the is not currently a member of the collection, it returns -1. - - - - - Inserts a into the collection at the specified index. - - The zero-based index at which should be inserted. - The to insert. - - - - Returns an enumerator that can iterate through the collection. - - - A for the entire collection. - - - - - Removes a member from the collection. - - The to remove from the collection. - - - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + The array of elements to be added to the end of + the collection. + @@ -186,45 +128,9 @@ The name of the to get. - - - Enumerates the elements of a . - - - - - Initializes a new instance of the class - with the specified . - - The collection that should be enumerated. - - - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - - - - - Sets the enumerator to its initial position, which is before the - first element in the collection. - - - - - Gets the current element in the collection. - - - The current element in the collection. - - - Runs tests using the NUnit V2.2 framework. + Runs tests using the NUnit V2.6 framework. @@ -303,24 +209,50 @@ - - Runs the tests and sets up the formatters. - + + Runs the tests and sets up the formatters. + + + + + Gets a new EventListener to use for the unit tests. + + + A new EventListener created with a new EventCollector that + is initialized with . + + + Log writer to send test output to. + + + + + Gets the logging threshold to use for a test runner based on + the current threshold of this task. + + + The logging threshold to use when running a test runner. + - - Stop the test run if a test fails. The default is . - + + Stop the test run if a test fails. The default is . + + + + + Indicate whether or not to label the text output as the tests run. + - - Tests to run. - + + Tests to run. + - - Formatters to output results of unit tests. - + + Formatters to output results of unit tests. + @@ -328,35 +260,35 @@ - - Name of the assembly to search for tests. - + + Name of the assembly to search for tests. + - - Name of a specific testfixture to run. If not specified then all - testfixtures are run. - + + Name of a specific testfixture to run. If not specified then all + testfixtures are run. + - - Assemblies to include in test. - + + Assemblies to include in test. + - - Assemblies to scan for missing assembly references. - + + Assemblies to scan for missing assembly references. + - - Categories of test cases to include or exclude. - + + Categories of test cases to include or exclude. + - - Build fails on failure. The default is . - + + Build fails on failure. The default is . + @@ -365,19 +297,19 @@ - - The application configuration file to use for the NUnit test domain. - If not specified, NAnt will try to use a configuration name matching - the file name of the assembly with extension ".config". - + + The application configuration file to use for the NUnit test domain. + If not specified, NAnt will try to use a configuration name matching + the file name of the assembly with extension ".config". + - - Gets all assemblies specified for these tests. - - - All assemblies specified for these tests. - + + Gets all assemblies specified for these tests. + + + All assemblies specified for these tests. + @@ -431,11 +363,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -468,10 +400,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -486,34 +418,34 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Custom TestDomain, similar to the one included with NUnit, in order - to workaround some limitations in it. - + + Custom TestDomain, similar to the one included with NUnit, in order + to workaround some limitations in it. + @@ -522,20 +454,20 @@ - - Runs a single testcase. - - The test assembly. - The application configuration file for the test domain. - List of files to scan for missing assembly references. - - The result of the test. - + + Runs a single testcase. + + The test assembly. + The application configuration file for the test domain. + List of files to scan for missing assembly references. + + The result of the test. + - - Helper class called when an assembly resolve event is raised. - + + Helper class called when an assembly resolve event is raised. + @@ -564,21 +496,21 @@ An that contains the event data. - - Holds the list of directories that will be scanned for missing - assembly references. - + + Holds the list of directories that will be scanned for missing + assembly references. + - - Holds the list of assemblies that can be scanned for missing - assembly references. - + + Holds the list of assemblies that can be scanned for missing + assembly references. + - - Holds the loaded assemblies. - + + Holds the loaded assemblies. + diff --git a/Tools/nant/bin/NAnt.SourceControlTasks.dll b/Tools/nant/bin/NAnt.SourceControlTasks.dll index 3374df5..82e44da 100755 Binary files a/Tools/nant/bin/NAnt.SourceControlTasks.dll and b/Tools/nant/bin/NAnt.SourceControlTasks.dll differ diff --git a/Tools/nant/bin/NAnt.SourceControlTasks.xml b/Tools/nant/bin/NAnt.SourceControlTasks.xml index 2e5cb8f..9e1791a 100755 --- a/Tools/nant/bin/NAnt.SourceControlTasks.xml +++ b/Tools/nant/bin/NAnt.SourceControlTasks.xml @@ -5,44 +5,44 @@ - - A base class for creating tasks for executing CVS client commands on a - CVS repository. - + + A base class for creating tasks for executing CVS client commands on a + CVS repository. + - - A base class for creating tasks for executing CVS client commands on a - CVS repository. - + + A base class for creating tasks for executing CVS client commands on a + CVS repository. + - - Name of the environmental variable specifying a users' home - in a *nix environment. - + + Name of the environmental variable specifying a users' home + in a *nix environment. + - - Used on windows to specify the location of application data. - + + Used on windows to specify the location of application data. + - - The environment variable that holds path information. - + + The environment variable that holds path information. + - - The environment variable that holds the location of the - .cvspass file. - + + The environment variable that holds the location of the + .cvspass file. + - - Property name used to specify the source control executable. This is - used as a readonly property. - + + Property name used to specify the source control executable. This is + used as a readonly property. + @@ -51,245 +51,245 @@ - - Build up the command line arguments, determine which executable is being - used and find the path to that executable and set the working - directory. - - The process to prepare. + + Build up the command line arguments, determine which executable is being + used and find the path to that executable and set the working + directory. + + The process to prepare. - - Adds a new global option if none exists. If one does exist then - the use switch is toggled on or of. - - The common name of the option. - The option value or command line switch - of the option. - true if the option should be - appended to the commandline, otherwise false. + + Adds a new global option if none exists. If one does exist then + the use switch is toggled on or of. + + The common name of the option. + The option value or command line switch + of the option. + true if the option should be + appended to the commandline, otherwise false. - - Adds a new command option if none exists. If one does exist then - the use switch is toggled on or of. - - The common name of the option. - The option value or command line switch - of the option. - true if the option should be - appended to the commandline, otherwise false. + + Adds a new command option if none exists. If one does exist then + the use switch is toggled on or of. + + The common name of the option. + The option value or command line switch + of the option. + true if the option should be + appended to the commandline, otherwise false. - - Set up the environment variables for a process. - - A process to setup. + + Set up the environment variables for a process. + + A process to setup. - - Append the files specified in the fileset to the command line argument. - Files are changed to use a relative path from the working directory - that the task is spawned in. - + + Append the files specified in the fileset to the command line argument. + Files are changed to use a relative path from the working directory + that the task is spawned in. + - - Derive the location of the version control system from the environment - variable PATH. - - The file information of the version control system, - or null if this cannot be found. + + Derive the location of the version control system from the environment + variable PATH. + + The file information of the version control system, + or null if this cannot be found. - - The name of the passfile, overriden for each version control system (VCS). - + + The name of the passfile, overriden for each version control system (VCS). + - - The path to the specific home directory of the version control system, - this can be where the binary files are kept, or other app - information. - + + The path to the specific home directory of the version control system, + this can be where the binary files are kept, or other app + information. + - - The environment variable that defines where the version control system - (VCS) home variable is kept. - + + The environment variable that defines where the version control system + (VCS) home variable is kept. + - - The name of the version control system (VCS) executable file. - + + The name of the version control system (VCS) executable file. + - - - The root variable contains information on how to locate a repository. - Although this information is in different formats it typically must - define the following: - - server location - protocol used to communicate with the repository - repository location on the server - project location in the repository - - - + + + The root variable contains information on how to locate a repository. + Although this information is in different formats it typically must + define the following: + + server location + protocol used to communicate with the repository + repository location on the server + project location in the repository + + + - - Destination directory for the local sandbox. If destination is not specified - then the current directory is used. - - - Root path of the local sandbox. - - - - Root path of the local sandbox. - - + + Destination directory for the local sandbox. If destination is not specified + then the current directory is used. + + + Root path of the local sandbox. + + + + Root path of the local sandbox. + + - - The password for logging in to the repository. - - - The password for logging in to the repository. - + + The password for logging in to the repository. + + + The password for logging in to the repository. + - - The full path to the cached password file. If not specified then the - environment variables are used to try and locate the file. - + + The full path to the cached password file. If not specified then the + environment variables are used to try and locate the file. + - - Holds a collection of globally available options. - + + Holds a collection of globally available options. + - - A collection of options that can be used to modify the default behavoir - of the version control commands. See the sub-tasks for implementation - specifics. - + + A collection of options that can be used to modify the default behavoir + of the version control commands. See the sub-tasks for implementation + specifics. + - - Command-line arguments for the program. The command line arguments are used to specify - any cvs command options that are not available as attributes. These are appended - after the command itself and are additive to whatever attributes are currently specified. - - - <cvs-checkout cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant" - module="nant" - destination="e:\test\merillcornish\working" - readonly="true" - quiet="true" - commandline="-n" - cvsfullpath="C:\Program Files\TortoiseCVS\cvs.exe" - /> -
- Produces the cvs command: - c:\Program Files\TortoiseCVS\cvs.exe -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant -q checkout -n nant - + + Command-line arguments for the program. The command line arguments are used to specify + any cvs command options that are not available as attributes. These are appended + after the command itself and are additive to whatever attributes are currently specified. + + + <cvs-checkout cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant" + module="nant" + destination="e:\test\merillcornish\working" + readonly="true" + quiet="true" + commandline="-n" + cvsfullpath="C:\Program Files\TortoiseCVS\cvs.exe" + /> +
+ Produces the cvs command: + c:\Program Files\TortoiseCVS\cvs.exe -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant -q checkout -n nant + - - The name of the command that is going to be executed. - + + The name of the command that is going to be executed. + - - Used to specify the version control system (VCS) files that are going - to be acted on. - + + Used to specify the version control system (VCS) files that are going + to be acted on. + - - The executable to use for ssh communication. - + + The executable to use for ssh communication. + - - The environment name for the ssh variable. - + + The environment name for the ssh variable. + - - The name of the version control system executable. - + + The name of the version control system executable. + - - Get the command line arguments for the task. - + + Get the command line arguments for the task. + - - Default value for the recursive directive. The default is - . - + + Default value for the recursive directive. The default is + . + - - Default value for the quiet command. - + + Default value for the quiet command. + - - Default value for the really quiet command. - + + Default value for the really quiet command. + - - An environment variable that holds path information about where - cvs is located. - + + An environment variable that holds path information about where + cvs is located. + - - Name of the password file that cvs stores pserver - cvsroot/ password pairings. - + + Name of the password file that cvs stores pserver + cvsroot/ password pairings. + - - The default compression level to use for cvs commands. - + + The default compression level to use for cvs commands. + - - The default use of binaries, defaults to use sharpcvs. - + + The default use of binaries, defaults to use sharpcvs. + - - The name of the cvs executable. - + + The name of the cvs executable. + - - The temporary name of the sharpcvslib binary file, to avoid - conflicts in the path variable. - + + The temporary name of the sharpcvslib binary file, to avoid + conflicts in the path variable. + - - Environment variable that holds the executable name that is used for - ssh communication. - + + Environment variable that holds the executable name that is used for + ssh communication. + - - Property name used to specify on a project level whether sharpcvs is - used or not. - + + Property name used to specify on a project level whether sharpcvs is + used or not. + @@ -299,253 +299,255 @@ - Converts a value to a - representation that can be interpreted by cvs. + Converts a date value to a string representation that can be + interpreted by cvs. - to convert. + Date to convert. - interpretation of . + String interpretation of . - - Build up the command line arguments, determine which executable is being - used and find the path to that executable and set the working - directory. - - The process to prepare. + + Build up the command line arguments, determine which executable is being + used and find the path to that executable and set the working + directory. + + The process to prepare. - - Override to append any commands before the modele and files. - + + Override to append any commands before the modele and files. + - - Append the command line options or commen names for the options - to the generic options collection. This is then piped to the - command line as a switch. - + + Append the command line options or commen names for the options + to the generic options collection. This is then piped to the + command line as a switch. + - - Add the given argument to the command line options. Note that are not explicitly - quoted are split into seperate arguments. This is to resolve a recent issue - with quoting command line arguments. - - + + Add the given argument to the command line options. Note that are not explicitly + quoted are split into seperate arguments. This is to resolve a recent issue + with quoting command line arguments. + + - - The environment name for the ssh variable. - + + The environment name for the ssh variable. + - - The name of the cvs binary, or cvs.exe at the time this - was written. - + + The name of the cvs binary, or cvs.exe at the time this + was written. + - - The name of the pass file, or .cvspass at the time - of this writing. - + + The name of the pass file, or .cvspass at the time + of this writing. + - - The name of the version control system specific home environment - variable. - + + The name of the version control system specific home environment + variable. + - - Specify if the module is needed for this cvs command. It is - only needed if there is no module information on the local file - system. - + + Specify if the module is needed for this cvs command. It is + only needed if there is no module information on the local file + system. + - - Used to specify the version control system (VCS) files that are going - to be acted on. - + + Used to specify the version control system (VCS) files that are going + to be acted on. + - - Get the cvs file set. - + + Get the cvs file set. + - - The name of the cvs executable. - + + The name of the cvs executable. + - - The full path to the cvs binary used. The cvs tasks will attempt to - "guess" the location of your cvs binary based on your path. If the - task is unable to resolve the location, or resolves it incorrectly - this can be used to manually specify the path. - - - A full path (i.e. including file name) of your cvs binary: - On Windows: c:\vcs\cvs\cvs.exe - On *nix: /usr/bin/cvs - + + The full path to the cvs binary used. The cvs tasks will attempt to + "guess" the location of your cvs binary based on your path. If the + task is unable to resolve the location, or resolves it incorrectly + this can be used to manually specify the path. + + + A full path (i.e. including file name) of your cvs binary: + On Windows: c:\vcs\cvs\cvs.exe + On *nix: /usr/bin/cvs + - - - The cvs root variable has the following components: - - - [protocol]:[username]@[servername]:[server path] -
    -
  • protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation.
    • -
  • username: [username]
    • -
  • servername: cvs.sourceforge.net
    • -
  • server path: /cvsroot/nant
    • -
- - - - NAnt anonymous cvsroot: - - :pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant - - + + + The cvs root variable has the following components: + + + [protocol]:[username]@[servername]:[server path] +
    +
  • protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation.
    • +
  • username: [username]
    • +
  • servername: cvs.sourceforge.net
    • +
  • server path: /cvsroot/nant
    • +
+ + + + NAnt anonymous cvsroot: + + :pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant + + - - The module to perform an operation on. - - - The module to perform an operation on. This is a normal file/folder - name without path information. - - - In NAnt the module name would be: - nant - + + The module to perform an operation on. + + + The module to perform an operation on. This is a normal file/folder + name without path information. + + + In NAnt the module name would be: + nant + - - - if the SharpCvsLib binaries that come bundled - with NAnt should be used to perform the cvs commands, - otherwise. - - - You may also specify an override value for all cvs tasks instead - of specifying a value for each. To do this set the property - sourcecontrol.usesharpcvslib to . - - - If you choose not to use SharpCvsLib to checkout from cvs you will - need to include a cvs.exe binary in your path. - - - - To use a cvs client in your path instead of sharpcvslib specify - the property: - >property name="sourcecontrol.usesharpcvslib" value="false"< - The default settings is to use sharpcvslib and the setting closest - to the task execution is used to determine which value is used - to execute the process. - For instance if the attribute usesharpcvslib was set to false - and the global property was set to true, the usesharpcvslib is - closes to the point of execution and would be used and is false. - Therefore the sharpcvslib binary would NOT be used. - + + + if the SharpCvsLib binaries that come bundled + with NAnt should be used to perform the cvs commands, + otherwise. + + + You may also specify an override value for all cvs tasks instead + of specifying a value for each. To do this set the property + sourcecontrol.usesharpcvslib to . + + + If you choose not to use SharpCvsLib to checkout from cvs you will + need to include a cvs.exe binary in your path. + + + + To use a cvs client in your path instead of sharpcvslib specify + the property: + >property name="sourcecontrol.usesharpcvslib" value="false"< + + The default settings is to use sharpcvslib and the setting closest + to the task execution is used to determine which value is used + to execute the process. + + For instance if the attribute usesharpcvslib was set to false + and the global property was set to true, the usesharpcvslib is + closes to the point of execution and would be used and is false. + Therefore the sharpcvslib binary would NOT be used. + - - The executable to use for ssh communication. - + + The executable to use for ssh communication. + - - Indicates if the output from the cvs command should be supressed. - The default is . - + + Indicates if the output from the cvs command should be supressed. + The default is . + - - Indicates if the output from the cvs command should be stopped. - The default is . - + + Indicates if the output from the cvs command should be stopped. + The default is . + - - if the sandbox files should be checked out in - read only mode. The default is . - + + if the sandbox files should be checked out in + read only mode. The default is . + - - if the sandbox files should be checked out in - read/write mode. The default is . - + + if the sandbox files should be checked out in + read/write mode. The default is . + - - Compression level to use for all net traffic. This should be a value from 1-9. -
-
- NOTE: This is not available on sharpcvslib. - + + Compression level to use for all net traffic. This should be a value from 1-9. +
+
+ NOTE: This is not available on sharpcvslib. + - - Produces an XML report that represents the cvs changes from the given - start day, to a given end date. - - - Report changes in NAnt from 1st of June 2004 until 25th of July 2004. - - - ]]> - - + + Produces an XML report that represents the cvs changes from the given + start day, to a given end date. + + + Report changes in NAnt from 1st of June 2004 until 25th of July 2004. + + + ]]> + + - - The command being executed. - + + The command being executed. + - - Name of the xml file that will contain the cvs log information. - + + Name of the xml file that will contain the cvs log information. + - - The earliest change to use in the cvs log command. - + + The earliest change to use in the cvs log command. + - - The latest date to use in the cvs log command. - + + The latest date to use in the cvs log command. + - - The cvs command to execute. - + + The cvs command to execute. + - - Override use of sharpcvslib, needs to be true. - + + Override use of sharpcvslib, needs to be true. + @@ -575,61 +577,61 @@ - - Checks out a CVS module to the required directory. - - - Checkout NAnt. - - - ]]> - - - - - Checkout NAnt revision named 0_85 to the - folder c:\src\nant\v0.85. - - - - ]]> - - So the nant module tagged with revision 0_85 will be checked - out in the folder v0.85 under the working/ destination directory. -
This could be used to work on different - branches of a repository at the same time. - - - - Checkout NAnt with specified revision date to the - folder c:\src\nant\2003_08_16. - - - - ]]> - - + + Checks out a CVS module to the required directory. + + + Checkout NAnt. + + + ]]> + + + + + Checkout NAnt revision named 0_85 to the + folder c:\src\nant\v0.85. + + + + ]]> + + So the nant module tagged with revision 0_85 will be checked + out in the folder v0.85 under the working/ destination directory. +
This could be used to work on different + branches of a repository at the same time. + + + + Checkout NAnt with specified revision date to the + folder c:\src\nant\2003_08_16. + + + + ]]> + + - - The command being executed. - + + The command being executed. + @@ -637,55 +639,55 @@ - - Specify the revision to checkout. This corresponds to the "sticky-tag" - of the file. - + + Specify the revision to checkout. This corresponds to the "sticky-tag" + of the file. + - - Sticky tag or revision to checkout. - + + Sticky tag or revision to checkout. + - - Specify the revision date to checkout. The date specified is validated - and then passed to the cvs binary in a standard format recognized by - cvs. - + + Specify the revision date to checkout. The date specified is validated + and then passed to the cvs binary in a standard format recognized by + cvs. + - - Specify a directory name to replace the module name. Valid names - include any valid filename, excluding path information. - + + Specify a directory name to replace the module name. Valid names + include any valid filename, excluding path information. + - - Specify a directory name to replace the module name. Valid names - include any valid filename, excluding path information. - + + Specify a directory name to replace the module name. Valid names + include any valid filename, excluding path information. + - - The name of the cvs command that is going to be executed. - + + The name of the cvs command that is going to be executed. + - - Executes the cvs login command which appends or updates an entry to the - specified .cvspass file. - - - Update .cvspass file to include the NAnt anonymous login. - - - ]]> - - + + Executes the cvs login command which appends or updates an entry to the + specified .cvspass file. + + + Update .cvspass file to include the NAnt anonymous login. + + + ]]> + + @@ -693,111 +695,111 @@ - - Update the .cvspass file with the given password. If the passfile - is not specified then the default search locations are used: - - CVS_PASSFILE/.cvspass - HOME/.cvspass - USERPROFILE/.cvspass TODO: Confirm that this is valid - behavior or if it is going to give problems with the - cvsnt implementation. - - + + Update the .cvspass file with the given password. If the passfile + is not specified then the default search locations are used: + + CVS_PASSFILE/.cvspass + HOME/.cvspass + USERPROFILE/.cvspass TODO: Confirm that this is valid + behavior or if it is going to give problems with the + cvsnt implementation. + + - - Password to append or update to the .cvspass file. - + + Password to append or update to the .cvspass file. + - - The full path to the .cvspass file. The default is ~/.cvspass. - - + + The full path to the .cvspass file. The default is ~/.cvspass. + + - - The current working directory. - + + The current working directory. + - - The repository root string. - + + The repository root string. + - - Executes the cvs command specified by the command attribute. - - - Checkout NAnt. - - - ]]> - - + + Executes the cvs command specified by the command attribute. + + + Checkout NAnt. + + + ]]> + + - - The cvs command to execute. - + + The cvs command to execute. + - - Specify if the module is needed for this cvs command. - + + Specify if the module is needed for this cvs command. + - - Exports a cvs module in preperation for a release (i.e. the CVS version - folders are not exported). - - - Export the most recent NAnt sources from cvs. - - - ]]> - - - - - Export NAnt revision named your_favorite_revision_here to the - folder c:\src\nant\replacement_for_module_directory_name. - - **NOTE**: filesets names for the export task must be - prefixed with the module name. This is different than other tasks. - - - - - - - - - ]]> - - + + Exports a cvs module in preperation for a release (i.e. the CVS version + folders are not exported). + + + Export the most recent NAnt sources from cvs. + + + ]]> + + + + + Export NAnt revision named your_favorite_revision_here to the + folder c:\src\nant\replacement_for_module_directory_name. + + **NOTE**: filesets names for the export task must be + prefixed with the module name. This is different than other tasks. + + + + + + + + + ]]> + + - - The command being executed. - + + The command being executed. + @@ -811,9 +813,9 @@ - - No shortening. Do not shorten module paths if -d specified. - + + No shortening. Do not shorten module paths if -d specified. + @@ -827,82 +829,82 @@ - - If a directory is specified indicates whether sub-directories should - also be processed. - - - if the sub-directories should be tagged; - otherwise, . The default is . - + + If a directory is specified indicates whether sub-directories should + also be processed. + + + if the sub-directories should be tagged; + otherwise, . The default is . + - - Specify the revision to update the file to. This corresponds to the "sticky-tag" - of the file. - + + Specify the revision to update the file to. This corresponds to the "sticky-tag" + of the file. + - - Specify the revision date to update to. The version of the file that - existed at the date specified is retrieved. - - - A valid date time value, which is then converted to a format that - cvs can parse. - + + Specify the revision date to update to. The version of the file that + existed at the date specified is retrieved. + + + A valid date time value, which is then converted to a format that + cvs can parse. + - - Specify a directory name to replace the module name. Valid names - include any valid filename, excluding path information. - + + Specify a directory name to replace the module name. Valid names + include any valid filename, excluding path information. + - - The export command name for the cvs client. - + + The export command name for the cvs client. + - - Tags all sources in the remote repository with a given tag. - - - - Unlike tag, the rtag command acts only on sources that are in the repository. - Any modified sources on the local file system will NOT be tagged with this - command, so a commit should be performed before an rtag is done. - - - NOTE: Although a working directory is not necessary to perform the command - one must be specified in order to remain in compliance with the cvs library. - - - - Tag NAnt sources remotely. - - - ]]> - - - - Remove a tag from the remote repository. - - - ]]> - - + + Tags all sources in the remote repository with a given tag. + + + + Unlike tag, the rtag command acts only on sources that are in the repository. + Any modified sources on the local file system will NOT be tagged with this + command, so a commit should be performed before an rtag is done. + + + NOTE: Although a working directory is not necessary to perform the command + one must be specified in order to remain in compliance with the cvs library. + + + + Tag NAnt sources remotely. + + + ]]> + + + + Remove a tag from the remote repository. + + + ]]> + + @@ -911,17 +913,17 @@ - - Append the tag information to the commandline. - + + Append the tag information to the commandline. + - - The name of the tag to assign or remove. - - - The name of the tag to assign or remove. - + + The name of the tag to assign or remove. + + + The name of the tag to assign or remove. + @@ -945,14 +947,14 @@ - - If a directory is specified indicates whether sub-directories should - also be processed. - - - if the sub-directories should be tagged; - otherwise, . The default is . - + + If a directory is specified indicates whether sub-directories should + also be processed. + + + if the sub-directories should be tagged; + otherwise, . The default is . + @@ -966,14 +968,14 @@ - - Indicates the revision date of the file that the tag should be - applied to. - - - A valid date which specifies the revision point that the tag will - be applied to. - + + Indicates the revision date of the file that the tag should be + applied to. + + + A valid date which specifies the revision point that the tag will + be applied to. + @@ -987,9 +989,9 @@ - - The name of the cvs command that is going to be executed. - + + The name of the cvs command that is going to be executed. + @@ -1032,9 +1034,9 @@ - - Cvs command to be executed. - + + Cvs command to be executed. + @@ -1043,17 +1045,17 @@ - - Append the tag information to the commandline. - + + Append the tag information to the commandline. + - - The name of the tag to assign or remove. - - - The name of the tag to assign or remove. - + + The name of the tag to assign or remove. + + + The name of the tag to assign or remove. + @@ -1077,14 +1079,14 @@ - - If a directory is specified indicates whether sub-directories should - also be processed. - - - if the sub-directories should be tagged; - otherwise, . The default is . - + + If a directory is specified indicates whether sub-directories should + also be processed. + + + if the sub-directories should be tagged; + otherwise, . The default is . + @@ -1098,14 +1100,14 @@ - - Indicates the revision date of the file that the tag should be - applied to. - - - A valid date which specifies the revision point that the tag will - be applied to. - + + Indicates the revision date of the file that the tag should be + applied to. + + + A valid date which specifies the revision point that the tag will + be applied to. + @@ -1130,64 +1132,64 @@ - - The name of the cvs command that is going to be executed. - + + The name of the cvs command that is going to be executed. + - - Not used - + + Not used + - - Specify if the module is needed for this cvs command. It is - only needed if there is no module information on the local file - system. - + + Specify if the module is needed for this cvs command. It is + only needed if there is no module information on the local file + system. + - - Updates a CVS module in a local working directory. - - - Update nant. - - - ]]> - - - - - Update your NAnt revision named your_favorite_revision_here in - the folder c:\src\nant\replacement_for_module_directory_name. - - - - - - - - ]]> - - + + Updates a CVS module in a local working directory. + + + Update nant. + + + ]]> + + + + + Update your NAnt revision named your_favorite_revision_here in + the folder c:\src\nant\replacement_for_module_directory_name. + + + + + + + + ]]> + + - - The command being executed. - + + The command being executed. + @@ -1200,69 +1202,69 @@ - - If . new directories will be created on the local - sandbox. The default is . - + + If . new directories will be created on the local + sandbox. The default is . + - - If empty directories copied down from the - remote repository will be removed from the local sandbox. - The default is . - + + If empty directories copied down from the + remote repository will be removed from the local sandbox. + The default is . + - - If the local copy of the file will be - overwritten with the copy from the remote repository. The default - is . - + + If the local copy of the file will be + overwritten with the copy from the remote repository. The default + is . + - - Specifies if the command should be executed recursively. The - default is . - - - The -R option is on by default in cvs. - + + Specifies if the command should be executed recursively. The + default is . + + + The -R option is on by default in cvs. + - - Specify the revision to update the file to. This corresponds to the - "sticky-tag" of the file. - + + Specify the revision to update the file to. This corresponds to the + "sticky-tag" of the file. + - - Sticky tag or revision to update the local file to. - - - A valid cvs tag. - + + Sticky tag or revision to update the local file to. + + + A valid cvs tag. + - - Specify the revision date to update to. The version of the file that - existed at the date specified is retrieved. - - - A valid date time value, which is then converted to a format that - cvs can parse. - + + Specify the revision date to update to. The version of the file that + existed at the date specified is retrieved. + + + A valid date time value, which is then converted to a format that + cvs can parse. + - - Specify if the module is needed for this cvs command. It is - only needed if there is no module information on the local file - system. - + + Specify if the module is needed for this cvs command. It is + only needed if there is no module information on the local file + system. + - - The name of the cvs command that is going to be executed. - + + The name of the cvs command that is going to be executed. + @@ -1277,11 +1279,11 @@ - - Indicates whether the entires in the .cvsignore should be used to limit the - file list; to exclude files in .cvsignore, otherwise - . The default is . - + + Indicates whether the entires in the .cvsignore should be used to limit the + file list; to exclude files in .cvsignore, otherwise + . The default is . + diff --git a/Tools/nant/bin/NAnt.VSNetTasks.dll b/Tools/nant/bin/NAnt.VSNetTasks.dll index 9e77b69..37f8c3a 100755 Binary files a/Tools/nant/bin/NAnt.VSNetTasks.dll and b/Tools/nant/bin/NAnt.VSNetTasks.dll differ diff --git a/Tools/nant/bin/NAnt.VSNetTasks.xml b/Tools/nant/bin/NAnt.VSNetTasks.xml index 8220497..7a67649 100755 --- a/Tools/nant/bin/NAnt.VSNetTasks.xml +++ b/Tools/nant/bin/NAnt.VSNetTasks.xml @@ -5,9 +5,9 @@ - - Analyses Microsoft Visual Studio .NET 2003 (Everett) solution files. - + + Analyses Microsoft Visual Studio .NET 2003 (Everett) solution files. + @@ -20,14 +20,14 @@ No project with unique identifier could be located. - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the underlying task. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the underlying task. + @@ -51,15 +51,15 @@ A project GUID in the solution file does not match the actual GUID of the project in the project file. - - Translates a project path, in the form of a relative file path or - a URL, to an absolute file path. - - The directory of the solution. - The project path to translate to an absolute file path. - - The project path translated to an absolute file path. - + + Translates a project path, in the form of a relative file path or + a URL, to an absolute file path. + + The directory of the solution. + The project path to translate to an absolute file path. + + The project path translated to an absolute file path. + @@ -84,20 +84,20 @@ - - Returns a number representing how much this file fits this project type. - - - - - - This enables the override in other providers. Do not return big numbers, mainly when compring only on filename. - + + Returns a number representing how much this file fits this project type. + + + + + + This enables the override in other providers. Do not return big numbers, mainly when compring only on filename. + - - Analyses Microsoft Visual Studio .NET 2002 (Rainier) solution files. - + + Analyses Microsoft Visual Studio .NET 2002 (Rainier) solution files. + @@ -246,9 +246,9 @@ - - Private var containing custom properties. - + + Private var containing custom properties. + @@ -267,29 +267,29 @@ The macro cannot be expanded. - - Builds the list of folders that should be scanned for assembly - references. - - - The list of folders that should be scanned for assembly references. - + + Builds the list of folders that should be scanned for assembly + references. + + + The list of folders that should be scanned for assembly references. + - - The projects to build. - + + The projects to build. + - - The projects to scan, but not build. - - - These projects are used to resolve project references and are - generally external to the solution being built. References to - these project's output files are converted to use the appropriate - solution configuration at build time. - + + The projects to scan, but not build. + + + These projects are used to resolve project references and are + generally external to the solution being built. References to + these project's output files are converted to use the appropriate + solution configuration at build time. + @@ -303,52 +303,52 @@ - - The name of the solution configuration to build. - - - - Generally release or debug. Not case-sensitive. - - + + The name of the solution configuration to build. + + + + Generally release or debug. Not case-sensitive. + + - - The name of platform to build the solution for. - + + The name of platform to build the solution for. + - - Gets the solution configuration to build. - + + Gets the solution configuration to build. + - - The directory where compiled targets will be placed. This - overrides path settings contained in the solution/project. - + + The directory where compiled targets will be placed. This + overrides path settings contained in the solution/project. + - - WebMap of URL's to project references. - + + WebMap of URL's to project references. + - - Fileset of projects to exclude. - + + Fileset of projects to exclude. + - - Set of folders where references are searched when not found in path - from project file (HintPath). - + + Set of folders where references are searched when not found in path + from project file (HintPath). + - - Includes Visual Studio search folders in reference search path. - The default is . - + + Includes Visual Studio search folders in reference search path. + The default is . + @@ -362,163 +362,163 @@ - - Set of properties set at solution level. Builders for projects in solution may or may not use them. - - - - TODO: some documentataion which properties could be defined here. - - + + Set of properties set at solution level. Builders for projects in solution may or may not use them. + + + + TODO: some documentataion which properties could be defined here. + + - - Gets the list of folders to scan for assembly references. - - - The list of folders to scan for assembly references. - + + Gets the list of folders to scan for assembly references. + + + The list of folders to scan for assembly references. + - - Defines how the project is using the ATL library. - + + Defines how the project is using the ATL library. + - - Don't use ATL. - + + Don't use ATL. + - - Use ATL in a Static Library. - + + Use ATL in a Static Library. + - - Use ATL in a Shared DLL. - + + Use ATL in a Shared DLL. + - - Defines how the project is using the MFC library. - + + Defines how the project is using the MFC library. + - - Don't use MFC. - + + Don't use MFC. + - - Use MFC in a Static Library. - + + Use MFC in a Static Library. + - - Use MFC in a Shared DLL. - + + Use MFC in a Shared DLL. + - - Indicates the possible ways in which precompiled header file use is - specified in a Visual C++ project. - - - The integer values assigned match those specified in the Visual C++ - project file for each setting. - > + + Indicates the possible ways in which precompiled header file use is + specified in a Visual C++ project. + + + The integer values assigned match those specified in the Visual C++ + project file for each setting. + > - - Precompiled header file use not specified. - + + Precompiled header file use not specified. + - - Don't use a precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yc. - + + Don't use a precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yc. + - - Create precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yc. - + + Create precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yc. + - - Automatically create precompiled header file if necessary. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yc. - + + Automatically create precompiled header file if necessary. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yc. + - - Use a precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yu. - + + Use a precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yu. + - - Represents a single mapping from URL project path to physical project - path. - + + Represents a single mapping from URL project path to physical project + path. + - - Specifies the URL of the project file, or a URL fragment to match. - - - The URL of the project file or the URL fragment to match. - + + Specifies the URL of the project file, or a URL fragment to match. + + + The URL of the project file or the URL fragment to match. + - - Specifies the actual path to the project file, or the path fragment - to replace. - - - The actual path to the project file or the path fragment to replace - the URL fragment with. - + + Specifies the actual path to the project file, or the path fragment + to replace. + + + The actual path to the project file or the path fragment to replace + the URL fragment with. + - - Specifies whether the mapping is case-sensitive or not. - - - A boolean flag representing the case-sensitivity of the mapping. Default is . - + + Specifies whether the mapping is case-sensitive or not. + + + A boolean flag representing the case-sensitivity of the mapping. Default is . + - - Indicates if the URL of the project file should be mapped. - - - if the URL of the project file should be - mapped; otherwise, . - + + Indicates if the URL of the project file should be mapped. + + + if the URL of the project file should be + mapped; otherwise, . + - - Indicates if the URL of the project file should not be mapped. - - - if the URL of the project file should not - be mapped; otherwise, . - + + Indicates if the URL of the project file should not be mapped. + + + if the URL of the project file should not + be mapped; otherwise, . + @@ -591,11 +591,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -628,10 +628,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -652,38 +652,38 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Gets the output path of the reference, without taking the "copy local" - setting into consideration. - - The solution configuration that is built. - - The full output path of the reference. - + + Gets the output path of the reference, without taking the "copy local" + setting into consideration. + + The solution configuration that is built. + + The full output path of the reference. + @@ -699,35 +699,35 @@ - - Gets the complete set of assemblies that need to be referenced when - a project references this component. - - The solution configuration that is built. - - The complete set of assemblies that need to be referenced when a - project references this component. - + + Gets the complete set of assemblies that need to be referenced when + a project references this component. + + The solution configuration that is built. + + The complete set of assemblies that need to be referenced when a + project references this component. + - - Gets the timestamp of the reference. - - The solution configuration that is built. - - The timestamp of the reference. - + + Gets the timestamp of the reference. + + The solution configuration that is built. + + The timestamp of the reference. + - - Gets a value indicating whether the reference is managed for the - specified configuration. - - The solution configuration that is built. - - if the reference is managed for the - specified configuration; otherwise, . - + + Gets a value indicating whether the reference is managed for the + specified configuration. + + The solution configuration that is built. + + if the reference is managed for the + specified configuration; otherwise, . + @@ -742,14 +742,14 @@ - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the underlying task. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the underlying task. + @@ -763,39 +763,39 @@ - - Gets a value indicating whether the output file(s) of this reference - should be copied locally. - - - if the output file(s) of this reference - should be copied locally; otherwise, . - + + Gets a value indicating whether the output file(s) of this reference + should be copied locally. + + + if the output file(s) of this reference + should be copied locally; otherwise, . + - - Gets a value indicating whether this reference represents a system - assembly. - - - if this reference represents a system - assembly; otherwise, . - + + Gets a value indicating whether this reference represents a system + assembly. + + + if this reference represents a system + assembly; otherwise, . + - - Gets the project in which the reference is defined. - + + Gets the project in which the reference is defined. + - - Gets a value indicating whether the reference is managed for the - specified configuration. - - The build configuration of the reference. - - . - + + Gets a value indicating whether the reference is managed for the + specified configuration. + + The build configuration of the reference. + + . + @@ -811,14 +811,14 @@ - - Gets the path of the reference, without taking the "copy local" - setting into consideration. - - The solution configuration that is built. - - The output path of the reference. - + + Gets the path of the reference, without taking the "copy local" + setting into consideration. + + The solution configuration that is built. + + The output path of the reference. + @@ -833,55 +833,55 @@ - - Gets the complete set of assemblies that need to be referenced when - a project references this component. - - The solution configuration that is built. - - The complete set of assemblies that need to be referenced when a - project references this component. - + + Gets the complete set of assemblies that need to be referenced when + a project references this component. + + The solution configuration that is built. + + The complete set of assemblies that need to be referenced when a + project references this component. + - - Gets the timestamp of the reference. - - The solution configuration that is built. - - The timestamp of the reference. - + + Gets the timestamp of the reference. + + The solution configuration that is built. + + The timestamp of the reference. + - - Resolves an assembly reference. - - - The full path to the resolved assembly, or - if the assembly reference could not be resolved. - + + Resolves an assembly reference. + + + The full path to the resolved assembly, or + if the assembly reference could not be resolved. + - - Searches for the given file in all paths in . - - The folders to search. - The file to search for. - - The path of the assembly if was found - in ; otherwise, . - + + Searches for the given file in all paths in . + + The folders to search. + The file to search for. + + The path of the assembly if was found + in ; otherwise, . + - - Resolves an assembly reference in the framework assembly directory - of the target framework. - - The file to search for. - - The full path of the assembly file if the assembly could be located - in the framework assembly directory; otherwise, . - + + Resolves an assembly reference in the framework assembly directory + of the target framework. + + The file to search for. + + The full path of the assembly file if the assembly could be located + in the framework assembly directory; otherwise, . + @@ -895,24 +895,24 @@ - - Gets a value indicating whether the output file(s) of this reference - should be copied locally. - - - if the output file(s) of this reference - should be copied locally; otherwise, . - + + Gets a value indicating whether the output file(s) of this reference + should be copied locally. + + + if the output file(s) of this reference + should be copied locally; otherwise, . + - - Gets a value indicating whether this reference represents a system - assembly. - - - if this reference represents a system - assembly; otherwise, . - + + Gets a value indicating whether this reference represents a system + assembly. + + + if this reference represents a system + assembly; otherwise, . + @@ -951,14 +951,14 @@ - - Gets the project. - + + Gets the project. + - - Gets the name of the configuration. - + + Gets the name of the configuration. + @@ -978,34 +978,34 @@ - - Gets the output directory. - + + Gets the output directory. + - - Gets the path for the output file. - + + Gets the path for the output file. + - - Gets the path in which the output file will be created before its - copied to the actual output path. - + + Gets the path in which the output file will be created before its + copied to the actual output path. + - - Get the path of the output directory relative to the project - directory. - + + Get the path of the output directory relative to the project + directory. + - - Gets the platform that the configuration targets. - - - The platform targeted by the configuration. - + + Gets the platform that the configuration targets. + + + The platform targeted by the configuration. + @@ -1040,33 +1040,33 @@ The appropriate number of entries that the can initially contain. - - Gets the platform that the configuration targets. - - - The platform targeted by the configuration. - + + Gets the platform that the configuration targets. + + + The platform targeted by the configuration. + - - Gets the path in which the output file will be created before its - copied to the actual output path. - + + Gets the path in which the output file will be created before its + copied to the actual output path. + - - Gets a value indicating whether to register the project output for - use with COM components. - - - if the project output should be registered - for use with COM components; otherwise, . - + + Gets a value indicating whether to register the project output for + use with COM components. + + + if the project output should be registered + for use with COM components; otherwise, . + - - Base class for all project classes. - + + Base class for all project classes. + @@ -1093,25 +1093,25 @@ - - Gets a value indicating whether building the project for the specified - build configuration results in managed output. - - The build configuration. - - if the project output for the given build - configuration is managed; otherwise, . - + + Gets a value indicating whether building the project for the specified + build configuration results in managed output. + + The build configuration. + + if the project output for the given build + configuration is managed; otherwise, . + - - Expands the given macro. - - The macro to expand. - - The expanded macro or if the macro is not - supported. - + + Expands the given macro. + + The macro to expand. + + The expanded macro or if the macro is not + supported. + @@ -1142,33 +1142,33 @@ - - Prepares the project for being built. - - The solution configuration that is built. - - The default implementation will ensure that none of the output files - are marked read-only. - - - - Copies the specified file if the destination file does not exist, or - the source file has been modified since it was previously copied. + Prepares the project for being built. + + The solution configuration that is built. + + The default implementation will ensure that none of the output files + are marked read-only. + + + + + Copies the specified file if the destination file does not exist, or + the source file has been modified since it was previously copied. The file to copy. The destination file. The in which context the operation will be performed. - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the underlying task. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the underlying task. + @@ -1182,77 +1182,77 @@ - - Gets the Visual Studio product version of the project. - - - The Visual Studio product version of the project. - + + Gets the Visual Studio product version of the project. + + + The Visual Studio product version of the project. + - - Gets the name of the VS.NET project. - + + Gets the name of the VS.NET project. + - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the path of the VS.NET project. - + + Gets the path of the VS.NET project. + - - Gets the directory containing the VS.NET project. - + + Gets the directory containing the VS.NET project. + - - Get the location of the project. - + + Get the location of the project. + - - Get the directory in which intermediate build output that is not - specific to the build configuration will be stored. - - - - For projects, this is defined - as <Project Directory<\obj. - - - For projects, this is defined - as %HOMEPATH%\VSWebCache\<Machine Name>\<Project Directory>\obj. - - + + Get the directory in which intermediate build output that is not + specific to the build configuration will be stored. + + + + For projects, this is defined + as <Project Directory<\obj. + + + For projects, this is defined + as %HOMEPATH%\VSWebCache\<Machine Name>\<Project Directory>\obj. + + - - Gets or sets the unique identifier of the VS.NET project. - + + Gets or sets the unique identifier of the VS.NET project. + - - Gets a list of all configurations defined in the project. - + + Gets a list of all configurations defined in the project. + - - Gets a list of project configurations that can be build. - - - - Project configurations that are not in this list do not need to be - compiled. - - + + Gets a list of project configurations that can be build. + + + + Project configurations that are not in this list do not need to be + compiled. + + @@ -1268,37 +1268,37 @@ - - Gets the set of projects that the project depends on. - - - The set of projects that the project depends on. - + + Gets the set of projects that the project depends on. + + + The set of projects that the project depends on. + - - TODO: refactor this !!! - + + TODO: refactor this !!! + - - Gets a value indicating whether building the project for the specified - build configuration results in managed output. - - The solution configuration that is built. - - . - + + Gets a value indicating whether building the project for the specified + build configuration results in managed output. + + The solution configuration that is built. + + . + - - Prepares the project for being built. - - The solution configuration that is built. - - Ensures the configuration-level object directory exists and ensures - that none of the output files are marked read-only. - + + Prepares the project for being built. + + The solution configuration that is built. + + Ensures the configuration-level object directory exists and ensures + that none of the output files are marked read-only. + @@ -1346,37 +1346,37 @@ - - Gets the absolute path of the type library for the project - output. - - The configuration to build. - - The absolute path of the type library for the project output. - + + Gets the absolute path of the type library for the project + output. + + The configuration to build. + + The absolute path of the type library for the project output. + - - Generates a type library for the specified assembly, registers it. - - The project configuration that is built. - The solution configuration that is built. - The path of the type library to generate. - - The regasm tool is used to generate the type library. - + + Generates a type library for the specified assembly, registers it. + + The project configuration that is built. + The solution configuration that is built. + The path of the type library to generate. + + The regasm tool is used to generate the type library. + - - Unregister a type library for the specified assembly, and the types - in that assembly. - - The project configuration that is built. - The solution configuration that is built. - - The regasm tool is used to unregister the type library, and - remove the COM registration for types in the specified assembly. - + + Unregister a type library for the specified assembly, and the types + in that assembly. + + The project configuration that is built. + The solution configuration that is built. + + The regasm tool is used to unregister the type library, and + remove the COM registration for types in the specified assembly. + @@ -1441,52 +1441,52 @@ - - Gets the default file extension of sources for this project. - - - The default file extension of sources for this project. - + + Gets the default file extension of sources for this project. + + + The default file extension of sources for this project. + - - Gets a value indicating if this is a web project. - - - if this is a web project; otherwise, - . - - - If the url of a web project has been mapped to a local path - (using the <webmap> element), then this property will return - for a - project. - + + Gets a value indicating if this is a web project. + + + if this is a web project; otherwise, + . + + + If the url of a web project has been mapped to a local path + (using the <webmap> element), then this property will return + for a + project. + - - Gets the name of the VS.NET project. - + + Gets the name of the VS.NET project. + - - Gets the path of the VS.NET project. - + + Gets the path of the VS.NET project. + - - Gets the directory containing the VS.NET project. - + + Gets the directory containing the VS.NET project. + - - Get the location of the project. - + + Get the location of the project. + - - Gets or sets the unique identifier of the VS.NET project. - + + Gets or sets the unique identifier of the VS.NET project. + @@ -1502,15 +1502,15 @@ A . - - Gets the intermediate build directory in which the satellite - assembly is built. - - The project build configuration. - - The intermediate build directory in which the satellite assembly - is built. - + + Gets the intermediate build directory in which the satellite + assembly is built. + + The project build configuration. + + The intermediate build directory in which the satellite assembly + is built. + @@ -1525,15 +1525,15 @@ - - Gets path of the satellite assembly, relative to the output - directory. - - The project settings. - - The path of the satellite assembly, relative to the output - directory. - + + Gets path of the satellite assembly, relative to the output + directory. + + The project settings. + + The path of the satellite assembly, relative to the output + directory. + @@ -1542,9 +1542,9 @@ - - Gets the set of localized resources. - + + Gets the set of localized resources. + @@ -1630,25 +1630,25 @@ - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the default file extension of sources for this project. - - - For C# projects, the default file extension is ".cs". - + + Gets the default file extension of sources for this project. + + + For C# projects, the default file extension is ".cs". + - - Supports grouping of individual projects, and treating them as a solution. - + + Supports grouping of individual projects, and treating them as a solution. + @@ -1679,14 +1679,14 @@ - - Prepares the project for being built. - - The solution configuration that is built. - - Ensures the configuration-level object directory exists and ensures - that none of the output files are marked read-only. - + + Prepares the project for being built. + + The solution configuration that is built. + + Ensures the configuration-level object directory exists and ensures + that none of the output files are marked read-only. + @@ -1744,112 +1744,112 @@ - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the default file extension of sources for this project. - - - For J# projects, the default file extension is ".jsl". - + + Gets the default file extension of sources for this project. + + + For J# projects, the default file extension is ".jsl". + - - Resolves an assembly reference. - - - The full path to the resolved assembly, or - if the assembly reference could not be resolved. - - - - Visual Studio .NET uses the following search mechanism : - - - - - The project directory. - - - - - The directories specified in the "ReferencePath" property, - which is stored in the .USER file. - - - - - The .NET Framework directory (see KB306149) - - - - - - The directories specified under the following registry - keys: - - - - - HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders - - - - - HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders - - - - - HKLM\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders - - - - - HKCU\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders - - - - - Future versions of Visual Studio .NET will also check - in: - - - - - HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx - - - - - HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx - - - - - - - - The HintPath. - - - - + + Resolves an assembly reference. + + + The full path to the resolved assembly, or + if the assembly reference could not be resolved. + + + + Visual Studio .NET uses the following search mechanism : + + + + + The project directory. + + + + + The directories specified in the "ReferencePath" property, + which is stored in the .USER file. + + + + + The .NET Framework directory (see KB306149) + + + + + + The directories specified under the following registry + keys: + + + + + HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders + + + + + HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders + + + + + HKLM\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders + + + + + HKCU\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders + + + + + Future versions of Visual Studio .NET will also check + in: + + + + + HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx + + + + + HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx + + + + + + + + The HintPath. + + + + - - Gets the name of the referenced assembly. - - - The name of the referenced assembly, or if - the name could not be determined. - + + Gets the name of the referenced assembly. + + + The name of the referenced assembly, or if + the name could not be determined. + @@ -1868,37 +1868,37 @@ - - Indentifies the different output types of a managed project. - - - Visual Studio .NET does not support modules. - + + Indentifies the different output types of a managed project. + + + Visual Studio .NET does not support modules. + - - A class library. - + + A class library. + - - A console application. - + + A console application. + - - A Windows program. - + + A Windows program. + - - Gets the output path of the reference, without taking the "copy local" - setting into consideration. - - The solution configuration that is built. - - The output path of the reference. - + + Gets the output path of the reference, without taking the "copy local" + setting into consideration. + + The solution configuration that is built. + + The output path of the reference. + @@ -1916,86 +1916,86 @@ - - Gets the complete set of assemblies that need to be referenced when - a project references this project. - - The solution configuration that is built. - - The complete set of assemblies that need to be referenced when a - project references this project. - - - - Apparently, there's some hack in VB.NET that allows a type to be used - that derives from a type in an assembly that is not referenced by the - project. - - - When building from the command line (using vbc), the following error - is reported "error BC30007: Reference required to assembly 'X' - containing the base class 'X'. Add one to your project". - - - Somehow VB.NET can workaround this issue, without actually adding a - reference to that assembly. I verified this with both VS.NET 2003 and - VS.NET 2005. - - - For now, we have no other option than to return all assembly - references of the referenced project if the parent is a VB.NET - project. - - + + Gets the complete set of assemblies that need to be referenced when + a project references this project. + + The solution configuration that is built. + + The complete set of assemblies that need to be referenced when a + project references this project. + + + + Apparently, there's some hack in VB.NET that allows a type to be used + that derives from a type in an assembly that is not referenced by the + project. + + + When building from the command line (using vbc), the following error + is reported "error BC30007: Reference required to assembly 'X' + containing the base class 'X'. Add one to your project". + + + Somehow VB.NET can workaround this issue, without actually adding a + reference to that assembly. I verified this with both VS.NET 2003 and + VS.NET 2005. + + + For now, we have no other option than to return all assembly + references of the referenced project if the parent is a VB.NET + project. + + - - Gets the timestamp of the reference. - - The solution configuration that is built. - - The timestamp of the reference. - + + Gets the timestamp of the reference. + + The solution configuration that is built. + + The timestamp of the reference. + - - Gets a value indicating whether the output file(s) of this reference - should be copied locally. - - - if the output file(s) of this reference - should be copied locally; otherwise, . - + + Gets a value indicating whether the output file(s) of this reference + should be copied locally. + + + if the output file(s) of this reference + should be copied locally; otherwise, . + - - Gets a value indicating whether this reference represents a system - assembly. - - - as a project by itself can never be a - system assembly. - + + Gets a value indicating whether this reference represents a system + assembly. + + + as a project by itself can never be a + system assembly. + - - Gets a value indicating whether the reference is managed for the - specified configuration. - - The solution configuration that is built. - - . - + + Gets a value indicating whether the reference is managed for the + specified configuration. + + The solution configuration that is built. + + . + - - Gets the path of the reference, without taking the "copy local" - setting into consideration. - - The solution configuration that is built. - - The output path of the reference. - + + Gets the path of the reference, without taking the "copy local" + setting into consideration. + + The solution configuration that is built. + + The output path of the reference. + @@ -2010,52 +2010,52 @@ - - Gets the complete set of assemblies that need to be referenced when - a project references this component. - - The solution configuration that is built. - - The complete set of assemblies that need to be referenced when a - project references this component. - + + Gets the complete set of assemblies that need to be referenced when + a project references this component. + + The solution configuration that is built. + + The complete set of assemblies that need to be referenced when a + project references this component. + - - Gets the timestamp of the reference. - - The solution configuration that is built. - - The timestamp of the reference. - + + Gets the timestamp of the reference. + + The solution configuration that is built. + + The timestamp of the reference. + - - Removes wrapper assembly from build directory, if wrapper assembly - no longer exists in output directory or is not in sync with build - directory, to force rebuild. - - The project configuration. + + Removes wrapper assembly from build directory, if wrapper assembly + no longer exists in output directory or is not in sync with build + directory, to force rebuild. + + The project configuration. - - Gets a value indicating whether the output file(s) of this reference - should be copied locally. - - - if the reference wraps a Primary Interop - Assembly; otherwise, . - + + Gets a value indicating whether the output file(s) of this reference + should be copied locally. + + + if the reference wraps a Primary Interop + Assembly; otherwise, . + - - Gets a value indicating whether this reference represents a system - assembly. - - - as none of the system assemblies are wrappers - or Primary Interop Assemblies anyway. - + + Gets a value indicating whether this reference represents a system + assembly. + + + as none of the system assemblies are wrappers + or Primary Interop Assemblies anyway. + @@ -2068,74 +2068,74 @@ - - Gets the path of the wrapper assembly. - - - The path of the wrapper assembly. - - - The wrapper assembly is stored in the object directory of the - project. - + + Gets the path of the wrapper assembly. + + + The path of the wrapper assembly. + + + The wrapper assembly is stored in the object directory of the + project. + - - Gets a value indicating whether the wrapper assembly has already been - created. - + + Gets a value indicating whether the wrapper assembly has already been + created. + - - Gets the path of the Primary Interop Assembly. - - - The path of the Primary Interop Assembly, or - if not available. - + + Gets the path of the Primary Interop Assembly. + + + The path of the Primary Interop Assembly, or + if not available. + - - Gets the hex version of the type library as defined in the definition - of the reference. - - - The hex version of the type library. - + + Gets the hex version of the type library as defined in the definition + of the reference. + + + The hex version of the type library. + - - Gets the GUID of the type library as defined in the definition - of the reference. - - - The GUID of the type library. - + + Gets the GUID of the type library as defined in the definition + of the reference. + + + The GUID of the type library. + - - Gets the locale of the type library in hex notation. - - - The locale of the type library. - + + Gets the locale of the type library in hex notation. + + + The locale of the type library. + - - Gets the name of the type library. - - - The name of the type library. - + + Gets the name of the type library. + + + The name of the type library. + - - Gets the name of the referenced assembly. - - - The name of the referenced assembly, or if - the name could not be determined. - + + Gets the name of the referenced assembly. + + + The name of the referenced assembly, or if + the name could not be determined. + @@ -2148,25 +2148,25 @@ - - Gets the path of the wrapper assembly. - - - The path of the wrapper assembly. - - - The wrapper assembly is stored in the object directory of the - project. - + + Gets the path of the wrapper assembly. + + + The path of the wrapper assembly. + + + The wrapper assembly is stored in the object directory of the + project. + - - Gets the path of the Primary Interop Assembly. - - - The path of the Primary Interop Assembly, or - if not available. - + + Gets the path of the Primary Interop Assembly. + + + The path of the Primary Interop Assembly, or + if not available. + @@ -2187,111 +2187,111 @@ - - Gets the GUID of the type library as defined in the definition - of the reference. - - - The GUID of the type library. - + + Gets the GUID of the type library as defined in the definition + of the reference. + + + The GUID of the type library. + - - Gets the locale of the type library in hex notation. - - - The locale of the type library. - + + Gets the locale of the type library in hex notation. + + + The locale of the type library. + - - Specifies the type of the project. - + + Specifies the type of the project. + - - A Visual Basic.NET project. - + + A Visual Basic.NET project. + - - A Visual C# project. - + + A Visual C# project. + - - A Visual C++ project. - + + A Visual C++ project. + - - A Visual J# project. - + + A Visual J# project. + - - MSBuild project. - + + MSBuild project. + - - Specifies the result of the build. - + + Specifies the result of the build. + - - The build failed. - + + The build failed. + - - The build succeeded. - + + The build succeeded. + - - The build succeeded and the output was updated. - + + The build succeeded and the output was updated. + - - Visual Studio.NET 2002 - + + Visual Studio.NET 2002 + - - Visual Studio.NET 2003 - + + Visual Studio.NET 2003 + - - Visual Studio 2005 - + + Visual Studio 2005 + - - Visual Studio 2008 - + + Visual Studio 2008 + - - Visual Studio 2010 - + + Visual Studio 2010 + - - Indentifies the physical location of a managed project. - + + Indentifies the physical location of a managed project. + - - A local project. - + + A local project. + - - A web project. - + + A web project. + @@ -2357,11 +2357,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -2394,16 +2394,16 @@ The to remove from the collection. - - Remove items with the specified guid from the collection. - - The guid of the project to remove from the collection. + + Remove items with the specified guid from the collection. + + The guid of the project to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -2427,56 +2427,56 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Gets or sets the in memory representation of the project. - - - The in memory representation of the project, or - if the project is not (yet) loaded. - - - This property will always be for - projects that are not supported. - + + Gets or sets the in memory representation of the project. + + + The in memory representation of the project, or + if the project is not (yet) loaded. + + + This property will always be for + projects that are not supported. + - - Return a mapping between the configurations defined in the - solution file and the project build configurations. - - - Mapping between configurations defined in the solution file - and the project build configurations, or - if the project is not defined in a solution file. - - - This mapping only includes project build configurations that - are configured to be built for a given solution configuration. - + + Return a mapping between the configurations defined in the + solution file and the project build configurations. + + + Mapping between configurations defined in the solution file + and the project build configurations, or + if the project is not defined in a solution file. + + + This mapping only includes project build configurations that + are configured to be built for a given solution configuration. + @@ -2544,11 +2544,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -2581,10 +2581,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -2608,33 +2608,33 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Factory class for VS.NET projects. - + + Factory class for VS.NET projects. + @@ -2703,38 +2703,38 @@ - - Gets the .ico file to use as application icon. - - - The .ico file to use as application icon, or - if no application icon should be used. - + + Gets the .ico file to use as application icon. + + + The .ico file to use as application icon, or + if no application icon should be used. + - - Gets the key file to use to sign ActiveX/COM wrappers. - - - The path of the key file to use to sign ActiveX/COM wrappers, - relative to the project root directory, or - if the wrapper assembly should not be signed using a key file. - + + Gets the key file to use to sign ActiveX/COM wrappers. + + + The path of the key file to use to sign ActiveX/COM wrappers, + relative to the project root directory, or + if the wrapper assembly should not be signed using a key file. + - - Gets the key name to use to sign ActiveX/COM wrappers. - - - The name of the key container to use to sign ActiveX/COM wrappers, - or if the wrapper assembly should not be - signed using a key container. - + + Gets the key name to use to sign ActiveX/COM wrappers. + + + The name of the key container to use to sign ActiveX/COM wrappers, + or if the wrapper assembly should not be + signed using a key container. + - - Gets the output type of this project. - + + Gets the output type of this project. + @@ -2744,20 +2744,20 @@ - - Contains commands to be run before a build takes place. - - - Valid commands are those in a .bat file. For more info see MSDN. - + + Contains commands to be run before a build takes place. + + + Valid commands are those in a .bat file. For more info see MSDN. + - - Contains commands to be ran after a build has taken place. - - - Valid commands are those in a .bat file. For more info see MSDN. - + + Contains commands to be ran after a build has taken place. + + + Valid commands are those in a .bat file. For more info see MSDN. + @@ -2772,13 +2772,13 @@ - - Gets the file name of the assembly with the given assembly name. - - The assembly name of the assembly of which the file name should be returned. - - The file name of the assembly with the given assembly name. - + + Gets the file name of the assembly with the given assembly name. + + The assembly name of the assembly of which the file name should be returned. + + The file name of the assembly with the given assembly name. + @@ -2819,18 +2819,18 @@ - - Gets a value indicating whether the resource is in fact a ResX file. - - - if the resource is a ResX file; otherwise, - . - + + Gets a value indicating whether the resource is in fact a ResX file. + + + if the resource is a ResX file; otherwise, + . + - - Factory class for VS.NET solutions. - + + Factory class for VS.NET solutions. + @@ -2927,25 +2927,25 @@ - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the default file extension of sources for this project. - - - For VB projects, the default file extension is ".vb". - + + Gets the default file extension of sources for this project. + + + For VB projects, the default file extension is ".vb". + - - A mapping from properties in the .vcproj file to command line arguments. - + + A mapping from properties in the .vcproj file to command line arguments. + @@ -2954,19 +2954,19 @@ - - Gets the argument string corresponding with a configuration property - named with value . - An ignore mask can be used to eliminate some arguments from the search. - - The name of the configuration property. - The value of the configuration property. - Specify any groups that needs to be ignored. - - The argument string corresponding with a configuration property - named with value , - or if no corresponding argument exists. - + + Gets the argument string corresponding with a configuration property + named with value . + An ignore mask can be used to eliminate some arguments from the search. + + The name of the configuration property. + The value of the configuration property. + Specify any groups that needs to be ignored. + + The argument string corresponding with a configuration property + named with value , + or if no corresponding argument exists. + @@ -3164,55 +3164,55 @@ - - Gets the name of the command-line argument. - - - The name of the command-line argument. - + + Gets the name of the command-line argument. + + + The name of the command-line argument. + - - Represents a command-line arguments of which the trailing backslashes - in the value should be duplicated. - + + Represents a command-line arguments of which the trailing backslashes + in the value should be duplicated. + - - Represents a command-line argument of which the value should be - quoted, and of which trailing backslahes should be duplicated. - + + Represents a command-line argument of which the value should be + quoted, and of which trailing backslahes should be duplicated. + - - Gets the string that the configuration setting should match in - order for the command line argument to be set. - + + Gets the string that the configuration setting should match in + order for the command line argument to be set. + - - Allow us to assign an argument to a specific group. - + + Allow us to assign an argument to a specific group. + - - The argument is not assigned to any group. - + + The argument is not assigned to any group. + - - The argument is ignored when the optimization level is set to - Minimum Size (1) or Maximum Size (2). - + + The argument is ignored when the optimization level is set to + Minimum Size (1) or Maximum Size (2). + - - Resolves an assembly reference. - - - The full path to the resolved assembly, or - if the assembly reference could not be resolved. - + + Resolves an assembly reference. + + + The full path to the resolved assembly, or + if the assembly reference could not be resolved. + @@ -3227,19 +3227,19 @@ Expansion of a given macro is not yet implemented. - - Gets the name of the referenced assembly. - - - The name of the referenced assembly, or if - the name could not be determined. - + + Gets the name of the referenced assembly. + + + The name of the referenced assembly, or if + the name could not be determined. + - - A single build configuration for a Visual C++ project or for a specific - file in the project. - + + A single build configuration for a Visual C++ project or for a specific + file in the project. + @@ -3290,69 +3290,69 @@ - - Gets the intermediate directory, specified relative to project - directory. - - - The intermediate directory, specified relative to project directory. - + + Gets the intermediate directory, specified relative to project + directory. + + + The intermediate directory, specified relative to project directory. + - - Gets a comma-separated list of directories to scan for assembly - references. - - - A comma-separated list of directories to scan for assembly - references, or if no additional directories - should scanned. - + + Gets a comma-separated list of directories to scan for assembly + references. + + + A comma-separated list of directories to scan for assembly + references, or if no additional directories + should scanned. + - - Gets the name of the configuration, including the platform it - targets. - - - Tthe name of the configuration, including the platform it targets. - + + Gets the name of the configuration, including the platform it + targets. + + + Tthe name of the configuration, including the platform it targets. + - - Gets the output directory. - + + Gets the output directory. + - - Gets the path in which the output file will be created before its - copied to the actual output path. - - - For Visual C++ projects, the output file will be immediately - created in the output path. - + + Gets the path in which the output file will be created before its + copied to the actual output path. + + + For Visual C++ projects, the output file will be immediately + created in the output path. + - - Gets the name of the configuration. - - - The name of the configuration. - + + Gets the name of the configuration. + + + The name of the configuration. + - - Gets the platform that the configuration targets. - - - The platform targeted by the configuration. - + + Gets the platform that the configuration targets. + + + The platform targeted by the configuration. + - - Represents the configuration of a file. - + + Represents the configuration of a file. + @@ -3394,75 +3394,75 @@ - - Gets a value indication whether the file should be excluded from - the build for this configuration. - - - if the file should be excluded from the - build for this configuration; otherwise, . - + + Gets a value indication whether the file should be excluded from + the build for this configuration. + + + if the file should be excluded from the + build for this configuration; otherwise, . + - - Gets the relative path of the file. - - - The path of the file relative to the project directory. - + + Gets the relative path of the file. + + + The path of the file relative to the project directory. + - - Get the path of the output directory relative to the project - directory. - + + Get the path of the output directory relative to the project + directory. + - - Gets the intermediate directory, specified relative to project - directory. - - - The intermediate directory, specified relative to project directory. - + + Gets the intermediate directory, specified relative to project + directory. + + + The intermediate directory, specified relative to project directory. + - - Gets the path for the output file. - - - The path for the output file, or if there's - no output file for this configuration. - + + Gets the path for the output file. + + + The path for the output file, or if there's + no output file for this configuration. + - - Gets a comma-separated list of directories to scan for assembly - references. - - - A comma-separated list of directories to scan for assembly - references, or if no additional directories - should scanned. - + + Gets a comma-separated list of directories to scan for assembly + references. + + + A comma-separated list of directories to scan for assembly + references, or if no additional directories + should scanned. + - - Visual C++ project. - + + Visual C++ project. + - - Gets a value indicating whether building the project for the specified - build configuration results in managed output. - - The solution configuration that is built. - - if the project output for the specified build - configuration is either a Dynamic Library (dll) or an Application - (exe), and Managed Extensions are enabled; otherwise, - . - + + Gets a value indicating whether building the project for the specified + build configuration results in managed output. + + The solution configuration that is built. + + if the project output for the specified build + configuration is either a Dynamic Library (dll) or an Application + (exe), and Managed Extensions are enabled; otherwise, + . + @@ -3493,65 +3493,65 @@ - - Expands the given macro. - - The macro to expand. - - The expanded macro or if the macro is not - supported. - + + Expands the given macro. + + The macro to expand. + + The expanded macro or if the macro is not + supported. + - - Build resource files for the given configuration. - - The resource files to build. - The project configuration. - The build configuration. - - TODO: refactor this as we should always get only one element in the - list. Each res file should be built - with its own file configuration. - + + Build resource files for the given configuration. + + The resource files to build. + The project configuration. + The build configuration. + + TODO: refactor this as we should always get only one element in the + list. Each res file should be built + with its own file configuration. + - - Build Interface Definition Language files for the given - configuration. - - The IDL files to build. - The project configuration. - The build configuration. - - TODO: refactor this as we should always get only one element in the - list. Each IDL file should be built - with its own file configuration. - + + Build Interface Definition Language files for the given + configuration. + + The IDL files to build. + The project configuration. + The build configuration. + + TODO: refactor this as we should always get only one element in the + list. Each IDL file should be built + with its own file configuration. + - - Merges the specified tool setting of - with . - - - The merge is suppressed when the flag $(noinherit) is defined in - . - + + Merges the specified tool setting of + with . + + + The merge is suppressed when the flag $(noinherit) is defined in + . + - - Gets the absolute path to the object file or directory. - - The build configuration - - The absolute path to the object file or directory, or - - - We use an absolute path for the object file, otherwise - <cl> assumes a location relative to the output - directory - not the project directory. - + + Gets the absolute path to the object file or directory. + + The build configuration + + The absolute path to the object file or directory, or + + + We use an absolute path for the object file, otherwise + <cl> assumes a location relative to the output + directory - not the project directory. + @@ -3581,10 +3581,10 @@ - - Removes leading and trailing quotes from the specified path. - - The path to clean. + + Removes leading and trailing quotes from the specified path. + + The path to clean. @@ -3619,58 +3619,58 @@ - - Gets the name of the Visual C++ project. - + + Gets the name of the Visual C++ project. + - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the path of the Visual C++ project. - + + Gets the path of the Visual C++ project. + - - Gets the directory containing the VS.NET project. - + + Gets the directory containing the VS.NET project. + - - Get the location of the project. - - - . - - - For now, we only support local Visual C++ projects. - + + Get the location of the project. + + + . + + + For now, we only support local Visual C++ projects. + - - Get the directory in which intermediate build output that is not - specific to the build configuration will be stored. - - - This is a directory relative to the project directory, - named temp\. - + + Get the directory in which intermediate build output that is not + specific to the build configuration will be stored. + + + This is a directory relative to the project directory, + named temp\. + - - Gets or sets the unique identifier of the Visual C++ project. - + + Gets or sets the unique identifier of the Visual C++ project. + - - Represents a Visual C++ project configuration. - + + Represents a Visual C++ project configuration. + @@ -3692,15 +3692,15 @@ - - Gets the value of the specified attribute from the specified node. - - The node of which the attribute value should be retrieved. - The attribute of which the value should be returned. - - The value of the attribute with the specified name or - if the attribute does not exist or has no value. - + + Gets the value of the specified attribute from the specified node. + + The node of which the attribute value should be retrieved. + The attribute of which the value should be returned. + + The value of the attribute with the specified name or + if the attribute does not exist or has no value. + @@ -3711,106 +3711,106 @@ - - Holds list of files to link in the order in which they are defined - in the project file. - + + Holds list of files to link in the order in which they are defined + in the project file. + - - Holds the C++ sources for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the C++ source files for that - build configuration. - + + Holds the C++ sources for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the C++ source files for that + build configuration. + - - Holds the resources for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the resources files for that - build configuration. - + + Holds the resources for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the resources files for that + build configuration. + - - Holds the IDL files for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the IDL files for that build - configuration. - + + Holds the IDL files for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the IDL files for that build + configuration. + - - Tells the compiler which character set to use. - + + Tells the compiler which character set to use. + - - Gets a value indicating whether Managed Extensions for C++ are - enabled. - + + Gets a value indicating whether Managed Extensions for C++ are + enabled. + - - Gets a value indicating how MFC is used by the configuration. - + + Gets a value indicating how MFC is used by the configuration. + - - Gets a value indicating how ATL is used by the configuration. - + + Gets a value indicating how ATL is used by the configuration. + - - Gets the list of files to link in the order in which they are - defined in the project file. - + + Gets the list of files to link in the order in which they are + defined in the project file. + - - Holds the C++ sources for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the C++ source files for that - build configuration. - + + Holds the C++ sources for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the C++ source files for that + build configuration. + - - Gets the resources for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the resources files for that - build configuration. - + + Gets the resources for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the resources files for that + build configuration. + - - Get the IDL files for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the IDL files for that build - configuration. - + + Get the IDL files for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the IDL files for that build + configuration. + - - Gets the target path for usage in macro expansion. - - - The target path, or a zero-length string if there's no output file - for this configuration. - + + Gets the target path for usage in macro expansion. + + + The target path, or a zero-length string if there's no output file + for this configuration. + @@ -3830,69 +3830,69 @@ - - Get the path of the output directory relative to the project - directory. - + + Get the path of the output directory relative to the project + directory. + - - Gets the intermediate directory, specified relative to project - directory. - - - The intermediate directory, specified relative to project directory. - + + Gets the intermediate directory, specified relative to project + directory. + + + The intermediate directory, specified relative to project directory. + - - Gets the absolute path for the output file. - - - The absolute path for the output file, or - if there's no output file for this configuration. - + + Gets the absolute path for the output file. + + + The absolute path for the output file, or + if there's no output file for this configuration. + - - Gets a comma-separated list of directories to scan for assembly - references. - - - A comma-separated list of directories to scan for assembly - references, or if no additional directories - should scanned. - + + Gets a comma-separated list of directories to scan for assembly + references. + + + A comma-separated list of directories to scan for assembly + references, or if no additional directories + should scanned. + - - The type of output for a given configuration. - + + The type of output for a given configuration. + - - A Makefile. - + + A Makefile. + - - Application (.exe). - + + Application (.exe). + - - Dynamic Library (.dll). - + + Dynamic Library (.dll). + - - Static Library (.lib). - + + Static Library (.lib). + - - Utility. - + + Utility. + @@ -3906,23 +3906,23 @@ - - Gets a value indicating whether the reference is managed for the - specified configuration. - - The build configuration of the reference. - - if the reference is managed for the - specified configuration; otherwise, . - + + Gets a value indicating whether the reference is managed for the + specified configuration. + + The build configuration of the reference. + + if the reference is managed for the + specified configuration; otherwise, . + - - Gets the name of the referenced assembly. - - - The name of the referenced assembly. - + + Gets the name of the referenced assembly. + + + The name of the referenced assembly. + @@ -3935,25 +3935,25 @@ - - Gets the path of the wrapper assembly. - - - The path of the wrapper assembly. - - - The wrapper assembly is stored in the object directory of the - project. - + + Gets the path of the wrapper assembly. + + + The path of the wrapper assembly. + + + The wrapper assembly is stored in the object directory of the + project. + - - Gets the path of the Primary Interop Assembly. - - - The path of the Primary Interop Assembly, or - if not available. - + + Gets the path of the Primary Interop Assembly. + + + The path of the Primary Interop Assembly, or + if not available. + @@ -3966,21 +3966,21 @@ The definition of the reference does not contain a "ControlVersion" attribute. - - Gets the GUID of the type library as defined in the definition - of the reference. - - - The GUID of the type library. - + + Gets the GUID of the type library as defined in the definition + of the reference. + + + The GUID of the type library. + - - Gets the locale of the type library in hex notation. - - - The locale of the type library. - + + Gets the locale of the type library in hex notation. + + + The locale of the type library. + diff --git a/Tools/nant/bin/NAnt.VisualCppTasks.dll b/Tools/nant/bin/NAnt.VisualCppTasks.dll index 3a2e696..4f6c39c 100755 Binary files a/Tools/nant/bin/NAnt.VisualCppTasks.dll and b/Tools/nant/bin/NAnt.VisualCppTasks.dll differ diff --git a/Tools/nant/bin/NAnt.VisualCppTasks.xml b/Tools/nant/bin/NAnt.VisualCppTasks.xml index 876d46d..95a9075 100755 --- a/Tools/nant/bin/NAnt.VisualCppTasks.xml +++ b/Tools/nant/bin/NAnt.VisualCppTasks.xml @@ -5,24 +5,24 @@ - - Compiles C/C++ programs using cl.exe, Microsoft's C/C++ compiler. - - - This task is intended for version 13.00.9466 of cl.exe. - - - Compiles helloworld.cpp for the Common Language Runtime. - - - - - - - ]]> - - + + Compiles C/C++ programs using cl.exe, Microsoft's C/C++ compiler. + + + This task is intended for version 13.00.9466 of cl.exe. + + + Compiles helloworld.cpp for the Common Language Runtime. + + + + + + + ]]> + + @@ -30,77 +30,77 @@ - - Compiles the sources. - + + Compiles the sources. + - - Determines if the sources need to be compiled. - + + Determines if the sources need to be compiled. + - - Determines whether the precompiled header file is up-to-date. - - - if no precompiled header file was specified; - otherwise, . - - - In order to determine accurately whether the precompile header file - is up-to-date, we'd need scan all the header files that are pulled - in. As this is not implemented right now, its safer to always - recompile. - + + Determines whether the precompiled header file is up-to-date. + + + if no precompiled header file was specified; + otherwise, . + + + In order to determine accurately whether the precompile header file + is up-to-date, we'd need scan all the header files that are pulled + in. As this is not implemented right now, its safer to always + recompile. + - - Determines whether any file that are includes in the specified - source file has been updated after the obj was compiled. - - The source file to check. - The last write time of the compiled obj. - - The full path to the include file that was modified after the obj - was compiled, or if no include files were - modified since the obj was compiled. - - - - To determine what includes are defined in a source file, conditional - directives are not honored. - - - If a given include cannot be resolved to an existing file, then - it will be considered stable. - - + + Determines whether any file that are includes in the specified + source file has been updated after the obj was compiled. + + The source file to check. + The last write time of the compiled obj. + + The full path to the include file that was modified after the obj + was compiled, or if no include files were + modified since the obj was compiled. + + + + To determine what includes are defined in a source file, conditional + directives are not honored. + + + If a given include cannot be resolved to an existing file, then + it will be considered stable. + + - - Quotes an argument value and duplicates trailing backslahes. - - The argument value to quote. - - The quotes argument value. - + + Quotes an argument value and duplicates trailing backslahes. + + The argument value to quote. + + The quotes argument value. + - - Determines the file name of the OBJ file for the specified source - file. - - The source file for which the OBJ file should be determined. - The path of the object file. - - The file name of the OBJ file for the specified source file. - + + Determines the file name of the OBJ file for the specified source + file. + + The source file for which the OBJ file should be determined. + The path of the object file. + + The file name of the OBJ file for the specified source file. + - - Directory where all output files are placed. - + + Directory where all output files are placed. + @@ -123,244 +123,244 @@ - - Specifies whether Managed Extensions for C++ should be enabled. - The default is . - + + Specifies whether Managed Extensions for C++ should be enabled. + The default is . + - - Tells the compiler to use the specified character set. - + + Tells the compiler to use the specified character set. + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - The list of files to compile. - + + The list of files to compile. + - - The list of directories in which to search for include files. - + + The list of directories in which to search for include files. + - - Directories that the compiler will search to resolve file references - passed to the #using directive. - + + Directories that the compiler will search to resolve file references + passed to the #using directive. + - - Specifies metadata files to reference in this compilation as an - alternative to passing a file name to #using in source code. - + + Specifies metadata files to reference in this compilation as an + alternative to passing a file name to #using in source code. + - - Macro definitions to pass to cl.exe. - Each entry will generate a /D - + + Macro definitions to pass to cl.exe. + Each entry will generate a /D + - - Macro undefines (/U) to pass to cl.exe. - + + Macro undefines (/U) to pass to cl.exe. + - - A name to override the default object file name; can be either a file - or directory name. The default is the output directory. - + + A name to override the default object file name; can be either a file + or directory name. The default is the output directory. + - - A name for the compiler-generated PDB file; can be either a file or - directory name. The default is the output directory. - + + A name for the compiler-generated PDB file; can be either a file or + directory name. The default is the output directory. + - - Gets the filename of the external program to start. - - The filename of the external program. + + Gets the filename of the external program to start. + + The filename of the external program. - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Defines the supported modes for the use of precompiled header files. - + + Defines the supported modes for the use of precompiled header files. + - - Create a precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yc. - + + Create a precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yc. + - - Automatically create a precompiled header file if necessary. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /YX. - + + Automatically create a precompiled header file if necessary. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /YX. + - - Use a (previously generated) precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yu. - + + Use a (previously generated) precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yu. + - - Run lib.exe, Microsoft's Library Manager. - - - Create a library. - - - - - - - ]]> - - + + Run lib.exe, Microsoft's Library Manager. + + + Create a library. + + + + + + + ]]> + + - - Creates the library. - + + Creates the library. + - - Determines if the sources need to be linked. - + + Determines if the sources need to be linked. + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - The output file. - + + The output file. + - - The module definition file. - + + The module definition file. + - - The list of files to combine into the output file. - + + The list of files to combine into the output file. + - - Symbols to add to the symbol table. - + + Symbols to add to the symbol table. + - - Names of default libraries to ignore. - + + Names of default libraries to ignore. + - - The list of additional library directories to search. - + + The list of additional library directories to search. + - - Gets the filename of the external program to start. - - The filename of the external program. + + Gets the filename of the external program to start. + + The filename of the external program. - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Links files using link.exe, Microsoft's Incremental Linker. - - - This task is intended for version 7.00.9466 of link.exe. - - - - Combine all object files in the current directory into helloworld.exe. - - - - - - - - ]]> - - + + Links files using link.exe, Microsoft's Incremental Linker. + + + This task is intended for version 7.00.9466 of link.exe. + + + + Combine all object files in the current directory into helloworld.exe. + + + + + + + + ]]> + + - - Links the sources. - + + Links the sources. + - - Determines if the output needs linking. - + + Determines if the output needs linking. + - - Quotes an argument value and duplicates trailing backslahes. - - The argument value to quote. - - The quotes argument value. - + + Quotes an argument value and duplicates trailing backslahes. + + The argument value to quote. + + The quotes argument value. + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - Create debugging information for the .exe file or DLL. The default is - . - + + Create debugging information for the .exe file or DLL. The default is + . + - - The output file. - + + The output file. + @@ -370,237 +370,237 @@ - - The name of a module-definition file (.def) to be passed to the - linker. - + + The name of a module-definition file (.def) to be passed to the + linker. + - - Specified DLLs for delay loading. - + + Specified DLLs for delay loading. + - - The list of files to combine into the output file. - + + The list of files to combine into the output file. + - - The list of additional library directories to search. - + + The list of additional library directories to search. + - - Link the specified modules into this assembly. - + + Link the specified modules into this assembly. + - - Embed the specified resources into this assembly. - + + Embed the specified resources into this assembly. + - - Symbols to add to the symbol table. - + + Symbols to add to the symbol table. + - - Names of libraries that you want the linker to ignore when it - resolves external references. - + + Names of libraries that you want the linker to ignore when it + resolves external references. + - - Gets the filename of the external program to start. - - The filename of the external program. + + Gets the filename of the external program to start. + + The filename of the external program. - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Compiles messages using mc.exe, Microsoft's Win32 message compiler. - - - - Compile text.mc using the default options. - - - - ]]> - - - Compile text.mc, passing a path to store the header, the rc - file and some additonal options. - - - - ]]> - - + + Compiles messages using mc.exe, Microsoft's Win32 message compiler. + + + + Compile text.mc using the default options. + + + + ]]> + + + Compile text.mc, passing a path to store the header, the rc + file and some additonal options. + + + + ]]> + + - - Compiles the sources. - + + Compiles the sources. + - - Determine if source files need re-building. - + + Determine if source files need re-building. + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - Path to store header file. The default is the project base directory. - + + Path to store header file. The default is the project base directory. + - - Path to store RC file. The default is the project base directory. - + + Path to store RC file. The default is the project base directory. + - - Input filename. - + + Input filename. + - - Gets the filename of the external program to start. - - - The filename of the external program. - + + Gets the filename of the external program to start. + + + The filename of the external program. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - This tasks allows you to run MIDL.exe. - - - - This task only supports a small subset of the MIDL.EXE command line - switches, but you can use the options element to specify any other - unsupported commands you want to specify. - - - - - - - - - - - - - ]]> - - + + This tasks allows you to run MIDL.exe. + + + + This task only supports a small subset of the MIDL.EXE command line + switches, but you can use the options element to specify any other + unsupported commands you want to specify. + + + + + + + + + + + + + ]]> + + - - This is where the work is done. - + + This is where the work is done. + - - Check output files to see if we need rebuilding. - - if a rebuild is needed; otherwise, - . + + Check output files to see if we need rebuilding. + + if a rebuild is needed; otherwise, + . - - Check output files to see if we need rebuilding. - - - if a rebuild is needed; otherwise, - . - + + Check output files to see if we need rebuilding. + + + if a rebuild is needed; otherwise, + . + - - Writes the response file for midl.exe. - + + Writes the response file for midl.exe. + - - The /acf switch allows the user to supply an - explicit ACF file name. The switch also - allows the use of different interface names in - the IDL and ACF files. - + + The /acf switch allows the user to supply an + explicit ACF file name. The switch also + allows the use of different interface names in + the IDL and ACF files. + - - The /align switch is functionally the same as the - MIDL /Zp option and is recognized by the MIDL compiler - solely for backward compatibility with MkTypLib. - - The alignment value can be 1, 2, 4, or 8. + + The /align switch is functionally the same as the + MIDL /Zp option and is recognized by the MIDL compiler + solely for backward compatibility with MkTypLib. + + The alignment value can be 1, 2, 4, or 8. - - The /app_config switch selects application-configuration - mode, which allows you to use some ACF keywords in the - IDL file. With this MIDL compiler switch, you can omit - the ACF and specify an interface in a single IDL file. - + + The /app_config switch selects application-configuration + mode, which allows you to use some ACF keywords in the + IDL file. With this MIDL compiler switch, you can omit + the ACF and specify an interface in a single IDL file. + - - The /char switch helps to ensure that the MIDL compiler - and C compiler operate together correctly for all char - and small types. - - Can be one of signed | unsigned | ascii7 + + The /char switch helps to ensure that the MIDL compiler + and C compiler operate together correctly for all char + and small types. + + Can be one of signed | unsigned | ascii7 - - The /client switch directs the MIDL compiler to generate - client-side C source files for an RPC interface - - can be one of stub | none + + The /client switch directs the MIDL compiler to generate + client-side C source files for an RPC interface + + can be one of stub | none - - The /cstub switch specifies the name of the client - stub file for an RPC interface. - + + The /cstub switch specifies the name of the client + stub file for an RPC interface. + @@ -610,198 +610,198 @@ - - The /env switch selects the - environment in which the application runs. - - It can take the values win32 and win64 + + The /env switch selects the + environment in which the application runs. + + It can take the values win32 and win64 - - The /Oi switch directs the MIDL compiler to - use a fully-interpreted marshaling method. - The /Oic and /Oicf switches provide additional - performance enhancements. - - - If you specify the Oi attribute, you must set it to - one of the values: - - Oi="" - - Oi="c" - - Oi="f" - - Oi="cf" - + + The /Oi switch directs the MIDL compiler to + use a fully-interpreted marshaling method. + The /Oic and /Oicf switches provide additional + performance enhancements. + + + If you specify the Oi attribute, you must set it to + one of the values: + - Oi="" + - Oi="c" + - Oi="f" + - Oi="cf" + - - Specifies a file name for the type library generated by the MIDL - compiler. - + + Specifies a file name for the type library generated by the MIDL + compiler. + - - Specifies the name of the header file. - + + Specifies the name of the header file. + - - Specifies the name of the interface identifier file for a COM - interface, overriding the default name obtained by adding _i.c - to the IDL file name. - + + Specifies the name of the interface identifier file for a COM + interface, overriding the default name obtained by adding _i.c + to the IDL file name. + - - Specifies the name of the interface proxy file for a COM interface. - + + Specifies the name of the interface proxy file for a COM interface. + - - Name of .IDL file to process. - + + Name of .IDL file to process. + - - Additional options to pass to midl.exe. - + + Additional options to pass to midl.exe. + - - Macro definitions to pass to mdil.exe. - Each entry will generate a /D - + + Macro definitions to pass to mdil.exe. + Each entry will generate a /D + - - Macro undefines (/U) to pass to mdil. - + + Macro undefines (/U) to pass to mdil. + - - The list of directories in which to search for include files. - + + The list of directories in which to search for include files. + - - Filename of program to execute - + + Filename of program to execute + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Compiles resources using rc.exe, Microsoft's Win32 resource - compiler. - - - - Compile text.rc to text.res using the default options. - - - - ]]> - - - - - Compile text.rc, passing an additional option. - - - - ]]> - - + + Compiles resources using rc.exe, Microsoft's Win32 resource + compiler. + + + + Compile text.rc to text.res using the default options. + + + + ]]> + + + + + Compile text.rc, passing an additional option. + + + + ]]> + + - - Compile the resource file - + + Compile the resource file + - - Determines if the resource need compiling. - + + Determines if the resource need compiling. + - - Check if a resource file has been updated. - - - + + Check if a resource file has been updated. + + + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - Output file. - + + Output file. + - - The resource file to compile. - + + The resource file to compile. + - - Default language ID. - + + Default language ID. + - - The list of directories in which to search for include files. - + + The list of directories in which to search for include files. + - - Macro definitions to pass to rc.exe. - Each entry will generate a /d - + + Macro definitions to pass to rc.exe. + Each entry will generate a /d + - - Filename of program to execute - + + Filename of program to execute + - - Arguments of program to execute - + + Arguments of program to execute + - - Defines the character sets that can be used by the C++ compiler. - + + Defines the character sets that can be used by the C++ compiler. + - - Have the compiler determine the character set. - + + Have the compiler determine the character set. + - - Unicode character set. - + + Unicode character set. + - - Multi-byte character set. - + + Multi-byte character set. + - - Represents a library. - + + Represents a library. + @@ -816,21 +816,21 @@ is . - - The name of the library. - + + The name of the library. + - - If then the element will be processed; - otherwise, skipped. The default is . - + + If then the element will be processed; + otherwise, skipped. The default is . + - - If then the element will be skipped; - otherwise, processed. The default is . - + + If then the element will be skipped; + otherwise, processed. The default is . + @@ -884,11 +884,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -921,10 +921,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -939,33 +939,33 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Represents a symbol. - + + Represents a symbol. + @@ -980,21 +980,21 @@ is . - - The name of the symbol. - + + The name of the symbol. + - - If then the element will be processed; - otherwise, skipped. The default is . - + + If then the element will be processed; + otherwise, skipped. The default is . + - - If then the element will be skipped; - otherwise, processed. The default is . - + + If then the element will be skipped; + otherwise, processed. The default is . + @@ -1048,11 +1048,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -1085,10 +1085,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -1103,55 +1103,55 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Defines how to deal with backslashes in values of command line - arguments. - + + Defines how to deal with backslashes in values of command line + arguments. + - - Does not perform any processing on backslashes. - + + Does not perform any processing on backslashes. + - - Duplicates the trailing backslash. - + + Duplicates the trailing backslash. + - - Fixes the trailing backslash by replaces trailing double backslashes - with only one backslash and removing single trailing backslashes. - + + Fixes the trailing backslash by replaces trailing double backslashes + with only one backslash and removing single trailing backslashes. + - - Removes all the trailing backslashes. - + + Removes all the trailing backslashes. + @@ -1172,29 +1172,29 @@ - - Duplicates the trailing backslash. - - The input string to check and duplicate the trailing backslash if necessary. - The result string after being processed. - - Also duplicates trailing backslash in quoted value. - + + Duplicates the trailing backslash. + + The input string to check and duplicate the trailing backslash if necessary. + The result string after being processed. + + Also duplicates trailing backslash in quoted value. + - - Fixes the trailing backslash. This function replaces the trailing double backslashes with - only one backslash. It also, removes the single trailing backslash. - - The input string. - The result string after being processed. + + Fixes the trailing backslash. This function replaces the trailing double backslashes with + only one backslash. It also, removes the single trailing backslash. + + The input string. + The result string after being processed. - - Removes all the trailing backslashes from the input. - - The input string. - The result string without trailing backslashes. + + Removes all the trailing backslashes from the input. + + The input string. + The result string without trailing backslashes. diff --git a/Tools/nant/bin/NAnt.Win32Tasks.dll b/Tools/nant/bin/NAnt.Win32Tasks.dll index ab2bfa7..80ec5c1 100755 Binary files a/Tools/nant/bin/NAnt.Win32Tasks.dll and b/Tools/nant/bin/NAnt.Win32Tasks.dll differ diff --git a/Tools/nant/bin/NAnt.Win32Tasks.xml b/Tools/nant/bin/NAnt.Win32Tasks.xml index 0fb6349..1478bd8 100755 --- a/Tools/nant/bin/NAnt.Win32Tasks.xml +++ b/Tools/nant/bin/NAnt.Win32Tasks.xml @@ -5,15 +5,15 @@ - - Groups a set of functions that convert Windows native filenames to - Cygwin POSIX-style pathnames and vice versa. - - - It can be used when a Cygwin program needs to pass a file name to a - native Windows program, or expects to get a file name from a native - Windows program. - + + Groups a set of functions that convert Windows native filenames to + Cygwin POSIX-style pathnames and vice versa. + + + It can be used when a Cygwin program needs to pass a file name to a + native Windows program, or expects to get a file name from a native + Windows program. + @@ -67,128 +67,128 @@ - - Factory method to return a new instance of ExecTask - - - + + Factory method to return a new instance of ExecTask + + + - - Generates a Windows Forms Control that wraps ActiveX Controls defined - in an OCX. - - - - - ]]> - - + + Generates a Windows Forms Control that wraps ActiveX Controls defined + in an OCX. + + + + + ]]> + + - - Import the ActiveX control. - + + Import the ActiveX control. + - - Determines whether the assembly needs to be created again. - - - if the assembly needs to be created again; - otherwise, . - + + Determines whether the assembly needs to be created again. + + + if the assembly needs to be created again; + otherwise, . + - - Filename of the .ocx file. - + + Filename of the .ocx file. + - - Filename of the generated assembly. - + + Filename of the generated assembly. + - - Specifies the file containing the public key to use to sign the - resulting assembly. - - - The file containing the public key to use to sign the resulting - assembly. - + + Specifies the file containing the public key to use to sign the + resulting assembly. + + + The file containing the public key to use to sign the resulting + assembly. + - - Specifies the publisher's official public/private key pair with which - the resulting assembly should be signed with a strong name. - - - The keyfile to use to sign the resulting assembly with a strong name. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the publisher's official public/private key pair with which + the resulting assembly should be signed with a strong name. + + + The keyfile to use to sign the resulting assembly with a strong name. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the key container in which the public/private key pair - should be found that should be used to sign the resulting assembly - with a strong name. - - - The key container containing a public/private key pair that should - be used to sign the resulting assembly. - + + Specifies the key container in which the public/private key pair + should be found that should be used to sign the resulting assembly + with a strong name. + + + The key container containing a public/private key pair that should + be used to sign the resulting assembly. + - - Specifies to sign the resulting control using delayed signing. - + + Specifies to sign the resulting control using delayed signing. + - - Determines whether C# source code for the Windows Form wrapper should - be generated. The default is . - + + Determines whether C# source code for the Windows Form wrapper should + be generated. The default is . + - - Assembly to use for Runtime Callable Wrapper rather than generating - new one [.NET 1.1 or higher]. - + + Assembly to use for Runtime Callable Wrapper rather than generating + new one [.NET 1.1 or higher]. + - - Indicates whether aximp supports using an existing Runtime - Callable Wrapper for a given target framework. The default is - . - + + Indicates whether aximp supports using an existing Runtime + Callable Wrapper for a given target framework. The default is + . + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Reads the most recent Windows SDK InstallationFolder key into a NAnt property - - - - - ]]> - - + + Reads the most recent Windows SDK InstallationFolder key into a NAnt property + + + + + ]]> + + - - locate the most recent WinSDK installed - + + locate the most recent WinSDK installed + @@ -202,153 +202,153 @@ - - - The property to set to the value stored in the InstalledFolder key of the located WinSDK version. - - + + + The property to set to the value stored in the InstalledFolder key of the located WinSDK version. + + - - - The minimum acceptable Windows SDK version. - - + + + The minimum acceptable Windows SDK version. + + - - - The maximum acceptable Windows SDK version. - - + + + The maximum acceptable Windows SDK version. + + - - - The minimum acceptable .NET sdk version. - - + + + The minimum acceptable .NET sdk version. + + - - - The maximum acceptable .NET sdk version. - - + + + The maximum acceptable .NET sdk version. + + - - Reads the mono registry path into a NAnt property. - - - The mono registry keyes can exist in one of two places depending on the platform. This - task will check to see which registry path that Mono is using. - - - - - ]]> - - + + Reads the mono registry path into a NAnt property. + + + The mono registry keyes can exist in one of two places depending on the platform. This + task will check to see which registry path that Mono is using. + + + + + ]]> + + - - The Mono reg key to default to if none of the keys in _regKeys are found - in the running machine. - + + The Mono reg key to default to if none of the keys in _regKeys are found + in the running machine. + - - Private property name to assign the Mono registry path to. - + + Private property name to assign the Mono registry path to. + - - Private array of Mono registry paths to test in order. - - - If new registry paths are used by the Mono team, add them to this array. - + + Private array of Mono registry paths to test in order. + + + If new registry paths are used by the Mono team, add them to this array. + - - Locates the appropriate Mono registry path to use. - + + Locates the appropriate Mono registry path to use. + - - - The property to set to the Mono registry path. - - + + + The property to set to the Mono registry path. + + - - Reads a value or set of values from the Windows Registry into one or - more NAnt properties. - - - Read a single value from the registry. - - - ]]> - - Read all the registry values in a key. - - - ]]> - - + + Reads a value or set of values from the Windows Registry into one or + more NAnt properties. + + + Read a single value from the registry. + + + ]]> + + Read all the registry values in a key. + + + ]]> + + - - read the specified registry value - + + read the specified registry value + - - Returns the hive for a given key. - - - - - The hive for a given key. - + + Returns the hive for a given key. + + + + + The hive for a given key. + - - Returns the key for a given registry hive. - - The registry hive to return the key for. - - The key for a given registry hive. - + + Returns the key for a given registry hive. + + The registry hive to return the key for. + + The key for a given registry hive. + - - The property to set to the specified registry key value. - If this attribute is used then a single value will be read. - + + The property to set to the specified registry key value. + If this attribute is used then a single value will be read. + - - The prefix to use for the specified registry key values. - If this attribute is used then all registry values will be read and stored as properties with this prefix. - - - Registry values a, b, c will be turned into prefixa, prefixb, prefixc named properties - + + The prefix to use for the specified registry key values. + If this attribute is used then all registry values will be read and stored as properties with this prefix. + + + Registry values a, b, c will be turned into prefixa, prefixb, prefixc named properties + - - The registry key to read, including the path. - - - SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot - + + The registry key to read, including the path. + + + SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot + @@ -361,55 +361,55 @@ - - Registers an assembly, or set of assemblies for use from COM clients. - - - - Refer to the Regasm - documentation for more information on the regasm tool. - - - - - Register types in a single assembly. - - - - ]]> - - - - - Register types of an assembly and generate a type library containing - definitions of accessible types defined within the assembly. - - - - ]]> - - - - - Register types of set of assemblies at once, while specifying a set - of reference assemblies. - - - - - - - - - - - - ]]> - - + + Registers an assembly, or set of assemblies for use from COM clients. + + + + Refer to the Regasm + documentation for more information on the regasm tool. + + + + + Register types in a single assembly. + + + + ]]> + + + + + Register types of an assembly and generate a type library containing + definitions of accessible types defined within the assembly. + + + + ]]> + + + + + Register types of set of assemblies at once, while specifying a set + of reference assemblies. + + + + + + + + + + + + ]]> + + @@ -419,9 +419,9 @@ The of which the should be updated. - - Registers or unregisters a single assembly, or a group of assemblies. - + + Registers or unregisters a single assembly, or a group of assemblies. + @@ -430,371 +430,371 @@ - - Registry file to export to instead of entering the types directly - into the registry. - + + Registry file to export to instead of entering the types directly + into the registry. + - - Set the code base registry setting. - + + Set the code base registry setting. + - - Only refer to already registered type libraries. - + + Only refer to already registered type libraries. + - - Export the assemblies to the specified type library and register it. - + + Export the assemblies to the specified type library and register it. + - - Unregister the assembly. The default is . - + + Unregister the assembly. The default is . + - - The set of assemblies to register, or unregister. - + + The set of assemblies to register, or unregister. + - - The set of assembly references. - + + The set of assembly references. + - - Gets the working directory for the application. - - - The working directory for the application. - + + Gets the working directory for the application. + + + The working directory for the application. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Gets the filename of the external program to start. - - - The filename of the external program. - - - Override in derived classes to explicitly set the location of the - external tool. - + + Gets the filename of the external program to start. + + + The filename of the external program. + + + Override in derived classes to explicitly set the location of the + external tool. + - - Exports a .NET assembly to a type library that can be used from unmanaged - code (wraps Microsoft's tlbexp.exe). - - - - See the Microsoft.NET Framework SDK documentation for details. - - - - Export DotNetAssembly.dll to LegacyCOM.dll. - - - ]]> - - + + Exports a .NET assembly to a type library that can be used from unmanaged + code (wraps Microsoft's tlbexp.exe). + + + + See the Microsoft.NET Framework SDK documentation for details. + + + + Export DotNetAssembly.dll to LegacyCOM.dll. + + + ]]> + + - - Exports the type library. - + + Exports the type library. + - - Determines whether the assembly needs to be exported to a type - library again. - - - if the assembly needs to be exported to a - type library; otherwise, . - + + Determines whether the assembly needs to be exported to a type + library again. + + + if the assembly needs to be exported to a + type library; otherwise, . + - - Specifies the assembly for which to export a type library. - - - The assembly for which to export a type library. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the assembly for which to export a type library. + + + The assembly for which to export a type library. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the name of the type library file to generate. - - - The name of the type library file to generate. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the name of the type library file to generate. + + + The name of the type library file to generate. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the file used to determine capitalization of names in a - type library. - - - The file used to determine capitalization of names in a type library. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the file used to determine capitalization of names in a + type library. + + + The file used to determine capitalization of names in a type library. + + See the Microsoft.NET Framework SDK documentation for details. - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Imports a type library to a .NET assembly (wraps Microsoft's tlbimp.exe). - - - - This task lets you easily create interop assemblies. By default, it will - not reimport if the underlying COM TypeLib or reference has not changed. - - - See the Microsoft.NET Framework SDK documentation for details. - - - - Import LegacyCOM.dll to DotNetAssembly.dll. - - - ]]> - - - - - Generate an assembly named "Interop.MSVidCtlLib.dll" for the - MS Video Control 1.0 Type Library, transforming any [out, retval] - parameters of methods on dispinterfaces in the type library into - return values in the managed library. - - - - - - - - ]]> - - + + Imports a type library to a .NET assembly (wraps Microsoft's tlbimp.exe). + + + + This task lets you easily create interop assemblies. By default, it will + not reimport if the underlying COM TypeLib or reference has not changed. + + + See the Microsoft.NET Framework SDK documentation for details. + + + + Import LegacyCOM.dll to DotNetAssembly.dll. + + + ]]> + + + + + Generate an assembly named "Interop.MSVidCtlLib.dll" for the + MS Video Control 1.0 Type Library, transforming any [out, retval] + parameters of methods on dispinterfaces in the type library into + return values in the managed library. + + + + + + + + ]]> + + - - Imports the type library to a .NET assembly. - + + Imports the type library to a .NET assembly. + - - Returns the path of the type library, removing the identifier of - the type library from the specified string. - - The path from which to extract the path of the type library. - - The path of the type library without the type library identifier. - - - An example of a path which includes the identifier of the type - library (in this case "2") is - C:\WINDOWS\system32\msvidctl.dll\2. - + + Returns the path of the type library, removing the identifier of + the type library from the specified string. + + The path from which to extract the path of the type library. + + The path of the type library without the type library identifier. + + + An example of a path which includes the identifier of the type + library (in this case "2") is + C:\WINDOWS\system32\msvidctl.dll\2. + - - Determines whether the type library needs to be imported again. - - - if the type library needs to be imported; - otherwise, . - + + Determines whether the type library needs to be imported again. + + + if the type library needs to be imported; + otherwise, . + - - Specifies the name of the output file. - - - The name of the output file. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the name of the output file. + + + The name of the output file. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the namespace in which to produce the assembly. - - - The namespace in which to produce the assembly. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the namespace in which to produce the assembly. + + + The namespace in which to produce the assembly. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the version number of the assembly to produce. - - - - The version number of the assembly to produce. - - - The version number should be in the format major.minor.build.revision. - - - See the Microsoft.NET Framework SDK documentation for details. - - + + Specifies the version number of the assembly to produce. + + + + The version number of the assembly to produce. + + + The version number should be in the format major.minor.build.revision. + + + See the Microsoft.NET Framework SDK documentation for details. + + - - Specifies whether the resulting assembly should be signed with a - strong name using delayed signing. The default is . - - - if the resulting assembly should be signed - with a strong name using delayed signing; otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the resulting assembly should be signed with a + strong name using delayed signing. The default is . + + + if the resulting assembly should be signed + with a strong name using delayed signing; otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether a primary interop assembly should be produced for - the specified type library. The default is . - - - if a primary interop assembly should be - produced; otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether a primary interop assembly should be produced for + the specified type library. The default is . + + + if a primary interop assembly should be + produced; otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the file containing the public key to use to sign the - resulting assembly. - - - The file containing the public key to use to sign the resulting - assembly. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the file containing the public key to use to sign the + resulting assembly. + + + The file containing the public key to use to sign the resulting + assembly. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the publisher's official public/private key pair with which - the resulting assembly should be signed with a strong name. - - - The keyfile to use to sign the resulting assembly with a strong name. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the publisher's official public/private key pair with which + the resulting assembly should be signed with a strong name. + + + The keyfile to use to sign the resulting assembly with a strong name. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the key container in which the public/private key pair - should be found that should be used to sign the resulting assembly - with a strong name. - - - The key container containing a public/private key pair that should - be used to sign the resulting assembly. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the key container in which the public/private key pair + should be found that should be used to sign the resulting assembly + with a strong name. + + + The key container containing a public/private key pair that should + be used to sign the resulting assembly. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the assembly files to use to resolve references to types - defined outside the current type library. - - - The assembly files to use to resolve references to types defined - outside the current type library. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the assembly files to use to resolve references to types + defined outside the current type library. + + + The assembly files to use to resolve references to types defined + outside the current type library. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether a type library should not be imported if all - references within the current assembly or the reference assemblies - cannot be resolved. The default is . - - - if a type library should not be imported if - all references cannot be resolved; otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether a type library should not be imported if all + references within the current assembly or the reference assemblies + cannot be resolved. The default is . + + + if a type library should not be imported if + all references cannot be resolved; otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether to import a COM style SafeArray as a managed - class type. The default is . - - - if a COM style SafeArray should be imported - as a managed class type; otherwise, - . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether to import a COM style SafeArray as a managed + class type. The default is . + + + if a COM style SafeArray should be imported + as a managed class type; otherwise, + . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies how to transform the metadata [.NET 1.1 or higher]. - + + Specifies how to transform the metadata [.NET 1.1 or higher]. + - - Specifies the source type library that gets passed to the type - library importer. - - - The source type library that gets passed to the type library - importer. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the source type library that gets passed to the type + library importer. + + + The source type library that gets passed to the type library + importer. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether interfaces should be produced without .NET Framework - security checks. The default is . - - - if interfaces without .NET Framework security - checks should be produced; otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether interfaces should be produced without .NET Framework + security checks. The default is . + + + if interfaces without .NET Framework security + checks should be produced; otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Indicates whether tlbimp supports transforming metadata for - a given target framework. The default is . - + + Indicates whether tlbimp supports transforming metadata for + a given target framework. The default is . + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + diff --git a/Tools/nant/bin/NAnt.exe b/Tools/nant/bin/NAnt.exe index d72dfeb..55f9e29 100755 Binary files a/Tools/nant/bin/NAnt.exe and b/Tools/nant/bin/NAnt.exe differ diff --git a/Tools/nant/bin/NAnt.exe.config b/Tools/nant/bin/NAnt.exe.config index b6aed41..a3dc8ec 100755 --- a/Tools/nant/bin/NAnt.exe.config +++ b/Tools/nant/bin/NAnt.exe.config @@ -1300,14 +1300,14 @@ - - + + - - + + @@ -1370,6 +1370,126 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + true + true + true + true + true + true + true + true + + + true + true + true + true + true + true + true + true + true + + + true + + + true + true + true + true + + + true + true + + + sn + + + lc + true + + + - - - - diff --git a/Tools/nant/bin/NAnt.xml b/Tools/nant/bin/NAnt.xml index 64a0575..286dda1 100755 --- a/Tools/nant/bin/NAnt.xml +++ b/Tools/nant/bin/NAnt.xml @@ -11,47 +11,47 @@ - - Entry point for executable - - Command Line arguments - The result of the real execution + + Entry point for executable + + Command Line arguments + The result of the real execution - - Constructs the privatebinpath. - - - - For the common version dir, we do not use the framework version - as defined in the NAnt configuration file but the CLR version - since the assemblies in that directory are not specific to a - certain family and the framwork version might differ between - families (eg. mono 1.0 == .NET 1.1). - - - The runtime framework. - The base directory of the domain. - - The privatebinpath. - + + Constructs the privatebinpath. + + + + For the common version dir, we do not use the framework version + as defined in the NAnt configuration file but the CLR version + since the assemblies in that directory are not specific to a + certain family and the framwork version might differ between + families (eg. mono 1.0 == .NET 1.1). + + + The runtime framework. + The base directory of the domain. + + The privatebinpath. + - - Given an absolute directory and an absolute file name, returns a - relative file name. - - An absolute directory. - An absolute file name. - - A relative file name for the given absolute file name. - + + Given an absolute directory and an absolute file name, returns a + relative file name. + + An absolute directory. + An absolute file name. + + A relative file name for the given absolute file name. + - - Helper class for invoking the application entry point in NAnt.Core - and passing the command-line arguments. - + + Helper class for invoking the application entry point in NAnt.Core + and passing the command-line arguments. + @@ -62,17 +62,17 @@ Directories relative to the base directory of the AppDomain to probe for missing assembly references. - - Invokes the application entry point in NAnt.Core. - + + Invokes the application entry point in NAnt.Core. + - - Gets the status that the build process returned when it exited. - - - The code that the build process specified when it terminated. - + + Gets the status that the build process returned when it exited. + + + The code that the build process specified when it terminated. + diff --git a/Tools/nant/bin/NDoc.Documenter.NAnt.dll b/Tools/nant/bin/NDoc.Documenter.NAnt.dll index d9dcccb..e646883 100755 Binary files a/Tools/nant/bin/NDoc.Documenter.NAnt.dll and b/Tools/nant/bin/NDoc.Documenter.NAnt.dll differ diff --git a/Tools/nant/bin/lib/net/1.0/nunit.core.dll b/Tools/nant/bin/lib/net/1.0/nunit.core.dll deleted file mode 100755 index 7b1916e..0000000 Binary files a/Tools/nant/bin/lib/net/1.0/nunit.core.dll and /dev/null differ diff --git a/Tools/nant/bin/lib/net/1.0/nunit.framework.dll b/Tools/nant/bin/lib/net/1.0/nunit.framework.dll deleted file mode 100755 index 6038b27..0000000 Binary files a/Tools/nant/bin/lib/net/1.0/nunit.framework.dll and /dev/null differ diff --git a/Tools/nant/bin/lib/net/1.0/nunit.util.dll b/Tools/nant/bin/lib/net/1.0/nunit.util.dll deleted file mode 100755 index a778921..0000000 Binary files a/Tools/nant/bin/lib/net/1.0/nunit.util.dll and /dev/null differ diff --git a/Tools/nant/contrib/Interop.StarTeam.dll b/Tools/nant/contrib/Interop.StarTeam.dll new file mode 100644 index 0000000..6f56767 Binary files /dev/null and b/Tools/nant/contrib/Interop.StarTeam.dll differ diff --git a/Tools/nant/contrib/Interop.WindowsInstaller.dll b/Tools/nant/contrib/Interop.WindowsInstaller.dll new file mode 100644 index 0000000..d669720 Binary files /dev/null and b/Tools/nant/contrib/Interop.WindowsInstaller.dll differ diff --git a/Tools/nant/contrib/NAnt.Contrib.Tasks.dll b/Tools/nant/contrib/NAnt.Contrib.Tasks.dll index aa84cc8..a4ccd72 100644 Binary files a/Tools/nant/contrib/NAnt.Contrib.Tasks.dll and b/Tools/nant/contrib/NAnt.Contrib.Tasks.dll differ diff --git a/Tools/nant/contrib/NAnt.Contrib.Tasks.xml b/Tools/nant/contrib/NAnt.Contrib.Tasks.xml index c877adb..0cfc5e6 100644 --- a/Tools/nant/contrib/NAnt.Contrib.Tasks.xml +++ b/Tools/nant/contrib/NAnt.Contrib.Tasks.xml @@ -4,10 +4,80 @@ NAnt.Contrib.Tasks + + + Provides a set of functions that deals with Arrays. + + + + + Initializes a new instance of the + class. + + + Project. + + + Properties. + + + + + Sorts the items in an array. + + + The containing all the array items to sort. + + + The used to separate the items in + + + + The is invalid because it + is empty or . + + + + + Reverse the items in an array. + + + The containing all the array items to reverse. + + + The used to separate the items in + + + + The is invalid because it + is empty or . + + + + + Converts a variable to + an based on a value separator. + + + The value of in an + format. + + + The to parse to an . + + + The used to separate the items in + + + + The is invalid because it + is empty or . + + - - Groups a set of functions for dealing with files. - + + Groups a set of functions for dealing with files. + @@ -43,9 +113,9 @@ - - Provides methods for interrogating Filesets. - + + Provides methods for interrogating Filesets. + @@ -115,10 +185,10 @@ - - Allows information on Windows Installer databases and products to be - retrieved. - + + Allows information on Windows Installer databases and products to be + retrieved. + @@ -154,32 +224,32 @@ - - Returns a value indicating whether a product with the specified - product code is installed. - - The product code of the product to check. - - if a product with the specified product - code is installed; otherwise, . - - - - Retrieves the product code of a given installer database, and - fails the build if the product is not installed. - - - - Please install Office first. - ]]> - - + + Returns a value indicating whether a product with the specified + product code is installed. + + The product code of the product to check. + + if a product with the specified product + code is installed; otherwise, . + + + + Retrieves the product code of a given installer database, and + fails the build if the product is not installed. + + + + Please install Office first. + ]]> + + - - Allow information on a Windows service to be retrieved. - + + Allow information on a Windows service to be retrieved. + @@ -311,43 +381,43 @@ - - Gets the friendly name of the specified service. - - The short name that identifies the service to the system. - The computer on which the service resides. - - The friendly name of the service, which can be used to identify the service. - + + Gets the friendly name of the specified service. + + The short name that identifies the service to the system. + The computer on which the service resides. + + The friendly name of the service, which can be used to identify the service. + - - Gets the name that identifies the specified service - - The short name that identifies the service to the system. - The computer on which the service resides. - - The name that identifies the service. - + + Gets the name that identifies the specified service + + The short name that identifies the service to the system. + The computer on which the service resides. + + The name that identifies the service. + - - The name of the management SQL database. - + + The name of the management SQL database. + - - The name of the SQL Server where the management database is - located. - + + The name of the SQL Server where the management database is + located. + - - Deploys an assembly to a given BizTalk configuration database. - - - Deployment will fail if the assembly is already deployed. - + + Deploys an assembly to a given BizTalk configuration database. + + + Deployment will fail if the assembly is already deployed. + @@ -362,32 +432,32 @@ - - The path to the BizTalk assembly to deploy. - + + The path to the BizTalk assembly to deploy. + - - Determines whether to install the assembly in the Global Assembly - Cache. The default is . - + + Determines whether to install the assembly in the Global Assembly + Cache. The default is . + - - The path to an assembly binding information file to import bindings - from. - + + The path to an assembly binding information file to import bindings + from. + - - The path to the HTML log file to generate. - + + The path to the HTML log file to generate. + - - Exports bindings for a BizTalk assembly to an assembly binding - information file. - + + Exports bindings for a BizTalk assembly to an assembly binding + information file. + @@ -400,88 +470,88 @@ - - The path to the BizTalk assembly for which to export bindings. - + + The path to the BizTalk assembly for which to export bindings. + - - The path to an assembly binding information file in which the - bindings will be saved. - + + The path to an assembly binding information file in which the + bindings will be saved. + - - The path to the HTML log file to generate. - + + The path to the HTML log file to generate. + - - Allows BizTalk (in-process) host instances to be controlled. - - - - Starts the "BizTalkServerApplication" host instance - on server "SV-ARD-EAI". - - - - ]]> - - - - - Stops all "BizTalkServerApplication" host instances. - - - - ]]> - - + + Allows BizTalk (in-process) host instances to be controlled. + + + + Starts the "BizTalkServerApplication" host instance + on server "SV-ARD-EAI". + + + + ]]> + + + + + Stops all "BizTalkServerApplication" host instances. + + + + ]]> + + - - The name of the host on which the perform the action. - + + The name of the host on which the perform the action. + - - The name of the BizTalk server on which to perform the action. - If not specified, the action will be performed on all instances. - + + The name of the BizTalk server on which to perform the action. + If not specified, the action will be performed on all instances. + - - The action that should be performed on the host. - + + The action that should be performed on the host. + - - Defines the actions that can be performed on a host instance. - + + Defines the actions that can be performed on a host instance. + - - Starts the host instance. - + + Starts the host instance. + - - Stops the host instance. - + + Stops the host instance. + - - Stops and restarts the host instance. - + + Stops and restarts the host instance. + - - Imports bindings from a given assembly binding information file into - the specified BizTalk configuration database. - + + Imports bindings from a given assembly binding information file into + the specified BizTalk configuration database. + @@ -494,40 +564,40 @@ - - The path to the assembly binding information file containing the - bindings to import. - + + The path to the assembly binding information file containing the + bindings to import. + - - The path to the HTML log file to generate. - + + The path to the HTML log file to generate. + - - Performs a set of actions on a given orchestration. - + + Performs a set of actions on a given orchestration. + - - The name of the BizTalk server on which to perform the action. - + + The name of the BizTalk server on which to perform the action. + - - The name of the orchestration to perform an action on. - + + The name of the orchestration to perform an action on. + - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the project. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the project. + @@ -541,34 +611,34 @@ - - Starts the orchestration. - - - If the orchestration is not yet enlisted, then this will be done - first. - + + Starts the orchestration. + + + If the orchestration is not yet enlisted, then this will be done + first. + - - Specifies whether receive locations associated with this - orchestration should be automatically enabled. The default is - . - + + Specifies whether receive locations associated with this + orchestration should be automatically enabled. The default is + . + - - Specifies whether service instances of this orchestration that - were manually suspended previously should be automatically - resumed. The default is . - + + Specifies whether service instances of this orchestration that + were manually suspended previously should be automatically + resumed. The default is . + - - Specifies whether send ports and send port groups imported by - this orchestration should be automatically started. The default - is . - + + Specifies whether send ports and send port groups imported by + this orchestration should be automatically started. The default + is . + @@ -592,107 +662,107 @@ - - Specifies whether receive locations associated with this - orchestration should be automatically disabled. The default - is . - + + Specifies whether receive locations associated with this + orchestration should be automatically disabled. The default + is . + - - Specifies whether instances of this orchestration should be - automatically suspended. The default is . - + + Specifies whether instances of this orchestration should be + automatically suspended. The default is . + - - Enlists the orchestration by creating its activation subscription. - + + Enlists the orchestration by creating its activation subscription. + - - Specifies the BizTalk host on which to enlist the orchestration. - + + Specifies the BizTalk host on which to enlist the orchestration. + - - Unenlists the orchestration by removing its activation subscription. - + + Unenlists the orchestration by removing its activation subscription. + - - Specifies whether instances of this orchestration type should - be automatically terminated. The default is . - + + Specifies whether instances of this orchestration type should + be automatically terminated. The default is . + - - Allows BizTalk receive locations to be controlled. - - - - Enables the "HttpReceive" receive location on server - "SV-ARD-EAI". - - - - ]]> - - - - - Disables the "HttpReceive" receive location on server - "SV-ARD-EAI". - - - - ]]> - - + + Allows BizTalk receive locations to be controlled. + + + + Enables the "HttpReceive" receive location on server + "SV-ARD-EAI". + + + + ]]> + + + + + Disables the "HttpReceive" receive location on server + "SV-ARD-EAI". + + + + ]]> + + - - The name of the receive location on which the perform the action. - + + The name of the receive location on which the perform the action. + - - The name of the BizTalk server on which to perform the action. - + + The name of the BizTalk server on which to perform the action. + - - The action that should be performed on the receive location. - + + The action that should be performed on the receive location. + - - Defines the actions that can be performed on a BizTalk receive - location. - + + Defines the actions that can be performed on a BizTalk receive + location. + - - Enables the receive location. - + + Enables the receive location. + - - Disables the receive location. - + + Disables the receive location. + - - Allows stopping, starting and resetting of BizTalk in-process host - instances on the specified server. - + + Allows stopping, starting and resetting of BizTalk in-process host + instances on the specified server. + - - The name of the BizTalk server on which to perform the action. - + + The name of the BizTalk server on which to perform the action. + @@ -701,103 +771,103 @@ - - Defines the possible actions that can be performed on the BizTalk - in-process host instances. - + + Defines the possible actions that can be performed on the BizTalk + in-process host instances. + - - Stops all in-process host instances. - + + Stops all in-process host instances. + - - Starts all in-process host instances. - + + Starts all in-process host instances. + - - Stops and restarts all in-process host instances. - + + Stops and restarts all in-process host instances. + - - Allows BizTalk send ports to be controlled. - - - - Starts the "UmeHttpSendPort" send port on server - "SV-ARD-EAI". - - - - ]]> - - - - - Unenlists the "UmeHttpSendPort" send port on server - "SV-ARD-EAI". - - - - ]]> - - + + Allows BizTalk send ports to be controlled. + + + + Starts the "UmeHttpSendPort" send port on server + "SV-ARD-EAI". + + + + ]]> + + + + + Unenlists the "UmeHttpSendPort" send port on server + "SV-ARD-EAI". + + + + ]]> + + - - The name of the send port on which the perform the action. - + + The name of the send port on which the perform the action. + - - The name of the BizTalk server on which to perform the action. - + + The name of the BizTalk server on which to perform the action. + - - The action that should be performed on the send port. - + + The action that should be performed on the send port. + - - Defines the actions that can be performed on a BizTalk send port. - + + Defines the actions that can be performed on a BizTalk send port. + - - Starts the send port. - + + Starts the send port. + - - Stops the send port. - + + Stops the send port. + - - Stops and restarts the send port. - + + Stops and restarts the send port. + - - Enlists the send port. - + + Enlists the send port. + - - Unenlists the send port. - + + Unenlists the send port. + - - Removes all bindings for a given assembly from a BizTalk configuration - database. - + + Removes all bindings for a given assembly from a BizTalk configuration + database. + @@ -810,31 +880,31 @@ - - The path to the BizTalk assembly for which to remove all bindings. - + + The path to the BizTalk assembly for which to remove all bindings. + - - The name of the BizTalk server on which to perform the operation. - + + The name of the BizTalk server on which to perform the operation. + - - The assembly qualified name of the receive pipeline to set when - unbinding a receive pipeline. - + + The assembly qualified name of the receive pipeline to set when + unbinding a receive pipeline. + - - The assembly qualified name of the SEND pipeline to set when - unbinding a send pipeline. - + + The assembly qualified name of the SEND pipeline to set when + unbinding a send pipeline. + - - Removes a given assembly from a BizTalk configuration database. - + + Removes a given assembly from a BizTalk configuration database. + @@ -847,62 +917,62 @@ - - The path to the BizTalk assembly to remove. - + + The path to the BizTalk assembly to remove. + - - Determines whether to remove the assembly from the Global Assembly - Cache. The default is . - + + Determines whether to remove the assembly from the Global Assembly + Cache. The default is . + - - The path to the HTML log file to generate. - + + The path to the HTML log file to generate. + - - Base class for all the ClearCase tasks. - + + Base class for all the ClearCase tasks. + - - Base Constructor. - + + Base Constructor. + - - Execute the perforce command assembled by subclasses. - + + Execute the perforce command assembled by subclasses. + - - Derived classes should override this to provide command-specific - commandline arguments. - + + Derived classes should override this to provide command-specific + commandline arguments. + - - Overrides the base class. - + + Overrides the base class. + - - Displays a ClearCase config spec. - + + Displays a ClearCase config spec. + - - The view tag identifying the ClearCase view that will have its - config spec displayed. - + + The view tag identifying the ClearCase view that will have its + config spec displayed. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -932,10 +1002,10 @@ - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + @@ -950,33 +1020,33 @@ - - if warning messages should be suppressed. - The default is . - + + if warning messages should be suppressed. + The default is . + - - If , the modification time will be preserved. - Default is . - + + If , the modification time will be preserved. + Default is . + - - to keep a view-private copy of the file with - a .keep extension. Default is . - + + to keep a view-private copy of the file with + a .keep extension. Default is . + - - If , files may be checked in even if identical - to the original. Default is . - + + If , files may be checked in even if identical + to the original. Default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1008,44 +1078,44 @@ - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + - - to check the element out as reserved. - Default is . - + + to check the element out as reserved. + Default is . + - - Creates a writable file under a different filename. - + + Creates a writable file under a different filename. + - - If , checks out the file but does not create - an editable file containing its data. Default is . - + + If , checks out the file but does not create + an editable file containing its data. Default is . + - - Specify a branch to check out the file to. - + + Specify a branch to check out the file to. + - - If , checkouts of elements with a version - other than main latest will be allowed. Default is . - + + If , checkouts of elements with a version + other than main latest will be allowed. Default is . + - - if warning messages should be suppressed. - The default is . - + + if warning messages should be suppressed. + The default is . + @@ -1060,15 +1130,15 @@ - - If , the modification time will be preserved. - Default is . - + + If , the modification time will be preserved. + Default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1092,10 +1162,10 @@ - - If an existing lock can be replaced. - Default is . - + + If an existing lock can be replaced. + Default is . + @@ -1124,49 +1194,49 @@ - - Specifies the object pathname to be locked. - + + Specifies the object pathname to be locked. + - - Specifies the object(s) to be locked. - + + Specifies the object(s) to be locked. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Creates elements in a ClearCase VOB. - - - - This task uses the cleartool mkelem command to create ClearCase elements. - - - - - Performs a ClearCase mkelem on the file c:/views/viewdir/afile with element type text_file. - It checks in the file after creation and adds Some comment text as a comment. - - - - ]]> - - + + Creates elements in a ClearCase VOB. + + + + This task uses the cleartool mkelem command to create ClearCase elements. + + + + + Performs a ClearCase mkelem on the file c:/views/viewdir/afile with element type text_file. + It checks in the file after creation and adds Some comment text as a comment. + + + + ]]> + + - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + @@ -1181,50 +1251,50 @@ - - If , warning will be suppressed. - The default is . - + + If , warning will be suppressed. + The default is . + - - Perform a checkout after element creation. - Default is . - + + Perform a checkout after element creation. + Default is . + - - Checkin element after creation. - Default is . - + + Checkin element after creation. + Default is . + - - If , the modification time will be preserved. - Default is . - + + If , the modification time will be preserved. + Default is . + - - Assign mastership of the main branch to the current site. - Default is . - + + Assign mastership of the main branch to the current site. + Default is . + - - Element type to use during element creation. - + + Element type to use during element creation. + - - Create elements from the view-private parent directories. - Default is . - + + Create elements from the view-private parent directories. + Default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1255,38 +1325,38 @@ - - Name of the label type - + + Name of the label type + - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + - - If , allow the replacement of a - label of the same type on the same branch. - The default is . - + + If , allow the replacement of a + label of the same type on the same branch. + The default is . + - - If , process each subdirectory recursively under the viewpath. - Default is . - + + If , process each subdirectory recursively under the viewpath. + Default is . + - - Identify a specific version to attach the label to. - + + Identify a specific version to attach the label to. + - - Path to the ClearCase view file or directory that the command will operate on. - + + Path to the ClearCase view file or directory that the command will operate on. + @@ -1301,14 +1371,14 @@ - - For any VOB symbolic links encountered, labels the corresponding target. - + + For any VOB symbolic links encountered, labels the corresponding target. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1336,46 +1406,46 @@ - - Name of the label type to create. - + + Name of the label type to create. + - - Name of the VOB. Must be a valid path to somewhere on a VOB. - + + Name of the VOB. Must be a valid path to somewhere on a VOB. + - - If , allow an existing label definition to be replaced. - The default is . - + + If , allow an existing label definition to be replaced. + The default is . + - - Creates a label type that is global to the VOB or to VOB's that use this VOB. - Either global or ordinary can be specified, not both. - The default is . - + + Creates a label type that is global to the VOB or to VOB's that use this VOB. + Either global or ordinary can be specified, not both. + The default is . + - - Creates a label type that can be used only in the current VOB. - Either global or ordinary can be specified, not both. - Although by default, if global is also or not specified ordinary is the default behaviour. - + + Creates a label type that can be used only in the current VOB. + Either global or ordinary can be specified, not both. + Although by default, if global is also or not specified ordinary is the default behaviour. + - - If the label type is allowed to be used once per branch in a given element's version tree. - The default is . - + + If the label type is allowed to be used once per branch in a given element's version tree. + The default is . + - - Sets the way mastership is checked by ClearCase. See ClearCase documentation for details. - The default is . - + + Sets the way mastership is checked by ClearCase. See ClearCase documentation for details. + The default is . + @@ -1390,9 +1460,9 @@ - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1421,14 +1491,14 @@ - - The kind of type to remove. - + + The kind of type to remove. + - - The name of the object to remove. - + + The name of the object to remove. + @@ -1439,10 +1509,10 @@ - - Removes all instances of a type and the type object itself. - The default is . - + + Removes all instances of a type and the type object itself. + The default is . + @@ -1457,9 +1527,9 @@ - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1486,21 +1556,21 @@ - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + - - If , a view-private copy of the file with a - .keep extension will be kept. Default is . - + + If , a view-private copy of the file with a + .keep extension will be kept. Default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1536,76 +1606,76 @@ - - Specifies the object pathname to be unlocked. - + + Specifies the object pathname to be unlocked. + - - Specifies the object(s) to be unlocked. - + + Specifies the object(s) to be unlocked. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Updates a ClearCase view. - - - - This task uses the cleartool update command to update a ClearCase view. - - - - - Performs a ClearCase update on the snapshot view directory c:/views/viewdir. - A graphical dialog will be displayed. - The output will be logged to log.log and it will overwrite any hijacked files. - The modified time will be set to the current time. - - - - ]]> - - + + Updates a ClearCase view. + + + + This task uses the cleartool update command to update a ClearCase view. + + + + + Performs a ClearCase update on the snapshot view directory c:/views/viewdir. + A graphical dialog will be displayed. + The output will be logged to log.log and it will overwrite any hijacked files. + The modified time will be set to the current time. + + + + ]]> + + - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + - - Displays a graphical dialog during the update. - The default is . - + + Displays a graphical dialog during the update. + The default is . + - - Specifies a log file for ClearCase to write to. - + + Specifies a log file for ClearCase to write to. + - - If , hijacked files will be overwritten. - The default is . - + + If , hijacked files will be overwritten. + The default is . + - - If , hijacked files will be renamed with a .keep extension. - The default is . - + + If , hijacked files will be renamed with a .keep extension. + The default is . + @@ -1622,64 +1692,64 @@ - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Searches files for a regular-expression and produces an XML report of - the matches. - - - - Extract all TODO:, UNDONE: or HACK:- - comment-tags from C# source files and write them to a file - out.xml. (A xslt-stylesheet could then transform it to - a nice html-page for your project-homepage, but that is beyond - the scope of this example.) - - - Path, File and LineNumber are automatically - generated elements. - - - - - - - - ]]> - - - The resulting XML file for a comment-tag - 'TODO: [md, 14-02-2004] comment this method' - will look like - - - - - - TODO - comment this method - C:\MyProjects\MyPath - MyFile.cs - 146 - md - 14-02-2004 - - ... - - ]]> - - + + Searches files for a regular-expression and produces an XML report of + the matches. + + + + Extract all TODO:, UNDONE: or HACK:- + comment-tags from C# source files and write them to a file + out.xml. (A xslt-stylesheet could then transform it to + a nice html-page for your project-homepage, but that is beyond + the scope of this example.) + + + Path, File and LineNumber are automatically + generated elements. + + + + + + + + ]]> + + + The resulting XML file for a comment-tag + 'TODO: [md, 14-02-2004] comment this method' + will look like + + + + + + TODO + comment this method + C:\MyProjects\MyPath + MyFile.cs + 146 + md + 14-02-2004 + + ... + + ]]> + + - - Performs the regex-search. - + + Performs the regex-search. + @@ -1696,19 +1766,19 @@ The collection of matches to write. - - Specifies the name of the output file. - + + Specifies the name of the output file. + - - Specifies the regular-expression to search for. - + + Specifies the regular-expression to search for. + - - The set of files in which the expression is searched. - + + The set of files in which the expression is searched. + @@ -1718,9 +1788,9 @@ - - The string to count in - + + The string to count in + @@ -1739,14 +1809,14 @@ for which lines are counted. - - Counts the line-numbers until the position - is reached. - - Index into the string given during construction - - The number of lines. - + + Counts the line-numbers until the position + is reached. + + Index into the string given during construction + + The number of lines. + @@ -1765,10 +1835,10 @@ - - Encapsulation of a match of a regular-expression with the - associated named capture-groups. - + + Encapsulation of a match of a regular-expression with the + associated named capture-groups. + @@ -1783,9 +1853,9 @@ The to write to. - - Gets or sets the value for a capture group. - + + Gets or sets the value for a capture group. + @@ -1806,14 +1876,14 @@ Collection of instances to add. - - Gets the th match stored in this collection. - + + Gets the th match stored in this collection. + - - Encapsulation of a search pattern. - + + Encapsulation of a search pattern. + @@ -1838,146 +1908,146 @@ - - Extracts the matches of this pattern from . - - The name of the file associated with . - The source string - - A collection of found matches. - + + Extracts the matches of this pattern from . + + The name of the file associated with . + The source string + + A collection of found matches. + - - The base abstract class for all MKS Tasks. - - - Provides the core attributes, and functionality for opening an item - in a MKS database. - + + The base abstract class for all MKS Tasks. + + + Provides the core attributes, and functionality for opening an item + in a MKS database. + - - Opens the MKS database and sets the reference to the specified - item and version. - + + Opens the MKS database and sets the reference to the specified + item and version. + - - The password to use to login to the MKS database. - + + The password to use to login to the MKS database. + - - The name of the user needed to access the MKS database. - + + The name of the user needed to access the MKS database. + - - The name of the host MKS server to connect to - + + The name of the host MKS server to connect to + - - The port number on which the host server is accepting requests - + + The port number on which the host server is accepting requests + - - Checkpoints a project in an MKS Source Integrity database. - - - Checkpoint a project in an MKS database. - - ]]> - + + Checkpoints a project in an MKS Source Integrity database. + + + Checkpoint a project in an MKS database. + + ]]> + - - The label to apply to the checkpoint. - + + The label to apply to the checkpoint. + - - The project to checkpoint. - + + The project to checkpoint. + - - Apply label to all members. The default is . - + + Apply label to all members. The default is . + - - The description of the checkpoint. - + + The description of the checkpoint. + - - Retrieves an item or project from MKS Source Integrity. - - - Synchronise sandbox with MKS project. - - ]]> - + + Retrieves an item or project from MKS Source Integrity. + + + Synchronise sandbox with MKS project. + + ]]> + - - The path to the local working directory. - + + The path to the local working directory. + - - The project to get from MKS. - + + The project to get from MKS. + - - Generates an XML file containing the differences between the sandbox and - the project in the MKS database. - - - Get changes to a project in an MKS database. - - ]]> - + + Generates an XML file containing the differences between the sandbox and + the project in the MKS database. + + + Get changes to a project in an MKS database. + + ]]> + - - The project to retrieve the changes for. - + + The project to retrieve the changes for. + - - The file where the output will be stored in XML format. - + + The file where the output will be stored in XML format. + @@ -1985,436 +2055,436 @@ - - Determines if the supplied version string is valid. A valid version string should look like: - 1 - 1.1 - 1.1.1 - 1.1.1.1 - - The version string to verify. - + + Determines if the supplied version string is valid. A valid version string should look like: + 1 + 1.1 + 1.1.1 + 1.1.1.1 + + The version string to verify. + - - Sets the sequence number of files to match their - storage order in the cabinet file, after some - files have had their filenames changed to go in - their own component. - - The MSI database. - The last file's sequence number. + + Sets the sequence number of files to match their + storage order in the cabinet file, after some + files have had their filenames changed to go in + their own component. + + The MSI database. + The last file's sequence number. - - Cleans the output directory after a build. - - The path to the cabinet file. - The path to temporary files. + + Cleans the output directory after a build. + + The path to the cabinet file. + The path to temporary files. - - Loads records for the Properties table. - - The MSI database. + + Loads records for the Properties table. + + The MSI database. - - Loads records for the Directories table. - - The MSI database. + + Loads records for the Directories table. + + The MSI database. - - Adds a directory record to the directories table. - - The MSI database. - The MSI database view. - The parent directory. - This directory's Schema object. - The tree depth of this directory. + + Adds a directory record to the directories table. + + The MSI database. + The MSI database view. + The parent directory. + This directory's Schema object. + The tree depth of this directory. - - Retrieves the relative path of a file based on - the component it belongs to and its entry in - the MSI directory table. - - The MSI database. - The Name of the Folder - The Parent of the Folder - The Relative Filesystem Path of the Folder - The Path to the Folder from previous calls. - The MSI database view. + + Retrieves the relative path of a file based on + the component it belongs to and its entry in + the MSI directory table. + + The MSI database. + The Name of the Folder + The Parent of the Folder + The Relative Filesystem Path of the Folder + The Path to the Folder from previous calls. + The MSI database view. - - If the specified path is longer than 40 characters, 37 are returned plus ... - - A shortened path - + + If the specified path is longer than 40 characters, 37 are returned plus ... + + A shortened path + - - Retrieves a DOS 8.3 filename for a file. - - The file to shorten. - The new shortened file. + + Retrieves a DOS 8.3 filename for a file. + + The file to shorten. + The new shortened file. - - Retrieves a DOS 8.3 filename for a directory. - - The path to shorten. - The new shortened path. - + + Retrieves a DOS 8.3 filename for a directory. + + The path to shorten. + The new shortened path. + - - Retrieves a DOS 8.3 filename for a complete directory. - - The path to shorten. - The new shortened path. + + Retrieves a DOS 8.3 filename for a complete directory. + + The path to shorten. + The new shortened path. - - Recursively expands properties of all attributes of - a nodelist and their children. - - The nodes to recurse. + + Recursively expands properties of all attributes of + a nodelist and their children. + + The nodes to recurse. - - Converts the Byte array in a public key - token of an assembly to a string MSI expects. - - The array of bytes. - The string containing the array. + + Converts the Byte array in a public key + token of an assembly to a string MSI expects. + + The array of bytes. + The string containing the array. - - Loads TypeLibs for the TypeLib table. - - The MSI database. + + Loads TypeLibs for the TypeLib table. + + The MSI database. - - Loads environment variables for the Environment table. - - The MSI database. + + Loads environment variables for the Environment table. + + The MSI database. - - Loads records for the Registry table. - - The MSI database. + + Loads records for the Registry table. + + The MSI database. - - Loads records for the RegLocator table - - The MSI database. + + Loads records for the RegLocator table + + The MSI database. - - Loads records for the CompLocator table - - The MSI database. + + Loads records for the CompLocator table + + The MSI database. - - Loads records for the IniLocator table - - The MSI database. + + Loads records for the IniLocator table + + The MSI database. - - Loads records for the DrLocator table - - The MSI database. + + Loads records for the DrLocator table + + The MSI database. - - Loads records for the RegLocator table - - The MSI database. + + Loads records for the RegLocator table + + The MSI database. - - Gets the name of the registry root id by it's name. - - Name of the registry root - + + Gets the name of the registry root id by it's name. + + Name of the registry root + - - Loads records for the AppSearch table - - The MSI database. + + Loads records for the AppSearch table + + The MSI database. - - Loads records for the Icon table. - - The MSI database. + + Loads records for the Icon table. + + The MSI database. - - Loads records for the Shortcut table. - - The MSI database. + + Loads records for the Shortcut table. + + The MSI database. - - Adds custom table(s) to the msi database - - The MSI database. + + Adds custom table(s) to the msi database + + The MSI database. - - Adds table data to the msi database table structure - - The MSI database. - The current table name - Xml node representing the current table - List of column objects for the current table (Containing: column name, id, type). + + Adds table data to the msi database table structure + + The MSI database. + The current table name + Xml node representing the current table + List of column objects for the current table (Containing: column name, id, type). - - Loads records for the Binary table. This table stores items - such as bitmaps, animations, and icons. The binary table is - also used to store data for custom actions. - - The MSI database. + + Loads records for the Binary table. This table stores items + such as bitmaps, animations, and icons. The binary table is + also used to store data for custom actions. + + The MSI database. - - Loads records for the Dialog table. - - The MSI database. + + Loads records for the Dialog table. + + The MSI database. - - Loads records for the Control table. - - The MSI database. + + Loads records for the Control table. + + The MSI database. - - Loads records for the ControlCondtion table. - - The MSI database. + + Loads records for the ControlCondtion table. + + The MSI database. - - Loads records for the ControlEvent table. - - The MSI database. + + Loads records for the ControlEvent table. + + The MSI database. - - Loads records for the CustomAction table - - The MSI database. + + Loads records for the CustomAction table + + The MSI database. - - Loads records for the ActionText table. Allows users to specify descriptions/templates for actions. - - The MSI database. + + Loads records for the ActionText table. Allows users to specify descriptions/templates for actions. + + The MSI database. - - Loads records for the _AppMappings table. - - The MSI database. + + Loads records for the _AppMappings table. + + The MSI database. - - Loads records for the _UrlToDir table. - "Load the url properties to convert - url properties to a properties object" ?? - - The MSI database. + + Loads records for the _UrlToDir table. + "Load the url properties to convert + url properties to a properties object" ?? + + The MSI database. - - Loads records for the _VDirToUrl table. - Used for converting a vdir to an url - - The MSI database. + + Loads records for the _VDirToUrl table. + Used for converting a vdir to an url + + The MSI database. - - Loads records for the _AppRootCreate table. - Used for making a virtual directory a virtual application - - The MSI database. + + Loads records for the _AppRootCreate table. + Used for making a virtual directory a virtual application + + The MSI database. - - Loads records for the _IISProperties table. - - The MSI database. + + Loads records for the _IISProperties table. + + The MSI database. - - Enumerates the registry to see if an assembly has been registered - for COM interop, and if so adds these registry keys to the Registry - table, ProgIds to the ProgId table, classes to the Classes table, - and a TypeLib to the TypeLib table. - - The MSI database. - The Assembly filename. - The Assembly to check. - The name of the containing component. - The name of the containing component's assembly GUID. - View containing the Class table. - View containing the ProgId table. + + Enumerates the registry to see if an assembly has been registered + for COM interop, and if so adds these registry keys to the Registry + table, ProgIds to the ProgId table, classes to the Classes table, + and a TypeLib to the TypeLib table. + + The MSI database. + The Assembly filename. + The Assembly to check. + The name of the containing component. + The name of the containing component's assembly GUID. + View containing the Class table. + View containing the ProgId table. - - Loads properties for the Summary Information Stream. - - The MSI database. + + Loads properties for the Summary Information Stream. + + The MSI database. - - Creates a .cab file with all source files included. - - The MSI database. + + Creates a .cab file with all source files included. + + The MSI database. - - Loads records for the sequence tables. - - The MSI database. + + Loads records for the sequence tables. + + The MSI database. - - Adds a file record to the Files table. - - The MSI database. - The MSI database view. - The Component's XML Element. - The MSI database view. - The directory of this file's component. - The name of this file's component. - The installation sequence number of this file. - View containing the MsiAssembly table. - View containing the MsiAssemblyName table. - View containing the Components table. - View containing the FeatureComponents table. - View containing the Class table. - View containing the ProgId table. - View containing the SelfReg table. - ModuleComponent table. + + Adds a file record to the Files table. + + The MSI database. + The MSI database view. + The Component's XML Element. + The MSI database view. + The directory of this file's component. + The name of this file's component. + The installation sequence number of this file. + View containing the MsiAssembly table. + View containing the MsiAssemblyName table. + View containing the Components table. + View containing the FeatureComponents table. + View containing the Class table. + View containing the ProgId table. + View containing the SelfReg table. + ModuleComponent table. - - Loads records for the Components table. - - The MSI database. - The sequence number of the last file in the .cab + + Loads records for the Components table. + + The MSI database. + The sequence number of the last file in the .cab - - Executes the Task. - - None. + + Executes the Task. + + None. - - .NET wrapper for a Windows Installer database - + + .NET wrapper for a Windows Installer database + - - Drops empty tables. - + + Drops empty tables. + - - Drops the empty tables. - - Determines if this is a merge module or not - If it is a merge module, the FeatureComponents table should not be dropped. + + Drops the empty tables. + + Determines if this is a merge module or not + If it is a merge module, the FeatureComponents table should not be dropped. - - Checks to see if the specified table is empty. - - Name of the table to check existance. - True if empy and False if full. + + Checks to see if the specified table is empty. + + Name of the table to check existance. + True if empy and False if full. - - Checks to see if the specified table exists in the database - already. - - Name of the table to check existance. - True if successful. + + Checks to see if the specified table exists in the database + already. + + Name of the table to check existance. + True if successful. - - Helper class used to avoid errors when instantiating - WindowsInstaller.Installer. - + + Helper class used to avoid errors when instantiating + WindowsInstaller.Installer. + - - Use to read and manipulate existing records. - + + Use to read and manipulate existing records. + - - Creates a new reader for the entries in the view - - Database view to read entries from. Must be Execute()'ed already. + + Creates a new reader for the entries in the view + + Database view to read entries from. Must be Execute()'ed already. - - Moves to the next record - - False iff no more records + + Moves to the next record + + False iff no more records - - Deletes the current record. Needs no Commit(). - + + Deletes the current record. Needs no Commit(). + - - Set the value of a field in the current record. Remember to Commit() - - Zero-based index of the field to set - New value + + Set the value of a field in the current record. Remember to Commit() + + Zero-based index of the field to set + New value - - Get the string value of a field in the current record. - - Zero-based index of the field to get + + Get the string value of a field in the current record. + + Zero-based index of the field to get - - Commits changes to the current record. - + + Commits changes to the current record. + - - A simple class for a single search clause. - TODO: more comparison types, use of the Composite pattern, etc. - + + A simple class for a single search clause. + TODO: more comparison types, use of the Composite pattern, etc. + - - Represents a single table in a Windows Installer archive - + + Represents a single table in a Windows Installer archive + - - Base class for msi/msm installer tasks - + + Base class for msi/msm installer tasks + @@ -2423,23 +2493,23 @@ - - Initializes the task and verifies parameters. - + + Initializes the task and verifies parameters. + - - Occurs when a validation error is raised. - - The object that sent the event. - Validation arguments passed in. + + Occurs when a validation error is raised. + + The object that sent the event. + Validation arguments passed in. - - Recursively expands properties of all attributes of - a nodelist and their children. - - The nodes to recurse. + + Recursively expands properties of all attributes of + a nodelist and their children. + + The nodes to recurse. @@ -2449,3171 +2519,145 @@ The object from the Schema wrapper after is called. - - The name of the file that will be generated when the task completes - execution (eg. MyInstall.msi or MyMergeModule.msm). - + + The name of the file that will be generated when the task completes + execution (eg. MyInstall.msi or MyMergeModule.msm). + - - A directory relative to the NAnt script in which the msi task resides - from which to retrieve files that will be installed by the msi - database. All files that will be included in your installation need - to be located directly within or in subdirectories of this directory. - + + A directory relative to the NAnt script in which the msi task resides + from which to retrieve files that will be installed by the msi + database. All files that will be included in your installation need + to be located directly within or in subdirectories of this directory. + - - A installer file to use as the starting database in which all files - and entries will be made, and then copied to the filename specified - by the output parameter. Install templates are included with the - install tasks, you only need to supply this value if you want to - override the default template. - + + A installer file to use as the starting database in which all files + and entries will be made, and then copied to the filename specified + by the output parameter. Install templates are included with the + install tasks, you only need to supply this value if you want to + override the default template. + - - A .mst file to use as the starting database containing strings - displayed to the user when errors occur during installation. - A .mst template is included with the msi task, you only need to - supply this value if you want to override the default error - template and cannot perform something through the features of the - msi task. - + + A .mst file to use as the starting database containing strings + displayed to the user when errors occur during installation. + A .mst template is included with the msi task, you only need to + supply this value if you want to override the default error + template and cannot perform something through the features of the + msi task. + - - Causes the generated msi database file to contain debug messages for - errors created by inconsistencies in creation of the database. This - makes the file slightly larger and should be avoided when generating - a production release of your software. - + + Causes the generated msi database file to contain debug messages for + errors created by inconsistencies in creation of the database. This + makes the file slightly larger and should be avoided when generating + a production release of your software. + - - - Sets various properties in the SummaryInformation stream - (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_information_stream.asp) - - - All of the sub-elements are optional. - -

Nested Elements:

-

<title>

-
    - Briefly describes the type of installer package. Phrases such as "Installation Database" or - "Transform" or "Patch" may be used for this property. -
    Default value: Value of the ProductName property, if defined. -
-

</title>

-

<subject>

-
    - A short description of the product to be installed. This value is typically set from the installer - property ProductName -
    Default value: Value of the ProductName property, if defined. -
-

</subject>

-

<author>

-
    - The manufacturer of the installation database. This value is typically set from the installer - property Manufacturer. -
    Default value: Value of the Manufacturer property, if defined. -
-

</author>

-

<keywords>

-
    - Used by file browsers to hold keywords that permit the database file to be found in a keyword search. - The set of keywords typically includes "Installer" as well as product-specific keywords, and may be - localized. -
    Default value: Value of the Keywords property, if defined. -
-

</keywords>

-

<comments>

-
    - A general description/purpose of the installer database. -
    Default value: Value of the Comments property, if defined. -
-

</comments>

-

<template>

-
    - - Indicates the platform and language versions that are supported by the database. The Template Summary - Property of a patch package is a semicolon-delimited list of the product codes that can accept the - patch. - - - See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/template_summary_property.asp for more information. - -
-

</template>

-

<revisionnumber>

-
    - Contains the package code (GUID) for the installer package. The package code is a unique identifier - of the installer package. Note: Default behavior - a new GUID is generated every time -
-

</revisionnumber>

-

<creatingapplication>

-
    - The name of the application used to author the database. Note: Default value is NAnt. -
-

</creatingapplication>

-

Examples

- - Define specific summary information. - - <summaryinformation> - <title>Installation Database</title> - <subject>${install.productname}</subject> - <author>${install.manufacturer}</author> - <keywords>MSI, database, NAnt, Installer</keywords> - <comments>This installer database contains the logic and data required to install NAnt</comments> - <template>;1033</template> - <creatingapplication>NAnt - http://nant.sf.net </creatingapplication> - </summaryinformation> - - - + + + Sets various properties in the SummaryInformation stream + (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_information_stream.asp) + + + All of the sub-elements are optional. + +

Nested Elements:

+

<title>

+
    + Briefly describes the type of installer package. Phrases such as "Installation Database" or + "Transform" or "Patch" may be used for this property. +
    Default value: Value of the ProductName property, if defined. +
+

</title>

+

<subject>

+
    + A short description of the product to be installed. This value is typically set from the installer + property ProductName +
    Default value: Value of the ProductName property, if defined. +
+

</subject>

+

<author>

+
    + The manufacturer of the installation database. This value is typically set from the installer + property Manufacturer. +
    Default value: Value of the Manufacturer property, if defined. +
+

</author>

+

<keywords>

+
    + Used by file browsers to hold keywords that permit the database file to be found in a keyword search. + The set of keywords typically includes "Installer" as well as product-specific keywords, and may be + localized. +
    Default value: Value of the Keywords property, if defined. +
+

</keywords>

+

<comments>

+
    + A general description/purpose of the installer database. +
    Default value: Value of the Comments property, if defined. +
+

</comments>

+

<template>

+
    + + Indicates the platform and language versions that are supported by the database. The Template Summary + Property of a patch package is a semicolon-delimited list of the product codes that can accept the + patch. + + + See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/template_summary_property.asp for more information. + +
+

</template>

+

<revisionnumber>

+
    + Contains the package code (GUID) for the installer package. The package code is a unique identifier + of the installer package. Note: Default behavior - a new GUID is generated every time +
+

</revisionnumber>

+

<creatingapplication>

+
    + The name of the application used to author the database. Note: Default value is NAnt. +
+

</creatingapplication>

+

Examples

+ + Define specific summary information. + + <summaryinformation> + <title>Installation Database</title> + <subject>${install.productname}</subject> + <author>${install.manufacturer}</author> + <keywords>MSI, database, NAnt, Installer</keywords> + <comments>This installer database contains the logic and data required to install NAnt</comments> + <template>;1033</template> + <creatingapplication>NAnt - http://nant.sf.net </creatingapplication> + </summaryinformation> + + + - - - Name/value pairs which will be set in the PROPERTY table of the - installer database. - - - The properties element contains within it one to any number of property elements.
- Public property names cannot contain lowercase letters.
- Private property names must contain some lowercase letters.
- Property names prefixed with % represent system and user environment variables. These are - never entered into the Property - table. The permanent settings of environment variables can only be modified using the Environment Table. - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the property. - True - - - value - string - The value of the property. This value can contain references to other, predefined properties to build a compound property. - True - - -

Examples

- - Define the required properties. - - <properties> - <property name="ProductName" value="My Product" /> - <property name="ProductVersion" value="1.0.0" /> - <property name="Manufacturer" value="ACME Inc." /> - <property name="ProductCode" value="{29D8F096-3371-4cba-87E1-A8C6511F7B4C}" /> - <property name="UpgradeCode" value="{69E66919-0DE1-4280-B4C1-94049F76BA1A}" /> - </properties> - - - - - - - - Contains within it one to any number of app, registry, ini, or dirfile elements. - These elements are used to search for an existing filesystem directory, file, or - Windows Registry setting. A property in the installer database is - then set with the value obtained from the search. - -

<app>

- - More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/complocator_table.asp - - - - Attribute - Type - Description - Required - - - componentid - string - The component ID of the component whose key path is to be used for the search. - True - - - type - msi:MSILocatorTypeDirFile - Valid input: file or directory - True - - - setproperty - string - A name used to refer to the property within the Msi database. Set at install time. - True - - -

</app>

-

<registry>

- - More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/reglocator_table.asp - - - - Attribute - Type - Description - Required - - - type - msi:MSILocatorTypeDirFileReg64 - Valid input: registry, file, directory, 64bit - True - - - path - string - Depending on the type specified: - - Path is a directory. - Path is a registry key. - - - True - - - root - msi:MSIRegistryKeyRoot - Valid input: - - dependent - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1. - machine represents HKEY_LOCAL_MACHINE - classes represents HKEY_CLASSES_ROOT - user represents HKEY_CURRENT_USER - users represents HKEY_USERS - - - True - - -
    -

    Nested Elements:

    -

    <value>

    -

    Parameters

    - - - Attribute - Type - Description - Required - - - name - string - Depending on the type specified: - - Key path is a file name. - Key path is a registry value. - - - False - - - setproperty - string - A name used to refer to the property within the Msi database. Set at install time. - True - - -

    </value>

    -
-

</registry>

-

<ini>

- - More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/inilocator_table.asp - - - - Attribute - Type - Description - Required - - - filename - string - The .ini file name. (The .ini file must be present in the default Microsoft Windows directory.) - - True - - - section - string - Section name within the .ini file. - - True - - - key - string - Key value within the section. - - True - - - field - msi:nonNegativeInt - The field in the .ini line. If Field is Null or 0, then the entire line is read. - This must be a non-negative number. - - False - - - type - msi:MSILocatorTypeDirFileRaw - Valid input: file ,directory, or raw - True - - - setproperty - string - A name used to refer to the property within the Msi database. Set at install time. - True - - -

</ini>

-

<dirfile>

- - More information on these attributes can be found at: - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/drlocator_table.asp - and - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/signature_table.asp - - - - Attribute - Type - Description - Required - - - parent - string - An identifier to RegLocator, IniLocator, or CompLocator tables. - If it does not expand to a full path, then all the fixed drives of the user's system are searched by using the Path. -
In order to determine what the key is for a table, prefix the property name assigned - to that locator with SIG_ - - False - - - path - string - the path on the user's system. This is a either a full path or a relative subpath - below the directory specified in the Parent column. - - False - - - depth - msi:nonNegativeInt - The depth below the path that the installer searches for the file or directory. - - False - - - setproperty - string - A name used to refer to the property within the Msi database. Set at install time. - True - - -
    -

    Nested Elements:

    -

    <file>

    -

    Parameters

    - - - Attribute - Type - Description - Required - - - name - string - The name of the file. - True - - - minversion - string - The minimum version of the file, with a language comparison. If this field is - specified, then the file must have a version that is at least equal to MinVersion. - If the file has an equal version to the MinVersion field value but the language - specified in the Languages column differs, the file does not satisfy the signature - filter criteria. - False - - - maxversion - string - The maximum version of the file. If this field is specified, then the file - must have a version that is at most equal to MaxVersion. - False - - - minsize - msi:nonNegativeInt - The minimum size of the file. If this field is specified, then the file - under inspection must have a size that is at least equal to MinSize. This must - be a non-negative number. - False - - - maxsize - msi:nonNegativeInt - The maximum size of the file. If this field is specified, then the file - under inspection must have a size that is at most equal to MaxSize. This must - be a non-negative number. - False - - - mindate - msi:nonNegativeInt - The minimum modification date and time of the file. If this field is - specified, then the file under inspection must have a modification date and time - that is at least equal to MinDate. This must be a non-negative number. - False - - - maxdate - msi:nonNegativeInt - The maximum creation date of the file. If this field is specified, then the - file under inspection must have a creation date that is at most equal to MaxDate. - This must be a non-negative number. - False - - - languages - string - The languages supported by the file. - False - - -

    </file>

    -
-

</dirfile>

-

Examples

- - Get the path of the web directory and the version of IIS. Create new properties in the Msi file with those values. - - <search> - <registry type="registry" path="Software\Microsoft\InetStp" root="machine" > - <value name="PathWWWRoot" setproperty="IISWWWROOT" /> - </registry> - <registry type="registry" path="SYSTEM\CurrentControlSet\Services\W3SVC\Parameters" root="machine" > - <value name="MajorVersion" setproperty="IISVERSION" /> - </registry> - </search> - - - - Shows two ways to get the default key value for the specified key. Create new properties in the Msi file with those values. - - <search> - <registry type="registry" path="Software\Microsoft\MessengerService" root="machine" > - <value setproperty="MSGSRVNAME" /> - <value name="" setproperty="MSGSRVNAME2" /> - </registry> - </search> - - - - - - - - Contains within it one to any number of launchcondition elements. - Launch conditions are conditions that all must be satisfied for the - installation to begin. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to identify the launch condition. - True - - - condition - string - Expression that must evaluate to True for installation to begin. - True - - -

Nested Elements:

-

<description>

-
    - Localizable text to display when the condition fails and the installation must be terminated. -
-

</description>

-

Examples

- - Create a check to make sure that IIS 5.x is installed. - - <launchconditions> - <launchcondition name="CheckIIS" condition="(IISVERSION = &quot;#5&quot;)" > - <description> - This setup requires Internet information Server 5.x. Please install Internet Information Server and run this setup again. - </description> - </launchcondition> - </launchconditions> - - - - - - - - Creates custom tables not directly managed by default features of - the installer task. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A unique name used to identify the table. - True - - -

Nested Elements:

-

<columns>

-
    -

    <column>

    -
      - Defines the columns making up the table -

      Parameters

      - - - Attribute - Type - Description - Required - - - name - string - A unique name used to define the column. - True - - - nullable - bool - When set to true, allows the column to accept null values; false does not allow null values. - True - - - category - msi:MSITableColumnCategoryType - Valid input: - - Text - UpperCase - LowerCase - Integer - DoubleInteger - Time/Date - Identifier - Property - Filename - WildCardFilename - Path - Paths - AnyPath - DefaultDir - RegPath - Formatted - Template - Condition - GUID - Version - Language - Binary - Cabinet - Shortcut - - More information here: http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp - - False - - - type - string - Overrides the category specification. An example of valid input would be: S255 - False - - - key - bool - When set to true, the column is used to form the primary key for the table; false specifies that the column is not used to form the primary key. - False - - - minvalue - int - This field applies to columns having numeric value. The field contains the minimum permissible value. This can be the minimum value for an integer or the minimum value for a date or version string. - False - - - maxvalue - int - This field applies to columns having numeric value. The field is the maximum permissible value. This may be the maximum value for an integer or the maximum value for a date or version string. - False - - - keytable - string - This field applies to columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. This can be a list of tables separated by semicolons. - False - - - keycolumn - int - This field applies to table columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. The permissible range of the KeyColumn field is 1-32. - False - - - set - string - This is a list of permissible values for this field separated by semicolons. This field is usually used for enums. - False - - - description - string - A description of the data that is stored in the column. - False - - -
    -

    </column>

    -
-

</columns>

-

<rows>

-
    -

    <row>

    -
      - Defines the data for a row in the table -

      <columns>

      -
        -

        <column>

        -
          - Defines data for a specific cell in the row -

          Parameters

          - - - Attribute - Type - Description - Required - - - name - string - Name of the column to populate. - True - - - value - string - Value to populate the cell with. - True - - -
        -

        </column>

        -
      -

      </columns>

      -
    -

    </row>

    -
-

</rows>

-

Examples

- - - Build the IniFile table. Since the WriteIniValues and RemoveIniValues actions exist in the template, they will use this table. - - - <tables> - <table name="IniFile"> - <columns> - <column name="IniFile" nullable="false" category="Identifier" key="true" description="The key for this table." /> - <column name="FileName" nullable="false" category="Text" description="The localizable name of the .ini file in which to write the information. " /> - <column name="DirProperty" nullable="true" category="Identifier" description="Name of a property having a value that resolves to the full path of the folder containing the .ini file. " /> - <column name="Section" nullable="false" category="Formatted" description="The localizable .ini file section." /> - <column name="Key" nullable="false" category="Formatted" description="The localizable .ini file key within the section" /> - <column name="Value" nullable="false" category="Formatted" description="The localizable value to be written. " /> - <column name="Action" nullable="false" category="Integer" description="The type of modification to be made. " /> - <column name="Component_" nullable="false" category="Identifier" description="External key into the first column of the Component table referencing the component that controls the installation of the .ini value. " /> - </columns> - <rows> - <row> - <columns> - <column name="IniFile" value="MyInternetShortcut" /> - <column name="FileName" value="MyInternetAddr.url" /> - <column name="DirProperty" value="D__MYDIR" /> - <column name="Section" value="InternetShortcut" /> - <column name="Key" value="URL" /> - <column name="Value" value="[TARGETURL]" /> - <column name="Action" value="0" /> - <column name="Component_" value="C__Documentation" /> - </columns> - </row> - </rows> - </table> - </tables> - - - - - - - - Specifies the directory layout for the product. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the directory. - True - - - foldername - string - The directory's name (localizable)under the parent directory. - True - - - root - string - A reference to the directory's parent directory. This can be a property name or one of the predefined directories included with the default template: - - AdminToolsFolder - AppDataFolder - CommonAppDataFolder - CommonFiles64Folder - CommonFilesFolder - DesktopFolder - FavoritesFolder - FontsFolder - LocalAppDataFolder - MyPicturesFolder - PersonalFolder - ProgramFilesFolder - ProgramMenuFolder - ProgramFiles64Folder - SendToFolder - StartMenuFolder - StartupFolder - System16Folder - System64Folder - SystemFolder - TARGETDIR - TempFolder - TemplateFolder - WindowsFolder - WindowsVolume - - - True - - -

Nested Elements:

-

<directory>

-
    - Sub directories. Note, this element can contain nested <directory/> sub elements. -

    Parameters

    - - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the directory. - True - - - foldername - string - The directory's name (localizable)under the parent directory. - True - - -
-

</directory>

-

Examples

- - Define a sample directory structure. - - <directories> - <directory name="D__ACME" foldername="ACME" root="TARGETDIR" > - <directory name="D__ACME_MyProduct" foldername="My Product" /> - </directory> - </directories> - - - - - - - - Used to modify the environment variables of the target computer at - runtime. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - The localizable name of the environment variable. The key values are written or removed depending upon - which of the characters in the following table are prefixed to the name. There is no effect in the ordering of - the symbols used in a prefix. - - - Prefix - Description - - - = - Create the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation. - - - + - Create the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists. - - - - - Remove the environment variable when the component is removed. This symbol can be combined with any prefix. - - - ! - Remove the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty. - - - * - This prefix is used with Microsoft® Windows® NT/Windows® 2000 to indicate that the name refers to a system environment variable. If no asterisk is present, the installer writes the variable to the user's environment. Microsoft Windows 95/98 ignores the asterisk and add the environment variable to autoexec.bat. This symbol can be combined with any prefix. A package that is used for per-machine installations should write environment variables to the machine's environment by including * in the Name column. For more information, see http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp - - - =- - The environment variable is set on install and removed on uninstall. This is the usual behavior. - - - !- - Removes an environment variable during an install or uninstall. - - - More information can be found here: http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp - - True - - - append - string - Localizable value that is to be set as a formatted string - True - - - component - string - Refrence to a component. Allows the variabled to be modified when the component is un/installed. - True - - -

Examples

- - Append the installation path to the user PATH variable. - - <environment> - <variable name="PATH" append="'[TARGETDIR]'" component="C__MainFiles" /> - </environment> - - - - - - - - Groups sets of files into named sets, these can be used to install - and perform operations on a set of files as one entity. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the component. - True - - - id - string - A string GUID unique to this component, version, and language.
Note that the letters of these GUIDs must be - uppercase. Utilities such as GUIDGEN can generate GUIDs containing lowercase letters. The lowercase letters must be - changed to uppercase to make these valid component code GUIDs. - - True - - - attr - int - This column contains a bit flag that specifies options for remote execution. Add the indicated bit to the total value in the column to include an option. - - - Value - Description - - - 0 - Component cannot be run from source.
- Set this bit for all components belonging to a feature to prevent the feature from being run-from-network or - run-from-source. Note that if a feature has no components, the feature always shows run-from-source and - run-from-my-computer as valid options. - - - - 1 - Component can only be run from source.
- Set this bit for all components belonging to a feature to prevent the feature from being run-from-my-computer. - Note that if a feature has no components, the feature always shows run-from-source and run-from-my-computer as - valid options. - - - - 2 - Component can run locally or from source. - - - 4 - If this bit is set, the value in the key element is used as a key into the Registry table.
- If the Value field of the corresponding record in the Registry table is null, the Name field in that record must - not contain "+", "-", or "*". For more information, see the description of the Name field in Registry table.
- Setting this bit is recommended for registry entries written to the HKCU hive. This ensures the installer writes - the necessary HKCU registry entries when there are multiple users on the same machine. - - - - 16 - If this bit is set, the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings. - - - - 32 - If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table. - - - 64 - If this bit is set, the installer reevaluates the value of the statement in the Condition column - upon a reinstall. If the value was previously False and has changed to True, the installer installs the component. - If the value was previously True and has changed to False, the installer removes the component even if the component - has other products as clients.
This bit should only be set for transitive components. See Using Transitive - Components. - - - - 128 - If this bit is set, the installer does not install or reinstall the component if a key path file or - a key path registry entry for the component already exists. The application does register itself as a client of - the component.
- Use this flag only for components that are being registered by the Registry table. - - - - 256 - Set this bit to mark this as a 64-bit component. This attribute facilitates the installation of - packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered - as a 32-bit component. - - - - - True - - - directory - string - Refrence to a directory. Defines the directory location for where the files assigned to the component are to be placed. - True - - - feature - string - Refrence to a feature. Maps a feature to the component. Used to determine if the component is to be installed or not. - True - - - condition - string - A conditional statement that can control whether a component is installed. If the condition is null or evaluates to - true, then the component is enabled. If the condition evaluates to False, then the component is disabled and is not - installed. - False - - - fileattr - int - Integer containing bit flags representing file attributes.
- The following table shows the definition of the bit field. - - - Value - Description - - - 1 - Read-Only - - - 2 - Hidden - - - 4 - System - - - 512 - The file is vital for the proper operation of the component to which it belongs - - - 1024 - The file contains a valid checksum. A checksum is required to repair a file that has become corrupted. - - - 4096 - This bit must only be added by a patch and if the file is being added by the patch. - - - 8192 - The file's source type is uncompressed. If set, ignore the Word Count Summary Property. - If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression - state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed - and msidbFileAttributesCompressed. - - - 16384 - The file's source type is compressed. If set, ignore the Word Count Summary Property. - If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of - the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and - msidbFileAttributesCompressed. - - - - False - - - checkinterop - bool - Used to determine if file(s) in the fileset are interop file(s). If true, extra information will be added in the install - package to register each interop file. If false, the file(s) will not be not be checked and the extra registration information - will not be added to the msi. - False - - - installassembliestogac - bool - Used to determine if assemblies should be installed to the Global Assembly Cache. - If true, all assemblies in the fileset will be added to the GAC. If false, the assemblies will be installed - to the specified directory (as a normal file would). Note: If an assembly is specified to be installed into the GAC, it will not - also be installed to the directory specified. - False - - - keepsubdirs - bool - Used to determine if directories in the fileset should be built. - If true, all subdirectories of the fileset basedir will be built. If false the directories structure will be - flattened. The default is false. - False - - -

Nested Elements:

-

<keyfile>

-
    - This value points to a file or folder belonging to the component that the installer uses to detect the component. Two components cannot share the same key path value. -

    Parameters

    - - - Attribute - Type - Description - Required - - - file - string - Name of the key (file) to use. Also, this could be an id of a registry key value. - True - - -
-

</keyfile>

-

<fileset>

-
    - Specifies the files to include with the component -
-

</fileset>

-

<forceid>

-
    - Used to force specific attributes on a per file basis -

    Parameters

    - - - Attribute - Type - Description - Required - - - file - string - Name of the file, in the fileset, to override. - True - - - id - string - Unique GUID to assign to the file. - True - - - attr - int - Integer containing bit flags representing file attributes.
    - The following table shows the definition of the bit field. - - - Value - Description - - - 1 - Read-Only - - - 2 - Hidden - - - 4 - System - - - 512 - The file is vital for the proper operation of the component to which it belongs - - - 1024 - The file contains a valid checksum. A checksum is required to repair a file that has become corrupted. - - - 4096 - This bit must only be added by a patch and if the file is being added by the patch. - - - 8192 - The file's source type is uncompressed. If set, ignore the Word Count Summary Property. - If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression - state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed - and msidbFileAttributesCompressed. - - - 16384 - The file's source type is compressed. If set, ignore the Word Count Summary Property. - If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of - the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and - msidbFileAttributesCompressed. - - -     - False -     - - version - string - This field is the version string for a versioned file. This field is blank for non-versioned files. - False - - - language - string - A list of decimal language IDs separated by commas. - False - - - checkinterop - bool - Used to determine if file is an interop file. If true, extra information will be added in the install - package to register the interop file. If false, the file will not be not be checked and the extra registration information - will not be added to the msi. - False - - - installtogac - bool - If true, and if the file is an assembly, it will be installed to the GAC. If false, the file - will be installed to the directory specified by the component. Note: If an assembly is specified to - be installed into the GAC, it will not also be installed to the directory specified. - False - -     -
-

</forceid>

-

Examples

- - Define a sample component structure. - - <components> - <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" > - <key file="default.aspx" /> - <fileset basedir="${install.dir}"> - <include name="*.*" /> - </fileset> - </component> - </components> - - - - Install files to TARGETDIR and assemblies to the GAC (Global Assembly Cache). Do not install MyOtherAssembly.dll to the GAC, but rather install it with the other files (to TARGETDIR) - - <components> - <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" installassembliestogac="true" > - <key file="MyAssemblyName.xml" /> - <fileset basedir="${install.dir}"> - <include name="*.*" /> - </fileset> - <forceid file="MyOtherAssembly.dll" id="_4EB7CCB23D394958988ED817DA00B9D1" installtogac="false" /> - </component> - </components> - - - - Assign a registry entry to a specific component. - - <components> - <component name="C__RegistryEntry" id="{06C654AA-273D-4E39-885C-3E5225D9F336}" attr="4" directory="TARGETDIR" feature="F__DefaultFeature" > - <key file="R__822EC365A8754FACBF6C713BFE4E57F0" /> - </component> - </components> - . - . - . - <registry> - <key path="SOFTWARE\MyCompany\MyProduct\" root="machine" component="C__RegistryEntry"> - <value id="R__822EC365A8754FACBF6C713BFE4E57F0" name="MyKeyName" value="MyKeyValue" /> - </key> - </registry> - - - - - - - - Creates custom dialogs that can gather information not handled by - the default installer template. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the dialog. - True - - - hcenter - int - Horizontal position of the dialog box. The range is 0 to 100, with 0 at the left edge of the screen and 100 at the right edge. - True - - - vcenter - int - Vertical position of the dialog box. The range is 0 to 100, with 0 at the top edge of the screen and 100 at the bottom edge. - True - - - width - int - Width of the rectangular boundary of the dialog box. This number must be non-negative. - True - - - height - int - Height of the rectangular boundary of the dialog box. This number must be non-negative. - True - - - attr - int - A 32-bit word that specifies the attribute flags to be applied to this dialog box. This number must be non-negative. - - - Value - Description - - - 1 - Visible - - - 2 - Modal - - - 4 - Minimize - - - 8 - SysModal - - - 16 - KeepModeless - - - 32 - TrackDiskSpace - - - 64 - UseCustomPalette - - - 128 - RTLRO - - - 256 - RightAligned - - - 512 - LeftScroll - - - 896 - BiDi - - - 65536 - Error - - - More information here: http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp - - True - - - title - string - A localizable text string specifying the title to be displayed in the title bar of the dialog box. - True - - - firstcontrol - string - An external key to the second column of the Control table. Combining this field with the Dialog field identifies a - unique control in the Control table. This defines the control that takes the focus when the dialog box is created. This - column is ignored in an Error dialog box.
- Because static text cannot take the focus, a Text control that describes an Edit, PathEdit, ListView, ComboBox or - VolumeSelectCombo control must be made the first control in the dialog box to ensure compatibility with screen readers. - - True - - - defaultcontrol - string - An external key to the second column of the Control table. Combining this field with the Dialog field results in - a primary key into the Control table that defines the default control. Hitting the Return key is equivalent to clicking - on the default control. If this column is left blank, then there is no default control. This column is ignored in the - Error dialog box. - - True - - - cancelcontrol - string - An external key to the second column of the Control table. Combining this field with the Dialog field results in - a primary key of the Control table that defines the cancel control. Hitting the ESC key or clicking the Close button in - the dialog box is equivalent to clicking on the cancel control. This column is ignored in an Error dialog box.
- The cancel control is hidden during rollback or the removal of backed up files. The protected UI handler hides the control - upon receiving a INSTALLMESSAGE_COMMONDATA message. - - True - - -

Examples

- - Add a web folder dialog: - - <dialogs> - <dialog name="WebFolderDlg" hcenter="50" vcenter="50" width="370" height="270" attr="39" title="[ProductName] [Setup]" firstcontrol="Next" defaultcontrol="Next" cancelcontrol="Cancel" /> - </dialogs> - - - - - - - - Creates user interface controls displayed on custom dialogs. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes. - True - - - dialog - string - Refrence to a dialog. Used to associate the control with the dialog. - True - - - type - string - The type of the control. - - - Control name - Description - - - Billboard - Displays billboards based on progress messages. - - - Bitmap - Displays a static picture of a bitmap. - - - CheckBox - A two-state check box. - - - ComboBox - A drop-down list with an edit field. - - - DirectoryCombo - Select all except the last segment of the path. - - - DirectoryList - Displays folders below the main part of path. - - - Edit - A regular edit field for any string or integer. - - - GroupBox - Displays a rectangle that groups other controls together. - - - Icon - Displays a static picture of an icon. - - - Line - Displays a horizontal line. - - - ListBox - A drop-down list without an edit field. - - - ListView - Displays a column of values with icons for selection. - - - MaskedEdit - An edit field with a mask in the text field. - - - PathEdit - Displays folder name or entire path in an edit field. - - - ProgressBar - Bar graph that changes length as it receives progress messages. - - - PushButton - Displays a basic push button. - - - RadioButtonGroup - A group of radio buttons. - - - ScrollableText - Displays a long string of text. - - - SelectionTree - Displays information from the Feature table and enables the user to change their selection state. - - - Text - Displays static text. - - - VolumeCostList - Displays costing information on different volumes. - - - VolumeSelectCombo - Selects volume from an alphabetical list. - - - More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp - True - - - x - int - Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. - True - - - y - int - Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. - True - - - width - int - Width of the rectangular boundary of the control. This must be a non-negative number. - True - - - height - int - Height of the rectangular boundary of the control. This must be a non-negative number. - True - - - attr - int - A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see Control Attributes. - True - - - property - string - The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls. - False - - - text - string - A localizable string used to set the initial text contained in a control. The string can also contain embedded properties. - False - - - nextcontrol - string - The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. - False - - - help - string - Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present. - False - - - remove - bool - If true, the control is removed. If false, the control is added. - False - - -

Examples

- - Remove the Browse button from the customize dialog and add controls for a web dialog - - <controls> - <!-- Remove the Browse button from customize dialog --> - <control dialog="CustomizeDlg" name="Browse" type="PushButton" - x="304" y="200" width="56" height="17" attr="3" remove="true" /> - <control dialog="CustomizeDlg" name="Tree" type="SelectionTree" - x="25" y="85" width="175" height="95" attr="7" remove="true" /> - <!-- Re add the tree control with the proper next control --> - <control dialog="CustomizeDlg" name="Tree" type="SelectionTree" - x="25" y="85" width="175" height="95" attr="7" - property="_BrowseProperty" text="Tree of selections" nextcontrol="Reset" /> - <!-- Adds the controls associated with the webfolder dialog --> - <control dialog="WebFolderDlg" name="BannerBitmap" type="Bitmap" - x="0" y="0" width="374" height="44" attr="1" - text="[BannerBitmap]" nextcontrol="VDirLabel" /> - <control dialog="WebFolderDlg" name="Title" type="Text" - x="15" y="6" width="200" height="15" attr="196611" - text="[DlgTitleFont]Virtual Directory Information" /> - <control dialog="WebFolderDlg" name="Description" type="Text" - x="25" y="23" width="280" height="15" attr="196611" - text="Please enter your virtual directory and port information." /> - <control dialog="WebFolderDlg" name="BannerLine" type="Line" - x="0" y="44" width="374" height="0" attr="1" /> - <control dialog="WebFolderDlg" name="VDirLabel" type="Text" - x="18" y="73" width="348" height="15" attr="3" - text="&Virtual directory:" - nextcontrol="Edit_VDir" /> - <control dialog="WebFolderDlg" name="Edit_VDir" type="Edit" - x="18" y="85" width="252" height="18" attr="7" - property="TARGETVDIR" - text="[TARGETVDIR]" - nextcontrol="PortLabel" /> - <control dialog="WebFolderDlg" name="PortLabel" type="Text" - x="18" y="110" width="348" height="15" attr="3" - text="&Port:" - nextcontrol="Edit_Port" /> - <control dialog="WebFolderDlg" name="Edit_Port" type="Edit" - x="18" y="122" width="48" height="18" attr="7" - property="TARGETPORT" - text="[TARGETPORT]" - nextcontrol="Back" /> - <control dialog="WebFolderDlg" name="BottomLine" type="Line" - x="0" y="234" width="374" height="0" attr="1" /> - <control dialog="WebFolderDlg" name="Back" type="PushButton" - x="180" y="243" width="56" height="17" attr="3" - text="[ButtonText_Back]" nextcontrol="Next" /> - <control dialog="WebFolderDlg" name="Next" type="PushButton" - x="236" y="243" width="56" height="17" attr="3" - text="[ButtonText_Next]" nextcontrol="Cancel" /> - <control dialog="WebFolderDlg" name="Cancel" type="PushButton" - x="304" y="243" width="56" height="17" attr="3" - text="[ButtonText_Cancel]" nextcontrol="BannerBitmap" /> - </controls> - - - - - - - - Used to validate and perform operations as the result of information - entered by the user into controls on custom dialogs. - -

Parameters

- - - Attribute - Type - Description - Required - - - dialog - string - Refrence to a dialog. Used to associate the control with the dialog. - True - - - control - string - Refrence to a control. Maps to a control for the specified dialog. - True - - - action - string - The action that is to be taken on the control. The possible actions are shown in the following table. - - - Value - Description - - - Default - Set control as the default. - - - Disable - Disable the control. - - - Enable - Enable the control. - - - Hide - Hide the control. - - - Show - Display the control. - - - - True - - - condition - string - A conditional statement that specifies under which conditions the action should be triggered. If this statement does not evaluate to TRUE, the action does not take place. If it is set to 1, the action is always applied. - True - - - remove - bool - If true, the control condition is removed. If false, the control condition is added. - False - - -

Examples

- - Remove the control condition for the Browse button from the customize dialog and add control conditions for a web dialog - - <controlconditions> - <!-- Remove control condition for Browse button on customizeDlg --> - <controlcondition dialog="CustomizeDlg" control="Browse" action="Hide" - condition="Installed" remove="true" /> - <!-- Add control conditions for the web folder dialog --> - <controlcondition dialog="WebFolderDlg" control="Back" action="Disable" - condition="ShowUserRegistrationDlg=""" /> - <controlcondition dialog="WebFolderDlg" control="Back" action="Enable" - condition="ShowUserRegistrationDlg<>""" /> - </controlconditions> - - - - - - - - Used to route the flow of the installation process as the result of - events raised by the user interacting with controls on dialogs. - -

Parameters

- - - Attribute - Type - Description - Required - - - dialog - string - Refrence to a dialog. Used to associate the control with the dialog. - True - - - control - string - Refrence to a control. Maps to a control for the specified dialog. - True - - - name - string - An identifier that specifies the type of event that should take place when the user interacts with the control - specified by Dialog_ and Control_. For a list of possible values see ControlEvent Overview.
- To set a property with a control, put [Property_Name] in this field and the new value in the argument field. Put { } - into the argument field to enter the null value. - - True - - - argument - string - A value used as a modifier when triggering a particular event. - True - - - condition - string - A conditional statement that determines whether the installer activates the event in the Event column. The installer - triggers the event if the conditional statement in the Condition field evaluates to True. Therefore put a 1 in this column - to ensure that the installer triggers the event. The installer does not trigger the event if the Condition field contains - a statement that evaluates to False. The installer does not trigger an event with a blank in the Condition field unless no - other events of the control evaluate to True. If none of the Condition fields for the control named in the Control_ field - evaluate to True, the installer triggers the one event having a blank Condition field, and if more than one Condition field - is blank it triggers the one event of these with the largest value in the Ordering field. - False - - - order - int - An integer used to order several events tied to the same control. This must be a non-negative number. - False - - - remove - bool - If true, the control condition is removed. If false, the control condition is added. - False - - -

Examples

- - Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog - - - <controlevents> - <!-- Remove the old control events --> - <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" - argument="SetupTypeDlg" condition="ProductID" remove="true" /> - <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" - argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg <> 1" remove="true" /> - <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" - argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg = 1" remove="true" /> - <!-- Remove control events for Browse button on CustomizeDlg --> - <controlevent dialog="CustomizeDlg" control="Browse" name="SelectionBrowse" - argument="BrowseDlg" condition="1" remove="true" /> - <!-- Add new control events for the web dialog --> - <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" - argument="WebFolderDlg" condition="ProductID" /> - <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" - argument="WebFolderDlg" condition="ShowWebFolderDlg <> 1" /> - <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" - argument="WebFolderDlg" condition="ShowWebFolderDlg = 1" /> - <controlevent dialog="WebFolderDlg" control="Cancel" name="SpawnDialog" - argument="CancelDlg" order="0" /> - <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" - argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg<>1" - order="0" /> - <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" - argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg=1" - order="0" /> - <!-- Virtual Directory Control Events --> - <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" - argument="WEBCA_CreateURLs" condition="1" order="0" /> - <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" - argument="WEBCA_EvaluateURLsMB" condition="1" order="1" /> - <controlevent dialog="WebFolderDlg" control="Next" name="SetTargetPath" - argument="TARGETDIR" condition="1" order="2" /> - <controlevent dialog="WebFolderDlg" control="Next" name="NewDialog" - argument="SetupTypeDlg" condition="1" order="3" /> - </controlevents> - - - - - - - - Makes modifications to the Windows Registry of the target computer - at runtime. - -

Parameters

- - - Attribute - Type - Description - Required - - - component - string - Refrence to a component. The component that controls the installation of the registry value. - True - - - root - msi:MSIRegistryKeyRoot - Valid input: - - dependent - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1. - machine represents HKEY_LOCAL_MACHINE - classes represents HKEY_CLASSES_ROOT - user represents HKEY_CURRENT_USER - users represents HKEY_USERS - - - True - - - path - string - Registry key. - True - - -

Nested Elements:

-

<value>

-
    - Specifies the registry value to add to the target machine. - - - Attribute - Type - Description - Required - - - name - string - The registry value name (localizable). If this is Null, then the data entered into the Value column are - written to the default registry key.
    - If the Value column is Null, then the strings shown in the following table in the Name column have special - significance. - - - String - Description - - - + - The key is to be created, if absent, when the component is installed. - - - - - The key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled. - - - * - The key is to be created, if absent, when the component is installed. Additionally, the key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled. - - -     - False -     - - value - string - The localizable registry value. The field is Formatted. If the value is attached to one of the following prefixes (i.e. #%value) then the value is interpreted as described in the table. Note that each prefix begins with a number sign (#). If the value begins with two or more consecutive number signs (#), the first # is ignored and value is interpreted and stored as a string. - - - Prefix - Description - - - #x - The value is interpreted and stored as a hexadecimal value (REG_BINARY). - - - #% - The value is interpreted and stored as an expandable string (REG_EXPAND_SZ). - - - # - The value is interpreted and stored as an integer (REG_DWORD). - - - - If the value contains the sequence tilde [~], then the value is interpreted as a Null-delimited list of strings (REG_MULTI_SZ). For example, to specify a list containing the three strings a, b and c, use "a[~]b[~]c." - The sequence [~] within the value separates the individual strings and is interpreted and stored as a Null character. - If a [~] precedes the string list, the strings are to be appended to any existing registry value strings. If an appending string already occurs in the registry value, the original occurrence of the string is removed. - If a [~] follows the end of the string list, the strings are to be prepended to any existing registry value strings. If a prepending string already occurs in the registry value, the original occurrence of the string is removed. - If a [~] is at both the beginning and the end or at neither the beginning nor the end of the string list, the strings are to replace any existing registry value strings. - Otherwise, the value is interpreted and stored as a string (REG_SZ). - - - False - - - dword - string - A dword value to input, if the value attribute is null. This removes the requirement of adding "#" before the value. - False - - - id - string - Primary key used to identify a registry record. - False - -     -
-

</value>

-

Examples

- - Add the a couple registry entries on the target machine. - - <registry> - <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > - <value name="ProductVersion" value="1.0.0" /> - <value name="ProductDir" value="[TARGETDIR]" /> - <value name="VirtualDir" value="[TARGETVDIR]" /> - </key> - </registry> - - - - Add a default key value to the specified registry key path - - <registry> - <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > - <value value="1.0.0" /> - </key> - </registry> - - - - Another way to add a default key value to the specified registry key path - - <registry> - <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > - <value name="" value="1.0.0" /> - </key> - </registry> - - - - Specify hexadecimal value (REG_BINARY) for the default key - - <registry> - <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > - <value> - 1a,81,0a,03,01,00,06,00,00,00,d3,15,fd,00,01,00,00,00,00,00,01, - 00,00,00,00,00,00,00,00,00,00,00,b0,90,ce,09,01,00,00,00,00,00,ff,ff,ff,00, - 00,00,00,00,00,00,00,00,6d,7a,0a,03,01,00,00,00,00,00,00,00,38,40,00,00,00, - 00,00,00,00,00,00,00,00,00,90,01,00,00,00,00,00,01,00,00,00,00,0f,00,00,00, - f0,ff,ff,ff,54,69,6d,65,73,20,4e,65,77,20,52,6f,6d,61,6e,f4,6f,d4,08,02,00 - </value> - </key> - </registry> - - - - - - - - Stores icons to be used with shortcuts, file extensions, CLSIDs or - similar uses. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Name of the icon file. - True - - - value - string - The binary icon data in PE (.dll or .exe) or icon (.ico) format. - True - - -

Examples

- - Add a compiled help icon to the msi database; To be used with a shortcut. - - <icons> - <icon name="CHMICON" value="${resource.dir}\chm.ico" /> - </icons> - - - - - - - - Creates shortcuts on the target computer. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Unique name identifying the shortcut. - True - - - directory - string - Reference to a directory. The location of where the shortcut should be created. - True - - - filename - string - The localizable name of the shortcut to be created. - True - - - component - string - Reference to a component. The installer uses the installation state of this specified component to determine whether the shortcut is created or deleted. This component must have a valid key path for the shortcut to be installed. If the Target column contains the name of a feature, the file launched by the shortcut is the key file of the component listed in this column. - True - - - target - string - The shortcut target. The installer evaluates this field as a Formatted string. The field should contains a property identifier enclosed by square brackets ([ ]), that is expanded into the file or a folder pointed to by the shortcut. - True - - - arguments - string - The command-line arguments for the shortcut.
Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved if the property already has the intended value when the component owning the shortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the file MyDoc.doc and the component that owns the shortcut. - - False - - - hotkey - string - The hotkey for the shortcut. The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags. This must be a non-negative number. Authors of installation packages are generally recommend not to set this option, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for users using hotkeys for accessibility. - False - - - icon - string - Reference to an icon. - False - - - iconindex - int - The icon index for the shortcut. This must be a non-negative number. - False - - - showcmd - int - The Show command for the application window.
The following values may be used. The values are as defined for the Windows API function ShowWindow. - - - Value - Description - - - 1 - SW_SHOWNORMAL - - - 3 - SW_SHOWMAXIMIZED - - - 7 - SW_SHOWMINNOACTIVE - - - - False - - - wkdir - string - The name of the property that has the path of the working directory for the shortcut. - False - - -

Nested Elements:

-

<description>

-
    - The localizable description of the shortcut. -
-

</description>

-

Examples

- - Add a compiled help icon to the msi database; To be used with a shortcut. - - <shortcuts> - <shortcut name="HelpFiles" directory="D__PROGRAMMENU_ACME_MYPRODUCT" filename="Help File" component="C__MainFiles" target="[$C__MainFiles]\Help.chm" icon="CHMICON" iconindex="0" showcmd="3" > - <description>My Product help documentation</description> - </shortcut> - </shortcuts> - - - - - - - - Stores the binary data for items such as bitmaps, animations, and - icons. The binary table is also used to store data for custom - actions. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A unique key that identifies the particular binary data. If the binary data is for a control, the key appears in the Text column of the associated control in the Control table. This key must be unique among all controls requiring binary data. - True - - - value - string - The binary file to add. - True - - -

Examples

- - Add the custom action dll to create/modify virtual directories - - <binaries> - <binary name="MSVBDPCADLL" value="${resource.dir}\MSVBDPCA.DLL" /> - </binaries> - - - - - - - - Used to configure executables that may be run during steps in the - installation process to do things outside the bounds of MSI - technology's feature set. This is the main spot you can extend MSI - technology to perform custom processes via compiled code. - -

Parameters

- - - Attribute - Type - Description - Required - - - action - string - Name of the action. The action normally appears in a sequence table unless it is called by another custom action. If the name matches any built-in action, then the custom action is never called. - True - - - type - string - A field of flag bits specifying the basic type of custom action and options. See Summary List of All Custom Action Types for a list of the basic types. See Custom Action Return Processing Options, Custom Action Execution Scheduling Options, Custom Action Hidden Target Option, and Custom Action In-Script Execution Options. - True - - - source - string - A property name or external key into another table. For a discussion of the possible custom action sources, see Custom Action Sources and the Summary List of All Custom Action Types. For example, the Source column may contain an external key into the first column of one of the following tables containing the source of the custom action code.
- Directory table for calling existing executables.
- File table for calling executables and DLLs that have just been installed.
- Binary table for calling executables, DLLs, and data stored in the database.
- Property table for calling executables whose paths are held by a property. - - True - - - target - string - An execution parameter that depends on the basic type of custom action. See the Summary List of All Custom Action Types for a description of what should be entered in this field for each type of custom action. For example, this field may contain the following depending on the custom action. - - - Target - Custom Action - - - Entry point (required) - Calling a DLL. - - - Executable name with arguments (required) - Calling an existing executable. - - - Command line arguments (optional) - Calling an executable just installed. - - - Target file name (required) - Creating a file from custom data. - - - Null - Executing script code. - - - - True - - -

Examples

- - Add some custom actions related to the virtual directory dialog and custom action. - - <customactions> - <!-- Custom actions creating entry points into the custom action dll specified in the binary table --> - <customaction action="WEBCA_GatherWebFolderProperties" type="1" source="MSVBDPCADLL" target="GatherWebFolderProperties" /> - <customaction action="WEBCA_ApplyWebFolderProperties" type="1537" source="MSVBDPCADLL" target="ApplyWebFolderProperties" /> - <customaction action="WEBCA_RollbackApplyWebFolderProperties" type="1281" source="MSVBDPCADLL" target="RollbackApplyWebFolderProperties" /> - <customaction action="WEBCA_CreateURLs" type="1" source="MSVBDPCADLL" target="CreateURLs" /> - <customaction action="WEBCA_EvaluateURLs" type="1" source="MSVBDPCADLL" target="EvaluateURLs" /> - <customaction action="WEBCA_EvaluateURLsNoFail" type="1" source="MSVBDPCADLL" target="EvaluateURLsNoFail" /> - <customaction action="WEBCA_EvaluateURLsMB" type="1" source="MSVBDPCADLL" target="EvaluateURLsMB" /> - <customaction action="WEBCA_CreateAppRoots" type="1" source="MSVBDPCADLL" target="CreateAppRoots" /> - - <!-- Custom actions to set default control values in the webfolder dialog --> - <customaction action="WEBCA_TARGETVDIR" type="307" source="TARGETVDIR" target="Default VDir" /> - <customaction action="WEBCA_TARGETPORT" type="307" source="TARGETPORT" target="80" /> - </customactions> - - - - - - - - Used to modify the sequence of tasks/events that execute during the - overall installation process. - -

Parameters

- - - Attribute - Type - Description - Required - - - type - msi:MSISequenceTable - Valid inputs: - - installexecute represents InstallExecuteSequence Table. - installui represents InstallUISequence Table - adminexecute represents AdminExecuteSequence Table - adminui represents AdminUISequence Table - advtexecute represents AdvtUISequence Table - - - True - - - action - string - Name of the action to execute. This is either a built-in action or a custom action. - True - - - value - int - Number that determines the sequence position in which this action is to be executed.
- A positive value represents the sequence position. A Null value indicates that the action is not executed. The following - negative values indicate that this action is to be executed if the installer returns the associated termination flag. No - more than one action may have a negative value entered in the Sequence field. - - - Value - Description - - - -1 - Successful completion. - - - -2 - User terminates install. - - - -3 - Fatal exit terminates. - - - -4 - Install is suspended. - - - - True - - - condition - string - This field contains a conditional expression. If the expression evaluates to False, then the action is skipped. If the expression syntax is invalid, then the sequence terminates, returning iesBadActionData. - False - - -

Examples

- - Add the sequences to support virtual directories - - <sequences> - <sequence type="installexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> - <sequence type="installexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> - <sequence type="installexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_GatherWebFolderProperties" value="3701" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_ApplyWebFolderProperties" value="3701" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_RollbackApplyWebFolderProperties" value="3701" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_CreateAppRoots" value="3701" condition="NOT Installed" /> - <sequence type="installui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> - <sequence type="installui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> - <sequence type="installui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> - <sequence type="installui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> - <sequence type="adminexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> - <sequence type="adminexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> - <sequence type="adminexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> - <sequence type="adminexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /> - <sequence type="adminui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> - <sequence type="adminui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> - <sequence type="adminui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> - <sequence type="adminui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> - </sequences> - - - - - - - - Creates text to be displayed in a progress dialog box and written - to the log for actions that take a long time to execute. The text - displayed consists of the action description and optionally formatted - data from the action. The entries in the ActionText table typically - refer to actions in sequence tables. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Unique name identifying the action. - True - - - template - string - A localized format template is used to format action data records for display during action execution. If no template is supplied, then the action data will not be displayed. - False - - -

Nested Elements:

-

<description>

-
    - Localized description displayed in the progress dialog box or written to the log when the action is executing. -
-

</description>

-

Examples

- - Add the related action text for the web folder actions. - - <actiontext> - <action name="WEBCA_GatherWebFolderProperties" > - <description>Gathering web folder properties</description> - </action> - <action name="WEBCA_ApplyWebFolderProperties" > - <description>Applying web folder properties</description> - </action> - <action name="WEBCA_RollbackApplyWebFolderProperties" > - <description>Removing web folder properties</description> - </action> - <action name="WEBCA_CreateURLs" > - <description>Creating URLs</description> - </action> - <action name="WEBCA_EvaluateURLs" > - <description>Evaluating URLs</description> - </action> - <action name="WEBCA_EvaluateURLsNoFail" > - <description>Evaluating URLs and do not fail if URL is invalid</description> - </action> - <action name="WEBCA_EvaluateURLsMB" > - <description>Evaluating URLs</description> - </action> - <action name="WEBCA_CreateAppRoots" > - <description>Creating application roots</description> - </action> - <action name="WEBCA_TARGETVDIR" > - <description>Set TARGETVDIR property to the specified virtual dir</description> - </action> - <action name="WEBCA_TARGETPORT" > - <description>Set TARGETPORT property to the specified virtual dir port</description> - </action> - </actiontext> - - - - - - - - Adds Verbs and a handler for the specified file type. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - directory - string - Refrence to a directory. The directory to add the specific verb/handler to IIS for the specified file type. - True - - - extension - string - File name extension to specifically handle - False - - - exepath - string - Path to the Internet Server API (ISAPI) or Common Gateway Interface (CGI) program to run to process a request. - False - - - verbs - string - Internet Information Services verbs that are allowed for the executable file. Only verbs entered in this field will be allowed. - False - - -

Examples

- - Add the aspx app mapping - - <appmappings> - <appmapping directory="D__ACME_MyProduct" extension=".aspx" exepath="[DOTNETFOLDER]aspnet_isapi.dll" verbs="GET,HEAD,POST,DEBUG" /> - </appmappings> - - - - - - - - Determines the local path equivalent for a url and stores this - information in a property. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - The name of the URLProperty to convert - True - - - property - string - The name of the property to store the directory information. - True - - -

Examples

- - Convert the TARGETURL property to a directory and store that information in TARGETDIR - - <urlproperties> - <urlproperty name="TARGETURL" property="TARGETDIR" /> - </urlproperties> - - - - - - - - Creates a URLProperty representing the virtual directory and port. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Property containing the virtual directory - True - - - portproperty - string - Property containing the network port number to use. - True - - - urlproperty - string - URLProperty to store the url in - True - - -

Examples

- - Convert the virtual directory and port to a url and store the value in a property. - - <vdirproperties> - <vdirproperty name="TARGETVDIR" portproperty="TARGETPORT" urlproperty="TARGETURL" /> - </vdirproperties> - - - - - - - - Create a Web application definition and marks it as running in-process - or out-of-process. If an application already exists at the specified - path, you can use this method to reconfigure the application from - in-process to out-of-process, or the reverse. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - component - string - Reference to a component. Determines when the approot will be created. - True - - - urlproperty - string - URLProperty with stored url - True - - - inprocflag - int - Specifies whether the application being created is to run in-process (0), out-of-process (1), or in a pooled process (2). If the application already exists and is running, changing the value of this flag will cause the application definition to be deleted and a new application created to run in the specified process space. - True - - -

Examples

- - Convert the virtual directory and port to a url and store the value in a property. - - <approots> - <approot component="C__MainFiles" urlproperty="TARGETURL" inprocflag="2" /> - </approots> - - - - - - - - Specifies directory security in IIS. Can also configure the default - documents supported by each directory. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - directory - string - Reference to a directory. This is the directory that gets modified with the specific attributes. - True - - - attr - int - Attributes to set for the directory. - - - Value - Flag Name - Description - - - 1 - AccessRead - The file or the contents of the folder may be read through Microsoft Internet Explorer. - - - 2 - AccessWrite - Users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. Write can be implemented only with a browser that supports the PUT feature of the HTTP 1.1 protocol standard. - - - 4 - AccessExecute - The file or the contents of the folder may be executed, regardless of file type. - - - 8 - AccessSSL - File access requires SSL file permission processing, with or without a client certificate. - - - 16 - AccessSource - Users are allowed to access source code if either Read or Write permissions are set. Source code includes scripts in Microsoft ® Active Server Pages (ASP) applications. - - - 32 - AccessSSLNegotiateCert - SSL file access processing requests a certificate from the client. A value of false indicates that access continues if the client does not have a certificate. Some versions of Internet Explorer will close the connection if the server requests a certificate and a certificate is not available (even if AccessSSLRequireCert is also set to true). - - - 64 - AccessSSLRequireCert - SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. AccessSSLNegotiateCert must also be set to true when using AccessSSLRequireCert. - - - 128 - AccessSSLMapCert - SSL file permission processing maps a client certificate to a Microsoft Windows ® operating system user-account. The AccessSSLNegotiateCert property must also be set to true for the mapping to occur. - - - 256 - AccessSSL128 - File access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate. - - - 512 - AccessScript - The file or the contents of the folder may be executed if they are script files or static content. A value of false only allows static files, such as HTML files, to be served. - - - 1024 - AccessNoRemoteWrite - Remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests. - - - 4096 - AccessNoRemoteRead - Remote requests to view files are denied; only requests from the same computer as the IIS server succeed if the AccessRead property is set to true. You cannot set AccessNoRemoteRead to false to enable remote requests, and set AccessRead to false to disable local requests. - - - 8192 - AccessNoRemoteExecute - Remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if the AccessExecute property is set to true. You cannot set AccessNoRemoteExecute to false to enable remote requests, and set AccessExecute to false to disable local requests. - - - 16384 - AccessNoRemoteScript - Requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests. - - - 32768 - AccessNoPhysicalDir - Access to the physical path is not allowed. - - - - True - - - defaultdoc - string - Adds a filename to the Default Documents to process. Add multiple separated with a comma (Eg. "Default.aspx,Default.htm") - False - - -

Examples

- - Specify permissions for the directory structure. - - <iisproperties> - <iisproperty directory="TARGETDIR" attr="626" defaultdoc="Default.aspx" /> - <iisproperty directory="D__BIN" attr="112" /> - <iisproperty directory="D__SomeSubDir" attr="114" /> - </iisproperties> - - - - - - - Summary description for MsiTaskInfo. - - - - - Loads the banner image. - - The MSI database. - - - - Loads the background image. - - The MSI database. - - - - Loads the license file. - - The MSI database. - - - - Loads records for the Media table. - - The MSI database. - The sequence number of the last file in the .cab. - - - - Loads records for the Features table. - - The MSI database. - - - - Adds a feature record to the Features table. - - The MSI database Feature table. - The MSI database Condition table. - The name of this feature's parent. - The MSI database. - This Feature's Schema element. - The tree depth of this feature. - The tree order of this feature. - - - - Loads records for the LaunchCondition table - - The MSI database. - - - - Merges Merge Modules into the MSI Database. - - The MSI Database. - The path to temporary files. - - - - Creates a Windows Installer (also known as Microsoft Installer, or MSI) - setup database for installing software on the Windows Platform. - - - - Requires cabarc.exe in the path. This tool is part of the - Microsoft Cabinet SDK. - - - Requires mergemod.dll version 2.0 or greater. This dll is part of the - Microsoft Platform SDK. - - - See the Roadmap to Windows Installer Documentation - at Microsoft's MSDN website for more information. - - - - - - Initializes task and verifies parameters. - - - - - Executes the task. - - - - - An .rtf (rich text format) file containing the license agreement - for your software. The contents of this file will be displayed to - the user when setup runs and must be accepted to continue. - - - - - A .bmp (bitmap) file 495x60 pixels in size that will be displayed - as the banner (top) image of the installation user interface. - - - - - A .bmp (bitmap) file 495x315 pixels in size that will be displayed - as the background image of the installation user interface. - - - - - - Groups sets of components into named sets, these can be used to - layout the tree control that allows users to select and deselect - features of your software product when a custom installation is - selected at runtime. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the feature. - True - - - display - int - The number in this field specifies the order in which the feature is to be displayed in the user interface. - The value also determines if the feature is initially displayed expanded or collapsed.
- If the value is null or zero, the record is not displayed. If the value is odd, the feature node is expanded initially. - If the value is even, the feature node is collapsed initially. - - True - - - title - string - Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog. - False - - - typical - bool - Determines if the feature should be included in a "typical" install. This is useful for when the user selects to just install the typical features. - False - - - directory - string - Refrence to a directory. Specify a corresponding directory to go with the feature. - False - - - attr - int - Any combination of the following: - - - Value - Description - - - 0 - Components of this feature that are not marked for installation from source are installed locally. - - - 1 - Components of this feature not marked for local installation are installed to run from the source CD-ROM or server. - - - 2 - Set this attribute and the state of the feature is the same as the state of the feature's parent. - - - 4 - Set this attribute and the feature state is Advertise. - - - 8 - Note that this bit works only with features that are listed by the ADVERTISE property.
Set this attribute to prevent the feature from being advertised. - - - 16 - Set this attribute and the user interface does not display an option to change the feature state to Absent. Setting this attribute forces the feature to the installation state, whether or not the feature is visible in the UI. - - - 32 - Set this attribute and advertising is disabled for the feature if the operating system shell does not support Windows Installer descriptors. - - - More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp - - False - - -

Nested Elements:

-

<feature>

-
    - Nested feature elements are supported. -
-

</feature>

-

<description>

-
    - Longer string of text describing the feature. This localizable string is displayed by the Text control of the Selection Dialog. -
-

</description>

-

<conditions>

-
    -

    <condition>

    -
      - - - Attribute - Type - Description - Required - - - expression - string - If this conditional expression evaluates to TRUE, then the Level column in the Feature table is set to the - conditional install level.
      - The expression in the Condition column should not contain reference to the installed state of any feature or component. - This is because the expressions in the Condition column are evaluated before the installer evaluates the installed - states of features and components. Any expression in the Condition table that attempts to check the installed state - of a feature or component always evaluates to false.
      - For information on the syntax of conditional statements, see Conditional Statement Syntax. -       - True -       - - level - int - The installer sets the install level of this feature to the level specified in this column if the expression in - the Condition column evaluates to TRUE. Set this value to 0 to have the component not install if the condition is not met.
      - For any installation, there is a defined install level, which is an integral value from 1 to 32,767. The initial value - is determined by the InstallLevel property, which is set in the Property table.
      - A feature is installed only if the feature level value is less than or equal to the current install level. The user - interface can be authored such that once the installation is initialized, the installer allows the user to modify the - install level of any feature in the Feature table. For example, an author can define install level values that represent - specific installation options, such as Complete, Typical, or Minimum, and then create a dialog box that uses - SetInstallLevel ControlEvents to enable the user to select one of these states. Depending on the state the user selects, - the dialog box sets the install level property to the corresponding value. If the author assigns Typical a level of 100 - and the user selects Typical, only those features with a level of 100 or less are installed. In addition, the Custom - option could lead to another dialog box containing a Selection Tree control. The Selection Tree would then allow the user - to individually change whether each feature is installed.       - True -       -       -
    -

    </condition>

    -
-

</conditions>

-

Examples

- - Define a sample features structure. - - <features> - <feature name="F__Default" title="My Product" display="1" typical="true" directory="TARGETDIR"> - <description>My Product from ACME, Inc. </description> - <feature name="F__MainFiles" display="0" typical="true" /> - </feature> - <feature name="F__Help" title="My Product Help Files" display="1" typical="false" directory="D__ACME_MyProduct_Help" /> - </features> - - - - - - Includes pre-packaged installation components (.msm files) as part - of the msi database. This feature allows reuse of installation - components that use MSI technology from other setup vendors or as - created by the . + Name/value pairs which will be set in the PROPERTY table of the + installer database. + + + The properties element contains within it one to any number of property elements.
+ Public property names cannot contain lowercase letters.
+ Private property names must contain some lowercase letters.
+ Property names prefixed with % represent system and user environment variables. These are + never entered into the Property + table. The permanent settings of environment variables can only be modified using the Environment Table. + More information is available here.

Parameters

@@ -5624,39 +2668,3068 @@ Required - feature + name string - Refrence to a feature. Used to associate the merge module with the feature (and the feature's directory) for when to install the components in the merge module. + A name used to refer to the property. + True + + + value + string + The value of the property. This value can contain references to other, predefined properties to build a compound property. True -

Nested Elements:

-

<modules>

-
    - Specifies the merge module(s) to include with the specified feature. -
-

</modules>

-

<configurationitems>

-
    -

    <configurationitem>

    -
      - Specifies the value for a configurable item -

      Parameters

      - - - Attribute - Type - Description - Required - - - module - string - Merge module filename to limit the configuration item to. If this is not set, the configuration item will be applied to all merge modules in the fileset. - True - - - name +

      Examples

      + + Define the required properties. + + <properties> + <property name="ProductName" value="My Product" /> + <property name="ProductVersion" value="1.0.0" /> + <property name="Manufacturer" value="ACME Inc." /> + <property name="ProductCode" value="{29D8F096-3371-4cba-87E1-A8C6511F7B4C}" /> + <property name="UpgradeCode" value="{69E66919-0DE1-4280-B4C1-94049F76BA1A}" /> + </properties> + + +
+ + + + + Contains within it one to any number of app, registry, ini, or dirfile elements. + These elements are used to search for an existing filesystem directory, file, or + Windows Registry setting. A property in the installer database is + then set with the value obtained from the search. + +

<app>

+ + More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/complocator_table.asp + + + + Attribute + Type + Description + Required + + + componentid + string + The component ID of the component whose key path is to be used for the search. + True + + + type + msi:MSILocatorTypeDirFile + Valid input: file or directory + True + + + setproperty + string + A name used to refer to the property within the Msi database. Set at install time. + True + + +

</app>

+

<registry>

+ + More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/reglocator_table.asp + + + + Attribute + Type + Description + Required + + + type + msi:MSILocatorTypeDirFileReg64 + Valid input: registry, file, directory, 64bit + True + + + path + string + Depending on the type specified: + + Path is a directory. + Path is a registry key. + + + True + + + root + msi:MSIRegistryKeyRoot + Valid input: + + dependent - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1. + machine represents HKEY_LOCAL_MACHINE + classes represents HKEY_CLASSES_ROOT + user represents HKEY_CURRENT_USER + users represents HKEY_USERS + + + True + + +
    +

    Nested Elements:

    +

    <value>

    +

    Parameters

    + + + Attribute + Type + Description + Required + + + name + string + Depending on the type specified: + + Key path is a file name. + Key path is a registry value. + + + False + + + setproperty + string + A name used to refer to the property within the Msi database. Set at install time. + True + + +

    </value>

    +
+

</registry>

+

<ini>

+ + More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/inilocator_table.asp + + + + Attribute + Type + Description + Required + + + filename + string + The .ini file name. (The .ini file must be present in the default Microsoft Windows directory.) + + True + + + section + string + Section name within the .ini file. + + True + + + key + string + Key value within the section. + + True + + + field + msi:nonNegativeInt + The field in the .ini line. If Field is Null or 0, then the entire line is read. + This must be a non-negative number. + + False + + + type + msi:MSILocatorTypeDirFileRaw + Valid input: file ,directory, or raw + True + + + setproperty + string + A name used to refer to the property within the Msi database. Set at install time. + True + + +

</ini>

+

<dirfile>

+ + More information on these attributes can be found at: + http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/drlocator_table.asp + and + http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/signature_table.asp + + + + Attribute + Type + Description + Required + + + parent + string + An identifier to RegLocator, IniLocator, or CompLocator tables. + If it does not expand to a full path, then all the fixed drives of the user's system are searched by using the Path. +
In order to determine what the key is for a table, prefix the property name assigned + to that locator with SIG_ + + False + + + path + string + the path on the user's system. This is a either a full path or a relative subpath + below the directory specified in the Parent column. + + False + + + depth + msi:nonNegativeInt + The depth below the path that the installer searches for the file or directory. + + False + + + setproperty + string + A name used to refer to the property within the Msi database. Set at install time. + True + + +
    +

    Nested Elements:

    +

    <file>

    +

    Parameters

    + + + Attribute + Type + Description + Required + + + name + string + The name of the file. + True + + + minversion + string + The minimum version of the file, with a language comparison. If this field is + specified, then the file must have a version that is at least equal to MinVersion. + If the file has an equal version to the MinVersion field value but the language + specified in the Languages column differs, the file does not satisfy the signature + filter criteria. + False + + + maxversion + string + The maximum version of the file. If this field is specified, then the file + must have a version that is at most equal to MaxVersion. + False + + + minsize + msi:nonNegativeInt + The minimum size of the file. If this field is specified, then the file + under inspection must have a size that is at least equal to MinSize. This must + be a non-negative number. + False + + + maxsize + msi:nonNegativeInt + The maximum size of the file. If this field is specified, then the file + under inspection must have a size that is at most equal to MaxSize. This must + be a non-negative number. + False + + + mindate + msi:nonNegativeInt + The minimum modification date and time of the file. If this field is + specified, then the file under inspection must have a modification date and time + that is at least equal to MinDate. This must be a non-negative number. + False + + + maxdate + msi:nonNegativeInt + The maximum creation date of the file. If this field is specified, then the + file under inspection must have a creation date that is at most equal to MaxDate. + This must be a non-negative number. + False + + + languages + string + The languages supported by the file. + False + + +

    </file>

    +
+

</dirfile>

+

Examples

+ + Get the path of the web directory and the version of IIS. Create new properties in the Msi file with those values. + + <search> + <registry type="registry" path="Software\Microsoft\InetStp" root="machine" > + <value name="PathWWWRoot" setproperty="IISWWWROOT" /> + </registry> + <registry type="registry" path="SYSTEM\CurrentControlSet\Services\W3SVC\Parameters" root="machine" > + <value name="MajorVersion" setproperty="IISVERSION" /> + </registry> + </search> + + + + Shows two ways to get the default key value for the specified key. Create new properties in the Msi file with those values. + + <search> + <registry type="registry" path="Software\Microsoft\MessengerService" root="machine" > + <value setproperty="MSGSRVNAME" /> + <value name="" setproperty="MSGSRVNAME2" /> + </registry> + </search> + + + + + + + + Contains within it one to any number of launchcondition elements. + Launch conditions are conditions that all must be satisfied for the + installation to begin. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to identify the launch condition. + True + + + condition + string + Expression that must evaluate to True for installation to begin. + True + + +

Nested Elements:

+

<description>

+
    + Localizable text to display when the condition fails and the installation must be terminated. +
+

</description>

+

Examples

+ + Create a check to make sure that IIS 5.x is installed. + + <launchconditions> + <launchcondition name="CheckIIS" condition="(IISVERSION = &quot;#5&quot;)" > + <description> + This setup requires Internet information Server 5.x. Please install Internet Information Server and run this setup again. + </description> + </launchcondition> + </launchconditions> + + + + + + + + Creates custom tables not directly managed by default features of + the installer task. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A unique name used to identify the table. + True + + +

Nested Elements:

+

<columns>

+
    +

    <column>

    +
      + Defines the columns making up the table +

      Parameters

      + + + Attribute + Type + Description + Required + + + name + string + A unique name used to define the column. + True + + + nullable + bool + When set to true, allows the column to accept null values; false does not allow null values. + True + + + category + msi:MSITableColumnCategoryType + Valid input: + + Text + UpperCase + LowerCase + Integer + DoubleInteger + Time/Date + Identifier + Property + Filename + WildCardFilename + Path + Paths + AnyPath + DefaultDir + RegPath + Formatted + Template + Condition + GUID + Version + Language + Binary + Cabinet + Shortcut + + More information here: http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp + + False + + + type + string + Overrides the category specification. An example of valid input would be: S255 + False + + + key + bool + When set to true, the column is used to form the primary key for the table; false specifies that the column is not used to form the primary key. + False + + + minvalue + int + This field applies to columns having numeric value. The field contains the minimum permissible value. This can be the minimum value for an integer or the minimum value for a date or version string. + False + + + maxvalue + int + This field applies to columns having numeric value. The field is the maximum permissible value. This may be the maximum value for an integer or the maximum value for a date or version string. + False + + + keytable + string + This field applies to columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. This can be a list of tables separated by semicolons. + False + + + keycolumn + int + This field applies to table columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. The permissible range of the KeyColumn field is 1-32. + False + + + set + string + This is a list of permissible values for this field separated by semicolons. This field is usually used for enums. + False + + + description + string + A description of the data that is stored in the column. + False + + +
    +

    </column>

    +
+

</columns>

+

<rows>

+
    +

    <row>

    +
      + Defines the data for a row in the table +

      <columns>

      +
        +

        <column>

        +
          + Defines data for a specific cell in the row +

          Parameters

          + + + Attribute + Type + Description + Required + + + name + string + Name of the column to populate. + True + + + value + string + Value to populate the cell with. + True + + +
        +

        </column>

        +
      +

      </columns>

      +
    +

    </row>

    +
+

</rows>

+

Examples

+ + + Build the IniFile table. Since the WriteIniValues and RemoveIniValues actions exist in the template, they will use this table. + + + <tables> + <table name="IniFile"> + <columns> + <column name="IniFile" nullable="false" category="Identifier" key="true" description="The key for this table." /> + <column name="FileName" nullable="false" category="Text" description="The localizable name of the .ini file in which to write the information. " /> + <column name="DirProperty" nullable="true" category="Identifier" description="Name of a property having a value that resolves to the full path of the folder containing the .ini file. " /> + <column name="Section" nullable="false" category="Formatted" description="The localizable .ini file section." /> + <column name="Key" nullable="false" category="Formatted" description="The localizable .ini file key within the section" /> + <column name="Value" nullable="false" category="Formatted" description="The localizable value to be written. " /> + <column name="Action" nullable="false" category="Integer" description="The type of modification to be made. " /> + <column name="Component_" nullable="false" category="Identifier" description="External key into the first column of the Component table referencing the component that controls the installation of the .ini value. " /> + </columns> + <rows> + <row> + <columns> + <column name="IniFile" value="MyInternetShortcut" /> + <column name="FileName" value="MyInternetAddr.url" /> + <column name="DirProperty" value="D__MYDIR" /> + <column name="Section" value="InternetShortcut" /> + <column name="Key" value="URL" /> + <column name="Value" value="[TARGETURL]" /> + <column name="Action" value="0" /> + <column name="Component_" value="C__Documentation" /> + </columns> + </row> + </rows> + </table> + </tables> + + + + + + + + Specifies the directory layout for the product. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the directory. + True + + + foldername + string + The directory's name (localizable)under the parent directory. + True + + + root + string + A reference to the directory's parent directory. This can be a property name or one of the predefined directories included with the default template: + + AdminToolsFolder + AppDataFolder + CommonAppDataFolder + CommonFiles64Folder + CommonFilesFolder + DesktopFolder + FavoritesFolder + FontsFolder + LocalAppDataFolder + MyPicturesFolder + PersonalFolder + ProgramFilesFolder + ProgramMenuFolder + ProgramFiles64Folder + SendToFolder + StartMenuFolder + StartupFolder + System16Folder + System64Folder + SystemFolder + TARGETDIR + TempFolder + TemplateFolder + WindowsFolder + WindowsVolume + + + True + + +

Nested Elements:

+

<directory>

+
    + Sub directories. Note, this element can contain nested <directory/> sub elements. +

    Parameters

    + + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the directory. + True + + + foldername + string + The directory's name (localizable)under the parent directory. + True + + +
+

</directory>

+

Examples

+ + Define a sample directory structure. + + <directories> + <directory name="D__ACME" foldername="ACME" root="TARGETDIR" > + <directory name="D__ACME_MyProduct" foldername="My Product" /> + </directory> + </directories> + + + + + + + + Used to modify the environment variables of the target computer at + runtime. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + The localizable name of the environment variable. The key values are written or removed depending upon + which of the characters in the following table are prefixed to the name. There is no effect in the ordering of + the symbols used in a prefix. + + + Prefix + Description + + + = + Create the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation. + + + + + Create the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists. + + + - + Remove the environment variable when the component is removed. This symbol can be combined with any prefix. + + + ! + Remove the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty. + + + * + This prefix is used with Microsoft® Windows® NT/Windows® 2000 to indicate that the name refers to a system environment variable. If no asterisk is present, the installer writes the variable to the user's environment. Microsoft Windows 95/98 ignores the asterisk and add the environment variable to autoexec.bat. This symbol can be combined with any prefix. A package that is used for per-machine installations should write environment variables to the machine's environment by including * in the Name column. For more information, see http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp + + + =- + The environment variable is set on install and removed on uninstall. This is the usual behavior. + + + !- + Removes an environment variable during an install or uninstall. + + + More information can be found here: http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp + + True + + + append + string + Localizable value that is to be set as a formatted string + True + + + component + string + Refrence to a component. Allows the variabled to be modified when the component is un/installed. + True + + +

Examples

+ + Append the installation path to the user PATH variable. + + <environment> + <variable name="PATH" append="'[TARGETDIR]'" component="C__MainFiles" /> + </environment> + + + + + + + + Groups sets of files into named sets, these can be used to install + and perform operations on a set of files as one entity. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the component. + True + + + id + string + A string GUID unique to this component, version, and language.
Note that the letters of these GUIDs must be + uppercase. Utilities such as GUIDGEN can generate GUIDs containing lowercase letters. The lowercase letters must be + changed to uppercase to make these valid component code GUIDs. + + True + + + attr + int + This column contains a bit flag that specifies options for remote execution. Add the indicated bit to the total value in the column to include an option. + + + Value + Description + + + 0 + Component cannot be run from source.
+ Set this bit for all components belonging to a feature to prevent the feature from being run-from-network or + run-from-source. Note that if a feature has no components, the feature always shows run-from-source and + run-from-my-computer as valid options. + + + + 1 + Component can only be run from source.
+ Set this bit for all components belonging to a feature to prevent the feature from being run-from-my-computer. + Note that if a feature has no components, the feature always shows run-from-source and run-from-my-computer as + valid options. + + + + 2 + Component can run locally or from source. + + + 4 + If this bit is set, the value in the key element is used as a key into the Registry table.
+ If the Value field of the corresponding record in the Registry table is null, the Name field in that record must + not contain "+", "-", or "*". For more information, see the description of the Name field in Registry table.
+ Setting this bit is recommended for registry entries written to the HKCU hive. This ensures the installer writes + the necessary HKCU registry entries when there are multiple users on the same machine. + + + + 16 + If this bit is set, the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings. + + + + 32 + If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table. + + + 64 + If this bit is set, the installer reevaluates the value of the statement in the Condition column + upon a reinstall. If the value was previously False and has changed to True, the installer installs the component. + If the value was previously True and has changed to False, the installer removes the component even if the component + has other products as clients.
This bit should only be set for transitive components. See Using Transitive + Components. + + + + 128 + If this bit is set, the installer does not install or reinstall the component if a key path file or + a key path registry entry for the component already exists. The application does register itself as a client of + the component.
+ Use this flag only for components that are being registered by the Registry table. + + + + 256 + Set this bit to mark this as a 64-bit component. This attribute facilitates the installation of + packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered + as a 32-bit component. + + + + + True + + + directory + string + Refrence to a directory. Defines the directory location for where the files assigned to the component are to be placed. + True + + + feature + string + Refrence to a feature. Maps a feature to the component. Used to determine if the component is to be installed or not. + True + + + condition + string + A conditional statement that can control whether a component is installed. If the condition is null or evaluates to + true, then the component is enabled. If the condition evaluates to False, then the component is disabled and is not + installed. + False + + + fileattr + int + Integer containing bit flags representing file attributes.
+ The following table shows the definition of the bit field. + + + Value + Description + + + 1 + Read-Only + + + 2 + Hidden + + + 4 + System + + + 512 + The file is vital for the proper operation of the component to which it belongs + + + 1024 + The file contains a valid checksum. A checksum is required to repair a file that has become corrupted. + + + 4096 + This bit must only be added by a patch and if the file is being added by the patch. + + + 8192 + The file's source type is uncompressed. If set, ignore the Word Count Summary Property. + If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression + state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed + and msidbFileAttributesCompressed. + + + 16384 + The file's source type is compressed. If set, ignore the Word Count Summary Property. + If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of + the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and + msidbFileAttributesCompressed. + + + + False + + + checkinterop + bool + Used to determine if file(s) in the fileset are interop file(s). If true, extra information will be added in the install + package to register each interop file. If false, the file(s) will not be not be checked and the extra registration information + will not be added to the msi. + False + + + installassembliestogac + bool + Used to determine if assemblies should be installed to the Global Assembly Cache. + If true, all assemblies in the fileset will be added to the GAC. If false, the assemblies will be installed + to the specified directory (as a normal file would). Note: If an assembly is specified to be installed into the GAC, it will not + also be installed to the directory specified. + False + + + keepsubdirs + bool + Used to determine if directories in the fileset should be built. + If true, all subdirectories of the fileset basedir will be built. If false the directories structure will be + flattened. The default is false. + False + + +

Nested Elements:

+

<keyfile>

+
    + This value points to a file or folder belonging to the component that the installer uses to detect the component. Two components cannot share the same key path value. +

    Parameters

    + + + Attribute + Type + Description + Required + + + file + string + Name of the key (file) to use. Also, this could be an id of a registry key value. + True + + +
+

</keyfile>

+

<fileset>

+
    + Specifies the files to include with the component +
+

</fileset>

+

<forceid>

+
    + Used to force specific attributes on a per file basis +

    Parameters

    + + + Attribute + Type + Description + Required + + + file + string + Name of the file, in the fileset, to override. + True + + + id + string + Unique GUID to assign to the file. + True + + + attr + int + Integer containing bit flags representing file attributes.
    + The following table shows the definition of the bit field. + + + Value + Description + + + 1 + Read-Only + + + 2 + Hidden + + + 4 + System + + + 512 + The file is vital for the proper operation of the component to which it belongs + + + 1024 + The file contains a valid checksum. A checksum is required to repair a file that has become corrupted. + + + 4096 + This bit must only be added by a patch and if the file is being added by the patch. + + + 8192 + The file's source type is uncompressed. If set, ignore the Word Count Summary Property. + If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression + state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed + and msidbFileAttributesCompressed. + + + 16384 + The file's source type is compressed. If set, ignore the Word Count Summary Property. + If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of + the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and + msidbFileAttributesCompressed. + + +     + False +     + + version + string + This field is the version string for a versioned file. This field is blank for non-versioned files. + False + + + language + string + A list of decimal language IDs separated by commas. + False + + + checkinterop + bool + Used to determine if file is an interop file. If true, extra information will be added in the install + package to register the interop file. If false, the file will not be not be checked and the extra registration information + will not be added to the msi. + False + + + installtogac + bool + If true, and if the file is an assembly, it will be installed to the GAC. If false, the file + will be installed to the directory specified by the component. Note: If an assembly is specified to + be installed into the GAC, it will not also be installed to the directory specified. + False + +     +
+

</forceid>

+

Examples

+ + Define a sample component structure. + + <components> + <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" > + <key file="default.aspx" /> + <fileset basedir="${install.dir}"> + <include name="*.*" /> + </fileset> + </component> + </components> + + + + Install files to TARGETDIR and assemblies to the GAC (Global Assembly Cache). Do not install MyOtherAssembly.dll to the GAC, but rather install it with the other files (to TARGETDIR) + + <components> + <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" installassembliestogac="true" > + <key file="MyAssemblyName.xml" /> + <fileset basedir="${install.dir}"> + <include name="*.*" /> + </fileset> + <forceid file="MyOtherAssembly.dll" id="_4EB7CCB23D394958988ED817DA00B9D1" installtogac="false" /> + </component> + </components> + + + + Assign a registry entry to a specific component. + + <components> + <component name="C__RegistryEntry" id="{06C654AA-273D-4E39-885C-3E5225D9F336}" attr="4" directory="TARGETDIR" feature="F__DefaultFeature" > + <key file="R__822EC365A8754FACBF6C713BFE4E57F0" /> + </component> + </components> + . + . + . + <registry> + <key path="SOFTWARE\MyCompany\MyProduct\" root="machine" component="C__RegistryEntry"> + <value id="R__822EC365A8754FACBF6C713BFE4E57F0" name="MyKeyName" value="MyKeyValue" /> + </key> + </registry> + + + + + + + + Creates custom dialogs that can gather information not handled by + the default installer template. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the dialog. + True + + + hcenter + int + Horizontal position of the dialog box. The range is 0 to 100, with 0 at the left edge of the screen and 100 at the right edge. + True + + + vcenter + int + Vertical position of the dialog box. The range is 0 to 100, with 0 at the top edge of the screen and 100 at the bottom edge. + True + + + width + int + Width of the rectangular boundary of the dialog box. This number must be non-negative. + True + + + height + int + Height of the rectangular boundary of the dialog box. This number must be non-negative. + True + + + attr + int + A 32-bit word that specifies the attribute flags to be applied to this dialog box. This number must be non-negative. + + + Value + Description + + + 1 + Visible + + + 2 + Modal + + + 4 + Minimize + + + 8 + SysModal + + + 16 + KeepModeless + + + 32 + TrackDiskSpace + + + 64 + UseCustomPalette + + + 128 + RTLRO + + + 256 + RightAligned + + + 512 + LeftScroll + + + 896 + BiDi + + + 65536 + Error + + + More information here: http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp + + True + + + title + string + A localizable text string specifying the title to be displayed in the title bar of the dialog box. + True + + + firstcontrol + string + An external key to the second column of the Control table. Combining this field with the Dialog field identifies a + unique control in the Control table. This defines the control that takes the focus when the dialog box is created. This + column is ignored in an Error dialog box.
+ Because static text cannot take the focus, a Text control that describes an Edit, PathEdit, ListView, ComboBox or + VolumeSelectCombo control must be made the first control in the dialog box to ensure compatibility with screen readers. + + True + + + defaultcontrol + string + An external key to the second column of the Control table. Combining this field with the Dialog field results in + a primary key into the Control table that defines the default control. Hitting the Return key is equivalent to clicking + on the default control. If this column is left blank, then there is no default control. This column is ignored in the + Error dialog box. + + True + + + cancelcontrol + string + An external key to the second column of the Control table. Combining this field with the Dialog field results in + a primary key of the Control table that defines the cancel control. Hitting the ESC key or clicking the Close button in + the dialog box is equivalent to clicking on the cancel control. This column is ignored in an Error dialog box.
+ The cancel control is hidden during rollback or the removal of backed up files. The protected UI handler hides the control + upon receiving a INSTALLMESSAGE_COMMONDATA message. + + True + + +

Examples

+ + Add a web folder dialog: + + <dialogs> + <dialog name="WebFolderDlg" hcenter="50" vcenter="50" width="370" height="270" attr="39" title="[ProductName] [Setup]" firstcontrol="Next" defaultcontrol="Next" cancelcontrol="Cancel" /> + </dialogs> + + + + + + + + Creates user interface controls displayed on custom dialogs. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes. + True + + + dialog + string + Refrence to a dialog. Used to associate the control with the dialog. + True + + + type + string + The type of the control. + + + Control name + Description + + + Billboard + Displays billboards based on progress messages. + + + Bitmap + Displays a static picture of a bitmap. + + + CheckBox + A two-state check box. + + + ComboBox + A drop-down list with an edit field. + + + DirectoryCombo + Select all except the last segment of the path. + + + DirectoryList + Displays folders below the main part of path. + + + Edit + A regular edit field for any string or integer. + + + GroupBox + Displays a rectangle that groups other controls together. + + + Icon + Displays a static picture of an icon. + + + Line + Displays a horizontal line. + + + ListBox + A drop-down list without an edit field. + + + ListView + Displays a column of values with icons for selection. + + + MaskedEdit + An edit field with a mask in the text field. + + + PathEdit + Displays folder name or entire path in an edit field. + + + ProgressBar + Bar graph that changes length as it receives progress messages. + + + PushButton + Displays a basic push button. + + + RadioButtonGroup + A group of radio buttons. + + + ScrollableText + Displays a long string of text. + + + SelectionTree + Displays information from the Feature table and enables the user to change their selection state. + + + Text + Displays static text. + + + VolumeCostList + Displays costing information on different volumes. + + + VolumeSelectCombo + Selects volume from an alphabetical list. + + + More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp + True + + + x + int + Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. + True + + + y + int + Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. + True + + + width + int + Width of the rectangular boundary of the control. This must be a non-negative number. + True + + + height + int + Height of the rectangular boundary of the control. This must be a non-negative number. + True + + + attr + int + A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see Control Attributes. + True + + + property + string + The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls. + False + + + text + string + A localizable string used to set the initial text contained in a control. The string can also contain embedded properties. + False + + + nextcontrol + string + The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. + False + + + help + string + Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present. + False + + + remove + bool + If true, the control is removed. If false, the control is added. + False + + +

Examples

+ + Remove the Browse button from the customize dialog and add controls for a web dialog + + <controls> + <!-- Remove the Browse button from customize dialog --> + <control dialog="CustomizeDlg" name="Browse" type="PushButton" + x="304" y="200" width="56" height="17" attr="3" remove="true" /> + <control dialog="CustomizeDlg" name="Tree" type="SelectionTree" + x="25" y="85" width="175" height="95" attr="7" remove="true" /> + + <!-- Re add the tree control with the proper next control --> + <control dialog="CustomizeDlg" name="Tree" type="SelectionTree" + x="25" y="85" width="175" height="95" attr="7" + property="_BrowseProperty" text="Tree of selections" nextcontrol="Reset" /> + + <!-- Adds the controls associated with the webfolder dialog --> + <control dialog="WebFolderDlg" name="BannerBitmap" type="Bitmap" + x="0" y="0" width="374" height="44" attr="1" + text="[BannerBitmap]" nextcontrol="VDirLabel" /> + <control dialog="WebFolderDlg" name="Title" type="Text" + x="15" y="6" width="200" height="15" attr="196611" + text="[DlgTitleFont]Virtual Directory Information" /> + <control dialog="WebFolderDlg" name="Description" type="Text" + x="25" y="23" width="280" height="15" attr="196611" + text="Please enter your virtual directory and port information." /> + <control dialog="WebFolderDlg" name="BannerLine" type="Line" + x="0" y="44" width="374" height="0" attr="1" /> + <control dialog="WebFolderDlg" name="VDirLabel" type="Text" + x="18" y="73" width="348" height="15" attr="3" + text="&Virtual directory:" + nextcontrol="Edit_VDir" /> + <control dialog="WebFolderDlg" name="Edit_VDir" type="Edit" + x="18" y="85" width="252" height="18" attr="7" + property="TARGETVDIR" + text="[TARGETVDIR]" + nextcontrol="PortLabel" /> + <control dialog="WebFolderDlg" name="PortLabel" type="Text" + x="18" y="110" width="348" height="15" attr="3" + text="&Port:" + nextcontrol="Edit_Port" /> + <control dialog="WebFolderDlg" name="Edit_Port" type="Edit" + x="18" y="122" width="48" height="18" attr="7" + property="TARGETPORT" + text="[TARGETPORT]" + nextcontrol="Back" /> + <control dialog="WebFolderDlg" name="BottomLine" type="Line" + x="0" y="234" width="374" height="0" attr="1" /> + <control dialog="WebFolderDlg" name="Back" type="PushButton" + x="180" y="243" width="56" height="17" attr="3" + text="[ButtonText_Back]" nextcontrol="Next" /> + <control dialog="WebFolderDlg" name="Next" type="PushButton" + x="236" y="243" width="56" height="17" attr="3" + text="[ButtonText_Next]" nextcontrol="Cancel" /> + <control dialog="WebFolderDlg" name="Cancel" type="PushButton" + x="304" y="243" width="56" height="17" attr="3" + text="[ButtonText_Cancel]" nextcontrol="BannerBitmap" /> + </controls> + + + + + + + + Used to validate and perform operations as the result of information + entered by the user into controls on custom dialogs. + +

Parameters

+ + + Attribute + Type + Description + Required + + + dialog + string + Refrence to a dialog. Used to associate the control with the dialog. + True + + + control + string + Refrence to a control. Maps to a control for the specified dialog. + True + + + action + string + The action that is to be taken on the control. The possible actions are shown in the following table. + + + Value + Description + + + Default + Set control as the default. + + + Disable + Disable the control. + + + Enable + Enable the control. + + + Hide + Hide the control. + + + Show + Display the control. + + + + True + + + condition + string + A conditional statement that specifies under which conditions the action should be triggered. If this statement does not evaluate to TRUE, the action does not take place. If it is set to 1, the action is always applied. + True + + + remove + bool + If true, the control condition is removed. If false, the control condition is added. + False + + +

Examples

+ + Remove the control condition for the Browse button from the customize dialog and add control conditions for a web dialog + + <controlconditions> + <!-- Remove control condition for Browse button on customizeDlg --> + <controlcondition dialog="CustomizeDlg" control="Browse" action="Hide" + condition="Installed" remove="true" /> + <!-- Add control conditions for the web folder dialog --> + <controlcondition dialog="WebFolderDlg" control="Back" action="Disable" + condition="ShowUserRegistrationDlg=""" /> + <controlcondition dialog="WebFolderDlg" control="Back" action="Enable" + condition="ShowUserRegistrationDlg<>""" /> + </controlconditions> + + + + + + + + Used to route the flow of the installation process as the result of + events raised by the user interacting with controls on dialogs. + +

Parameters

+ + + Attribute + Type + Description + Required + + + dialog + string + Refrence to a dialog. Used to associate the control with the dialog. + True + + + control + string + Refrence to a control. Maps to a control for the specified dialog. + True + + + name + string + An identifier that specifies the type of event that should take place when the user interacts with the control + specified by Dialog_ and Control_. For a list of possible values see ControlEvent Overview.
+ To set a property with a control, put [Property_Name] in this field and the new value in the argument field. Put { } + into the argument field to enter the null value. + + True + + + argument + string + A value used as a modifier when triggering a particular event. + True + + + condition + string + A conditional statement that determines whether the installer activates the event in the Event column. The installer + triggers the event if the conditional statement in the Condition field evaluates to True. Therefore put a 1 in this column + to ensure that the installer triggers the event. The installer does not trigger the event if the Condition field contains + a statement that evaluates to False. The installer does not trigger an event with a blank in the Condition field unless no + other events of the control evaluate to True. If none of the Condition fields for the control named in the Control_ field + evaluate to True, the installer triggers the one event having a blank Condition field, and if more than one Condition field + is blank it triggers the one event of these with the largest value in the Ordering field. + False + + + order + int + An integer used to order several events tied to the same control. This must be a non-negative number. + False + + + remove + bool + If true, the control condition is removed. If false, the control condition is added. + False + + +

Examples

+ + Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog + + + <controlevents> + <!-- Remove the old control events --> + <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" + argument="SetupTypeDlg" condition="ProductID" remove="true" /> + <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" + argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg <> 1" remove="true" /> + <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" + argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg = 1" remove="true" /> + <!-- Remove control events for Browse button on CustomizeDlg --> + <controlevent dialog="CustomizeDlg" control="Browse" name="SelectionBrowse" + argument="BrowseDlg" condition="1" remove="true" /> + + <!-- Add new control events for the web dialog --> + <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" + argument="WebFolderDlg" condition="ProductID" /> + <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" + argument="WebFolderDlg" condition="ShowWebFolderDlg <> 1" /> + <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" + argument="WebFolderDlg" condition="ShowWebFolderDlg = 1" /> + <controlevent dialog="WebFolderDlg" control="Cancel" name="SpawnDialog" + argument="CancelDlg" order="0" /> + <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" + argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg<>1" + order="0" /> + <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" + argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg=1" + order="0" /> + <!-- Virtual Directory Control Events --> + <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" + argument="WEBCA_CreateURLs" condition="1" order="0" /> + <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" + argument="WEBCA_EvaluateURLsMB" condition="1" order="1" /> + <controlevent dialog="WebFolderDlg" control="Next" name="SetTargetPath" + argument="TARGETDIR" condition="1" order="2" /> + <controlevent dialog="WebFolderDlg" control="Next" name="NewDialog" + argument="SetupTypeDlg" condition="1" order="3" /> + </controlevents> + + + + + + + + Makes modifications to the Windows Registry of the target computer + at runtime. + +

Parameters

+ + + Attribute + Type + Description + Required + + + component + string + Refrence to a component. The component that controls the installation of the registry value. + True + + + root + msi:MSIRegistryKeyRoot + Valid input: + + dependent - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1. + machine represents HKEY_LOCAL_MACHINE + classes represents HKEY_CLASSES_ROOT + user represents HKEY_CURRENT_USER + users represents HKEY_USERS + + + True + + + path + string + Registry key. + True + + +

Nested Elements:

+

<value>

+
    + Specifies the registry value to add to the target machine. + + + Attribute + Type + Description + Required + + + name + string + The registry value name (localizable). If this is Null, then the data entered into the Value column are + written to the default registry key.
    + If the Value column is Null, then the strings shown in the following table in the Name column have special + significance. + + + String + Description + + + + + The key is to be created, if absent, when the component is installed. + + + - + The key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled. + + + * + The key is to be created, if absent, when the component is installed. Additionally, the key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled. + + +     + False +     + + value + string + The localizable registry value. The field is Formatted. If the value is attached to one of the following prefixes (i.e. #%value) then the value is interpreted as described in the table. Note that each prefix begins with a number sign (#). If the value begins with two or more consecutive number signs (#), the first # is ignored and value is interpreted and stored as a string. + + + Prefix + Description + + + #x + The value is interpreted and stored as a hexadecimal value (REG_BINARY). + + + #% + The value is interpreted and stored as an expandable string (REG_EXPAND_SZ). + + + # + The value is interpreted and stored as an integer (REG_DWORD). + + + + If the value contains the sequence tilde [~], then the value is interpreted as a Null-delimited list of strings (REG_MULTI_SZ). For example, to specify a list containing the three strings a, b and c, use "a[~]b[~]c." + The sequence [~] within the value separates the individual strings and is interpreted and stored as a Null character. + If a [~] precedes the string list, the strings are to be appended to any existing registry value strings. If an appending string already occurs in the registry value, the original occurrence of the string is removed. + If a [~] follows the end of the string list, the strings are to be prepended to any existing registry value strings. If a prepending string already occurs in the registry value, the original occurrence of the string is removed. + If a [~] is at both the beginning and the end or at neither the beginning nor the end of the string list, the strings are to replace any existing registry value strings. + Otherwise, the value is interpreted and stored as a string (REG_SZ). + + + False + + + dword + string + A dword value to input, if the value attribute is null. This removes the requirement of adding "#" before the value. + False + + + id + string + Primary key used to identify a registry record. + False + +     +
+

</value>

+

Examples

+ + Add the a couple registry entries on the target machine. + + <registry> + <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > + <value name="ProductVersion" value="1.0.0" /> + <value name="ProductDir" value="[TARGETDIR]" /> + <value name="VirtualDir" value="[TARGETVDIR]" /> + </key> + </registry> + + + + Add a default key value to the specified registry key path + + <registry> + <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > + <value value="1.0.0" /> + </key> + </registry> + + + + Another way to add a default key value to the specified registry key path + + <registry> + <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > + <value name="" value="1.0.0" /> + </key> + </registry> + + + + Specify hexadecimal value (REG_BINARY) for the default key + + <registry> + <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > + <value> + 1a,81,0a,03,01,00,06,00,00,00,d3,15,fd,00,01,00,00,00,00,00,01, + 00,00,00,00,00,00,00,00,00,00,00,b0,90,ce,09,01,00,00,00,00,00,ff,ff,ff,00, + 00,00,00,00,00,00,00,00,6d,7a,0a,03,01,00,00,00,00,00,00,00,38,40,00,00,00, + 00,00,00,00,00,00,00,00,00,90,01,00,00,00,00,00,01,00,00,00,00,0f,00,00,00, + f0,ff,ff,ff,54,69,6d,65,73,20,4e,65,77,20,52,6f,6d,61,6e,f4,6f,d4,08,02,00 + </value> + </key> + </registry> + + + + + + + + Stores icons to be used with shortcuts, file extensions, CLSIDs or + similar uses. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Name of the icon file. + True + + + value + string + The binary icon data in PE (.dll or .exe) or icon (.ico) format. + True + + +

Examples

+ + Add a compiled help icon to the msi database; To be used with a shortcut. + + <icons> + <icon name="CHMICON" value="${resource.dir}\chm.ico" /> + </icons> + + + + + + + + Creates shortcuts on the target computer. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Unique name identifying the shortcut. + True + + + directory + string + Reference to a directory. The location of where the shortcut should be created. + True + + + filename + string + The localizable name of the shortcut to be created. + True + + + component + string + Reference to a component. The installer uses the installation state of this specified component to determine whether the shortcut is created or deleted. This component must have a valid key path for the shortcut to be installed. If the Target column contains the name of a feature, the file launched by the shortcut is the key file of the component listed in this column. + True + + + target + string + The shortcut target. The installer evaluates this field as a Formatted string. The field should contains a property identifier enclosed by square brackets ([ ]), that is expanded into the file or a folder pointed to by the shortcut. + True + + + arguments + string + The command-line arguments for the shortcut.
Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved if the property already has the intended value when the component owning the shortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the file MyDoc.doc and the component that owns the shortcut. + + False + + + hotkey + string + The hotkey for the shortcut. The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags. This must be a non-negative number. Authors of installation packages are generally recommend not to set this option, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for users using hotkeys for accessibility. + False + + + icon + string + Reference to an icon. + False + + + iconindex + int + The icon index for the shortcut. This must be a non-negative number. + False + + + showcmd + int + The Show command for the application window.
The following values may be used. The values are as defined for the Windows API function ShowWindow. + + + Value + Description + + + 1 + SW_SHOWNORMAL + + + 3 + SW_SHOWMAXIMIZED + + + 7 + SW_SHOWMINNOACTIVE + + + + False + + + wkdir + string + The name of the property that has the path of the working directory for the shortcut. + False + + +

Nested Elements:

+

<description>

+
    + The localizable description of the shortcut. +
+

</description>

+

Examples

+ + Add a compiled help icon to the msi database; To be used with a shortcut. + + <shortcuts> + <shortcut name="HelpFiles" directory="D__PROGRAMMENU_ACME_MYPRODUCT" filename="Help File" component="C__MainFiles" target="[$C__MainFiles]\Help.chm" icon="CHMICON" iconindex="0" showcmd="3" > + <description>My Product help documentation</description> + </shortcut> + </shortcuts> + + + + + + + + Stores the binary data for items such as bitmaps, animations, and + icons. The binary table is also used to store data for custom + actions. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A unique key that identifies the particular binary data. If the binary data is for a control, the key appears in the Text column of the associated control in the Control table. This key must be unique among all controls requiring binary data. + True + + + value + string + The binary file to add. + True + + +

Examples

+ + Add the custom action dll to create/modify virtual directories + + <binaries> + <binary name="MSVBDPCADLL" value="${resource.dir}\MSVBDPCA.DLL" /> + </binaries> + + + + + + + + Used to configure executables that may be run during steps in the + installation process to do things outside the bounds of MSI + technology's feature set. This is the main spot you can extend MSI + technology to perform custom processes via compiled code. + +

Parameters

+ + + Attribute + Type + Description + Required + + + action + string + Name of the action. The action normally appears in a sequence table unless it is called by another custom action. If the name matches any built-in action, then the custom action is never called. + True + + + type + string + A field of flag bits specifying the basic type of custom action and options. See Summary List of All Custom Action Types for a list of the basic types. See Custom Action Return Processing Options, Custom Action Execution Scheduling Options, Custom Action Hidden Target Option, and Custom Action In-Script Execution Options. + True + + + source + string + A property name or external key into another table. For a discussion of the possible custom action sources, see Custom Action Sources and the Summary List of All Custom Action Types. For example, the Source column may contain an external key into the first column of one of the following tables containing the source of the custom action code.
+ Directory table for calling existing executables.
+ File table for calling executables and DLLs that have just been installed.
+ Binary table for calling executables, DLLs, and data stored in the database.
+ Property table for calling executables whose paths are held by a property. + + True + + + target + string + An execution parameter that depends on the basic type of custom action. See the Summary List of All Custom Action Types for a description of what should be entered in this field for each type of custom action. For example, this field may contain the following depending on the custom action. + + + Target + Custom Action + + + Entry point (required) + Calling a DLL. + + + Executable name with arguments (required) + Calling an existing executable. + + + Command line arguments (optional) + Calling an executable just installed. + + + Target file name (required) + Creating a file from custom data. + + + Null + Executing script code. + + + + True + + +

Examples

+ + Add some custom actions related to the virtual directory dialog and custom action. + + <customactions> + <!-- Custom actions creating entry points into the custom action dll specified in the binary table --> + <customaction action="WEBCA_GatherWebFolderProperties" type="1" source="MSVBDPCADLL" target="GatherWebFolderProperties" /> + <customaction action="WEBCA_ApplyWebFolderProperties" type="1537" source="MSVBDPCADLL" target="ApplyWebFolderProperties" /> + <customaction action="WEBCA_RollbackApplyWebFolderProperties" type="1281" source="MSVBDPCADLL" target="RollbackApplyWebFolderProperties" /> + <customaction action="WEBCA_CreateURLs" type="1" source="MSVBDPCADLL" target="CreateURLs" /> + <customaction action="WEBCA_EvaluateURLs" type="1" source="MSVBDPCADLL" target="EvaluateURLs" /> + <customaction action="WEBCA_EvaluateURLsNoFail" type="1" source="MSVBDPCADLL" target="EvaluateURLsNoFail" /> + <customaction action="WEBCA_EvaluateURLsMB" type="1" source="MSVBDPCADLL" target="EvaluateURLsMB" /> + <customaction action="WEBCA_CreateAppRoots" type="1" source="MSVBDPCADLL" target="CreateAppRoots" /> + + <!-- Custom actions to set default control values in the webfolder dialog --> + <customaction action="WEBCA_TARGETVDIR" type="307" source="TARGETVDIR" target="Default VDir" /> + <customaction action="WEBCA_TARGETPORT" type="307" source="TARGETPORT" target="80" /> + </customactions> + + + + + + + + Used to modify the sequence of tasks/events that execute during the + overall installation process. + +

Parameters

+ + + Attribute + Type + Description + Required + + + type + msi:MSISequenceTable + Valid inputs: + + installexecute represents InstallExecuteSequence Table. + installui represents InstallUISequence Table + adminexecute represents AdminExecuteSequence Table + adminui represents AdminUISequence Table + advtexecute represents AdvtUISequence Table + + + True + + + action + string + Name of the action to execute. This is either a built-in action or a custom action. + True + + + value + int + Number that determines the sequence position in which this action is to be executed.
+ A positive value represents the sequence position. A Null value indicates that the action is not executed. The following + negative values indicate that this action is to be executed if the installer returns the associated termination flag. No + more than one action may have a negative value entered in the Sequence field. + + + Value + Description + + + -1 + Successful completion. + + + -2 + User terminates install. + + + -3 + Fatal exit terminates. + + + -4 + Install is suspended. + + + + True + + + condition + string + This field contains a conditional expression. If the expression evaluates to False, then the action is skipped. If the expression syntax is invalid, then the sequence terminates, returning iesBadActionData. + False + + +

Examples

+ + Add the sequences to support virtual directories + + <sequences> + <sequence type="installexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> + <sequence type="installexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> + <sequence type="installexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_GatherWebFolderProperties" value="3701" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_ApplyWebFolderProperties" value="3701" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_RollbackApplyWebFolderProperties" value="3701" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_CreateAppRoots" value="3701" condition="NOT Installed" /> + <sequence type="installui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> + <sequence type="installui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> + <sequence type="installui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> + <sequence type="installui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> + <sequence type="adminexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> + <sequence type="adminexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> + <sequence type="adminexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> + <sequence type="adminexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /> + <sequence type="adminui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> + <sequence type="adminui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> + <sequence type="adminui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> + <sequence type="adminui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> + </sequences> + + + + + + + + Creates text to be displayed in a progress dialog box and written + to the log for actions that take a long time to execute. The text + displayed consists of the action description and optionally formatted + data from the action. The entries in the ActionText table typically + refer to actions in sequence tables. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Unique name identifying the action. + True + + + template + string + A localized format template is used to format action data records for display during action execution. If no template is supplied, then the action data will not be displayed. + False + + +

Nested Elements:

+

<description>

+
    + Localized description displayed in the progress dialog box or written to the log when the action is executing. +
+

</description>

+

Examples

+ + Add the related action text for the web folder actions. + + <actiontext> + <action name="WEBCA_GatherWebFolderProperties" > + <description>Gathering web folder properties</description> + </action> + <action name="WEBCA_ApplyWebFolderProperties" > + <description>Applying web folder properties</description> + </action> + <action name="WEBCA_RollbackApplyWebFolderProperties" > + <description>Removing web folder properties</description> + </action> + <action name="WEBCA_CreateURLs" > + <description>Creating URLs</description> + </action> + <action name="WEBCA_EvaluateURLs" > + <description>Evaluating URLs</description> + </action> + <action name="WEBCA_EvaluateURLsNoFail" > + <description>Evaluating URLs and do not fail if URL is invalid</description> + </action> + <action name="WEBCA_EvaluateURLsMB" > + <description>Evaluating URLs</description> + </action> + <action name="WEBCA_CreateAppRoots" > + <description>Creating application roots</description> + </action> + <action name="WEBCA_TARGETVDIR" > + <description>Set TARGETVDIR property to the specified virtual dir</description> + </action> + <action name="WEBCA_TARGETPORT" > + <description>Set TARGETPORT property to the specified virtual dir port</description> + </action> + </actiontext> + + + + + + + + Adds Verbs and a handler for the specified file type. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + directory + string + Refrence to a directory. The directory to add the specific verb/handler to IIS for the specified file type. + True + + + extension + string + File name extension to specifically handle + False + + + exepath + string + Path to the Internet Server API (ISAPI) or Common Gateway Interface (CGI) program to run to process a request. + False + + + verbs + string + Internet Information Services verbs that are allowed for the executable file. Only verbs entered in this field will be allowed. + False + + +

Examples

+ + Add the aspx app mapping + + <appmappings> + <appmapping directory="D__ACME_MyProduct" extension=".aspx" exepath="[DOTNETFOLDER]aspnet_isapi.dll" verbs="GET,HEAD,POST,DEBUG" /> + </appmappings> + + + + + + + + Determines the local path equivalent for a url and stores this + information in a property. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + The name of the URLProperty to convert + True + + + property + string + The name of the property to store the directory information. + True + + +

Examples

+ + Convert the TARGETURL property to a directory and store that information in TARGETDIR + + <urlproperties> + <urlproperty name="TARGETURL" property="TARGETDIR" /> + </urlproperties> + + + + + + + + Creates a URLProperty representing the virtual directory and port. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Property containing the virtual directory + True + + + portproperty + string + Property containing the network port number to use. + True + + + urlproperty + string + URLProperty to store the url in + True + + +

Examples

+ + Convert the virtual directory and port to a url and store the value in a property. + + <vdirproperties> + <vdirproperty name="TARGETVDIR" portproperty="TARGETPORT" urlproperty="TARGETURL" /> + </vdirproperties> + + + + + + + + Create a Web application definition and marks it as running in-process + or out-of-process. If an application already exists at the specified + path, you can use this method to reconfigure the application from + in-process to out-of-process, or the reverse. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + component + string + Reference to a component. Determines when the approot will be created. + True + + + urlproperty + string + URLProperty with stored url + True + + + inprocflag + int + Specifies whether the application being created is to run in-process (0), out-of-process (1), or in a pooled process (2). If the application already exists and is running, changing the value of this flag will cause the application definition to be deleted and a new application created to run in the specified process space. + True + + +

Examples

+ + Convert the virtual directory and port to a url and store the value in a property. + + <approots> + <approot component="C__MainFiles" urlproperty="TARGETURL" inprocflag="2" /> + </approots> + + + + + + + + Specifies directory security in IIS. Can also configure the default + documents supported by each directory. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + directory + string + Reference to a directory. This is the directory that gets modified with the specific attributes. + True + + + attr + int + Attributes to set for the directory. + + + Value + Flag Name + Description + + + 1 + AccessRead + The file or the contents of the folder may be read through Microsoft Internet Explorer. + + + 2 + AccessWrite + Users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. Write can be implemented only with a browser that supports the PUT feature of the HTTP 1.1 protocol standard. + + + 4 + AccessExecute + The file or the contents of the folder may be executed, regardless of file type. + + + 8 + AccessSSL + File access requires SSL file permission processing, with or without a client certificate. + + + 16 + AccessSource + Users are allowed to access source code if either Read or Write permissions are set. Source code includes scripts in Microsoft ® Active Server Pages (ASP) applications. + + + 32 + AccessSSLNegotiateCert + SSL file access processing requests a certificate from the client. A value of false indicates that access continues if the client does not have a certificate. Some versions of Internet Explorer will close the connection if the server requests a certificate and a certificate is not available (even if AccessSSLRequireCert is also set to true). + + + 64 + AccessSSLRequireCert + SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. AccessSSLNegotiateCert must also be set to true when using AccessSSLRequireCert. + + + 128 + AccessSSLMapCert + SSL file permission processing maps a client certificate to a Microsoft Windows ® operating system user-account. The AccessSSLNegotiateCert property must also be set to true for the mapping to occur. + + + 256 + AccessSSL128 + File access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate. + + + 512 + AccessScript + The file or the contents of the folder may be executed if they are script files or static content. A value of false only allows static files, such as HTML files, to be served. + + + 1024 + AccessNoRemoteWrite + Remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests. + + + 4096 + AccessNoRemoteRead + Remote requests to view files are denied; only requests from the same computer as the IIS server succeed if the AccessRead property is set to true. You cannot set AccessNoRemoteRead to false to enable remote requests, and set AccessRead to false to disable local requests. + + + 8192 + AccessNoRemoteExecute + Remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if the AccessExecute property is set to true. You cannot set AccessNoRemoteExecute to false to enable remote requests, and set AccessExecute to false to disable local requests. + + + 16384 + AccessNoRemoteScript + Requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests. + + + 32768 + AccessNoPhysicalDir + Access to the physical path is not allowed. + + + + True + + + defaultdoc + string + Adds a filename to the Default Documents to process. Add multiple separated with a comma (Eg. "Default.aspx,Default.htm") + False + + +

Examples

+ + Specify permissions for the directory structure. + + <iisproperties> + <iisproperty directory="TARGETDIR" attr="626" defaultdoc="Default.aspx" /> + <iisproperty directory="D__BIN" attr="112" /> + <iisproperty directory="D__SomeSubDir" attr="114" /> + </iisproperties> + + + + + + + Summary description for MsiTaskInfo. + + + + + Loads the banner image. + + The MSI database. + + + + Loads the background image. + + The MSI database. + + + + Loads the license file. + + The MSI database. + + + + Loads records for the Media table. + + The MSI database. + The sequence number of the last file in the .cab. + + + + Loads records for the Features table. + + The MSI database. + + + + Adds a feature record to the Features table. + + The MSI database Feature table. + The MSI database Condition table. + The name of this feature's parent. + The MSI database. + This Feature's Schema element. + The tree depth of this feature. + The tree order of this feature. + + + + Loads records for the LaunchCondition table + + The MSI database. + + + + Merges Merge Modules into the MSI Database. + + The MSI Database. + The path to temporary files. + + + + Creates a Windows Installer (also known as Microsoft Installer, or MSI) + setup database for installing software on the Windows Platform. + + + + Requires cabarc.exe in the path. This tool is part of the + Microsoft Cabinet SDK. + + + Requires mergemod.dll version 2.0 or greater. This dll is part of the + Microsoft Platform SDK. + + + See the Roadmap to Windows Installer Documentation + at Microsoft's MSDN website for more information. + + + + + + Initializes task and verifies parameters. + + + + + Executes the task. + + + + + An .rtf (rich text format) file containing the license agreement + for your software. The contents of this file will be displayed to + the user when setup runs and must be accepted to continue. + + + + + A .bmp (bitmap) file 495x60 pixels in size that will be displayed + as the banner (top) image of the installation user interface. + + + + + A .bmp (bitmap) file 495x315 pixels in size that will be displayed + as the background image of the installation user interface. + + + + + + Groups sets of components into named sets, these can be used to + layout the tree control that allows users to select and deselect + features of your software product when a custom installation is + selected at runtime. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the feature. + True + + + display + int + The number in this field specifies the order in which the feature is to be displayed in the user interface. + The value also determines if the feature is initially displayed expanded or collapsed.
+ If the value is null or zero, the record is not displayed. If the value is odd, the feature node is expanded initially. + If the value is even, the feature node is collapsed initially. + + True + + + title + string + Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog. + False + + + typical + bool + Determines if the feature should be included in a "typical" install. This is useful for when the user selects to just install the typical features. + False + + + directory + string + Refrence to a directory. Specify a corresponding directory to go with the feature. + False + + + attr + int + Any combination of the following: + + + Value + Description + + + 0 + Components of this feature that are not marked for installation from source are installed locally. + + + 1 + Components of this feature not marked for local installation are installed to run from the source CD-ROM or server. + + + 2 + Set this attribute and the state of the feature is the same as the state of the feature's parent. + + + 4 + Set this attribute and the feature state is Advertise. + + + 8 + Note that this bit works only with features that are listed by the ADVERTISE property.
Set this attribute to prevent the feature from being advertised. + + + 16 + Set this attribute and the user interface does not display an option to change the feature state to Absent. Setting this attribute forces the feature to the installation state, whether or not the feature is visible in the UI. + + + 32 + Set this attribute and advertising is disabled for the feature if the operating system shell does not support Windows Installer descriptors. + + + More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp + + False + + +

Nested Elements:

+

<feature>

+
    + Nested feature elements are supported. +
+

</feature>

+

<description>

+
    + Longer string of text describing the feature. This localizable string is displayed by the Text control of the Selection Dialog. +
+

</description>

+

<conditions>

+
    +

    <condition>

    +
      + + + Attribute + Type + Description + Required + + + expression + string + If this conditional expression evaluates to TRUE, then the Level column in the Feature table is set to the + conditional install level.
      + The expression in the Condition column should not contain reference to the installed state of any feature or component. + This is because the expressions in the Condition column are evaluated before the installer evaluates the installed + states of features and components. Any expression in the Condition table that attempts to check the installed state + of a feature or component always evaluates to false.
      + For information on the syntax of conditional statements, see Conditional Statement Syntax. +       + True +       + + level + int + The installer sets the install level of this feature to the level specified in this column if the expression in + the Condition column evaluates to TRUE. Set this value to 0 to have the component not install if the condition is not met.
      + For any installation, there is a defined install level, which is an integral value from 1 to 32,767. The initial value + is determined by the InstallLevel property, which is set in the Property table.
      + A feature is installed only if the feature level value is less than or equal to the current install level. The user + interface can be authored such that once the installation is initialized, the installer allows the user to modify the + install level of any feature in the Feature table. For example, an author can define install level values that represent + specific installation options, such as Complete, Typical, or Minimum, and then create a dialog box that uses + SetInstallLevel ControlEvents to enable the user to select one of these states. Depending on the state the user selects, + the dialog box sets the install level property to the corresponding value. If the author assigns Typical a level of 100 + and the user selects Typical, only those features with a level of 100 or less are installed. In addition, the Custom + option could lead to another dialog box containing a Selection Tree control. The Selection Tree would then allow the user + to individually change whether each feature is installed.       + True +       +       +
    +

    </condition>

    +
+

</conditions>

+

Examples

+ + Define a sample features structure. + + <features> + <feature name="F__Default" title="My Product" display="1" typical="true" directory="TARGETDIR"> + <description>My Product from ACME, Inc. </description> + <feature name="F__MainFiles" display="0" typical="true" /> + </feature> + <feature name="F__Help" title="My Product Help Files" display="1" typical="false" directory="D__ACME_MyProduct_Help" /> + </features> + + + + + + + + Includes pre-packaged installation components (.msm files) as part + of the msi database. This feature allows reuse of installation + components that use MSI technology from other setup vendors or as + created by the . + +

Parameters

+ + + Attribute + Type + Description + Required + + + feature + string + Refrence to a feature. Used to associate the merge module with the feature (and the feature's directory) for when to install the components in the merge module. + True + + +

Nested Elements:

+

<modules>

+
    + Specifies the merge module(s) to include with the specified feature. +
+

</modules>

+

<configurationitems>

+
    +

    <configurationitem>

    +
      + Specifies the value for a configurable item +

      Parameters

      + + + Attribute + Type + Description + Required + + + module + string + Merge module filename to limit the configuration item to. If this is not set, the configuration item will be applied to all merge modules in the fileset. + True + + + name string Name of item for which data is to be set True @@ -5704,516 +5777,516 @@
- - Summary description for MsmTaskInfo. - + + Summary description for MsmTaskInfo. + - - Loads records for the ModuleSignature table. - - The MSM database. + + Loads records for the ModuleSignature table. + + The MSM database. - - Loads records for the ModuleDependency table. - - The MSM database. + + Loads records for the ModuleDependency table. + + The MSM database. - - Loads records for the ModuleExclusion table. - - The MSM database. + + Loads records for the ModuleExclusion table. + + The MSM database. - - Loads records for the ModuleInstallUISequence, ModuleInstallExecuteSequence, - ModuleAdminUISequence, ModuleAdminExecute, and ModuleAdvtExecuteSequence tables. - - The MSM database. + + Loads records for the ModuleInstallUISequence, ModuleInstallExecuteSequence, + ModuleAdminUISequence, ModuleAdminExecute, and ModuleAdvtExecuteSequence tables. + + The MSM database. - - Loads records for the ModuleIgnoreTable table. - - The MSM database. + + Loads records for the ModuleIgnoreTable table. + + The MSM database. - - Loads records for the ModuleSubstitution table. - - The MSM database. + + Loads records for the ModuleSubstitution table. + + The MSM database. - - Loads records for the ModuleConfiguration table. - - The MSM database. + + Loads records for the ModuleConfiguration table. + + The MSM database. - - Builds a Windows Installer Merge Module (MSM) database. - - - Requires cabarc.exe in the path. This tool is part of the - Microsoft Cabinet SDK. - + + Builds a Windows Installer Merge Module (MSM) database. + + + Requires cabarc.exe in the path. This tool is part of the + Microsoft Cabinet SDK. + - - Initializes task and verifies parameters. - + + Initializes task and verifies parameters. + - - Executes the task. - + + Executes the task. + - - Stores a unique identifier for a merge module. To be used as the merge module's ModuleSignature - + + Stores a unique identifier for a merge module. To be used as the merge module's ModuleSignature + - - Specifies the numeric language ID or IDs for a merge module. - + + Specifies the numeric language ID or IDs for a merge module. + - - Stores the version number of a merge module. - + + Stores the version number of a merge module. + - - - Lists other merge modules that are required for this merge module - to operate properly. - - - Contains any number of dependency elements. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - id - string - Identifier of the merge module required - True - - - language - string - Numeric language ID of the dependent merge module. Can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. If the field contains a group language ID, any merge module with having a language code in that group satisfies the dependency. If the RequiredLanguage is set to 0, any merge module filling the other requirements satisfies the dependency. - True - - - version - string - Version of the dependent merge module. If ommited, any version fills the dependency. - False - - -

Examples

- - Make sure that the NAnt merge module is included - - <moduledependencies> - <dependency id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" /> - </moduledependencies> - - - + + + Lists other merge modules that are required for this merge module + to operate properly. + + + Contains any number of dependency elements. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + id + string + Identifier of the merge module required + True + + + language + string + Numeric language ID of the dependent merge module. Can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. If the field contains a group language ID, any merge module with having a language code in that group satisfies the dependency. If the RequiredLanguage is set to 0, any merge module filling the other requirements satisfies the dependency. + True + + + version + string + Version of the dependent merge module. If ommited, any version fills the dependency. + False + + +

Examples

+ + Make sure that the NAnt merge module is included + + <moduledependencies> + <dependency id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" /> + </moduledependencies> + + + - - - Lists other merge modules that are incompatible in the same - installer database. - - - Contains any number of exclusion elements. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - id - string - Identifier of the merge module required - True - - - language - string - Numeric language ID of the merge module in ExcludedID. The ExcludedLanguage column can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. The ExcludedLanguage column can accept negative language IDs. The meaning of the value in the ExcludedLanguage column is as follows. - - - ExcludedLanguage - Description - - - > 0 - Exclude the language IDs specified by ExcludedLanguage. - - - = 0 - Exclude no language IDs. - - - < 0 - Exclude all language IDs except those specified by ExcludedLanguage. - - - - True - - - minversion - string - Minimum version excluded from a range. If ommitted, all versions before maxversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version. - False - - - maxversion - string - Maximum version excluded from a range. If ommitted, all versions after minversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version. - False - - -

Examples

- - Exclude the all NAnt merge modules created before version 0.85.0 - - <moduleexclusions> - <exclusion id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" maxversion="0.85.0" /> - </moduleexclusions> - - - + + + Lists other merge modules that are incompatible in the same + installer database. + + + Contains any number of exclusion elements. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + id + string + Identifier of the merge module required + True + + + language + string + Numeric language ID of the merge module in ExcludedID. The ExcludedLanguage column can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. The ExcludedLanguage column can accept negative language IDs. The meaning of the value in the ExcludedLanguage column is as follows. + + + ExcludedLanguage + Description + + + > 0 + Exclude the language IDs specified by ExcludedLanguage. + + + = 0 + Exclude no language IDs. + + + < 0 + Exclude all language IDs except those specified by ExcludedLanguage. + + + + True + + + minversion + string + Minimum version excluded from a range. If ommitted, all versions before maxversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version. + False + + + maxversion + string + Maximum version excluded from a range. If ommitted, all versions after minversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version. + False + + +

Examples

+ + Exclude the all NAnt merge modules created before version 0.85.0 + + <moduleexclusions> + <exclusion id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" maxversion="0.85.0" /> + </moduleexclusions> + + + - - - Used to modify the sequence of tasks/events that execute during the - overall installation process. - -

Parameters

- - - Attribute - Type - Description - Required - - - type - msi:MSISequenceTable - Valid inputs: - - installexecute represents ModuleInstallExecuteSequence Table. - installui represents ModuleInstallUISequence Table - adminexecute represents ModuleAdminExecuteSequence Table - adminui represents ModuleAdminUISequence Table - advtexecute represents ModuleAdvtUISequence Table - - - True - - - action - string - Action to insert into sequence. Refers to one of the installer standard actions, or an entry in the merge module's CustomAction table or Dialog table.
If a standard action is used in the Action column of a merge module sequence table, the BaseAction and After attributes must be ommitted. - True - - - sequence - int - The sequence number of a standard action. If a custom action or dialog is entered into the Action column of this row, this attribute must be ommitted
When using standard actions in merge module sequence tables, the value in the Sequence column should be the recommended action sequence number. If the sequence number in the merge module differs from that for the same action in the .msi file sequence table, the merge tool uses the sequence number from the .msi file. See the suggested sequences in Using a Sequence Table for the recommended sequence numbers of standard actions. - False - - - baseaction - string - Can contain a standard action, a custom action specified in the merge module's custom action table, or a dialog specified in the module's dialog table. Is a key into the Action column of this table. It cannot be a foreign key into another merge table or table in the .msi file. This means that every standard action, custom action, or dialog listed in the BaseAction column must also be listed in the Action column of another record in this table. - False - - - after - bool - Boolean for whether Action comes before or after BaseAction - - - Value - Description - - - True - Action to come after BaseAction - - - False - Action to come before BaseAction - - - - False - - - condition - string - A conditional statement that indicates if the action is be executed. - False - - - + + + Used to modify the sequence of tasks/events that execute during the + overall installation process. + +

Parameters

+ + + Attribute + Type + Description + Required + + + type + msi:MSISequenceTable + Valid inputs: + + installexecute represents ModuleInstallExecuteSequence Table. + installui represents ModuleInstallUISequence Table + adminexecute represents ModuleAdminExecuteSequence Table + adminui represents ModuleAdminUISequence Table + advtexecute represents ModuleAdvtUISequence Table + + + True + + + action + string + Action to insert into sequence. Refers to one of the installer standard actions, or an entry in the merge module's CustomAction table or Dialog table.
If a standard action is used in the Action column of a merge module sequence table, the BaseAction and After attributes must be ommitted. + True + + + sequence + int + The sequence number of a standard action. If a custom action or dialog is entered into the Action column of this row, this attribute must be ommitted
When using standard actions in merge module sequence tables, the value in the Sequence column should be the recommended action sequence number. If the sequence number in the merge module differs from that for the same action in the .msi file sequence table, the merge tool uses the sequence number from the .msi file. See the suggested sequences in Using a Sequence Table for the recommended sequence numbers of standard actions. + False + + + baseaction + string + Can contain a standard action, a custom action specified in the merge module's custom action table, or a dialog specified in the module's dialog table. Is a key into the Action column of this table. It cannot be a foreign key into another merge table or table in the .msi file. This means that every standard action, custom action, or dialog listed in the BaseAction column must also be listed in the Action column of another record in this table. + False + + + after + bool + Boolean for whether Action comes before or after BaseAction + + + Value + Description + + + True + Action to come after BaseAction + + + False + Action to come before BaseAction + + + + False + + + condition + string + A conditional statement that indicates if the action is be executed. + False + + + - - - If a table in the merge module is listed in the ModuleIgnoreTable - table, it is not merged into the .msi file. If the table already - exists in the .msi file, it is not modified by the merge. The tables - in the ModuleIgnoreTable can therefore contain data that is unneeded - after the merge. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - table - string - Name of the table in the merge module that is not to be merged into the .msi file. - True - - -

Examples

- - Ensure the module is compatible for users who have versions of Mergemod.dll earlier than 2.0 - - <moduleignoretables> - <table name="ModuleConfiguration" /> - <table name="ModuleSubstitution" /> - <table name="_ModuleConfigurationGroup" /> - </moduleignoretables> - - - + + + If a table in the merge module is listed in the ModuleIgnoreTable + table, it is not merged into the .msi file. If the table already + exists in the .msi file, it is not modified by the merge. The tables + in the ModuleIgnoreTable can therefore contain data that is unneeded + after the merge. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + table + string + Name of the table in the merge module that is not to be merged into the .msi file. + True + + +

Examples

+ + Ensure the module is compatible for users who have versions of Mergemod.dll earlier than 2.0 + + <moduleignoretables> + <table name="ModuleConfiguration" /> + <table name="ModuleSubstitution" /> + <table name="_ModuleConfigurationGroup" /> + </moduleignoretables> + + + - - - The ModuleSubstitution table specifies the configurable fields of a - module database and provides a template for the configuration of each - field. The user or merge tool may query this table to determine what - configuration operations are to take place. This table is not merged - into the target database. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - table - string - Name of the table being modified in the module database. - True - - - row - string - Specifies the primary keys of the target row in the table named in the Table column. Multiple primary keys are separated by semicolons. Target rows are selected for modification before any changes are made to the target table. If one record in the ModuleSubstitution table changes the primary key field of a target row, other records in the ModuleSubstitution table are applied based on the original primary key data, not the resulting of primary key substitutions. The order of row substitution is undefined.
Values in this column are always in CMSM special format. A literal semicolon (';') or equal sign ('=') can be added by prefixing the character with a backslash. '\'. A null value for a key is signified by a null, a leading semicolon, two consecutive semicolons, or a trailing semicolon, depending on whether the null value is a sole, first, middle, or final key column value. - True - - - column - string - Specifies the target column in the row named in the Row column. If multiple rows in the ModuleSubstitution table change different columns of the same target row, all the column substitutions are performed before the modified row is inserted into the database. The order of column substitution is undefined. - True - - - value - string - Contains a string that provides a formatting template for the data being substituted into the target field specified by Table, Row, and Column. When a substitution string of the form [=ItemA] is encountered, the string, including the bracket characters, is replaced by the value for the configurable "ItemA." The configurable item "ItemA" is specified in the Name column of the ModuleConfiguration table and its value is provided by the merge tool. If the merge tool declines to provide a value for any item in a replacement string, the default value specified in the DefaultValue column of the ModuleConfiguration Table is substituted. If a string references an item not in the ModuleConfiguration table, the merge fails. - - - This column uses CMSM special format. A literal semicolon (';') or equals sign ('=') can be added to the table by prefixing the character with a backslash. '\'. - - - The Value field may contain multiple substitution strings. For example, the configuration of items "Food1" and "Food2" in the string: "[=Food1] is good, but [=Food2] is better because [=Food2] is more nutritious." - - - Replacement strings must not be nested. The template "[=AB[=CDE]]" is invalid. - - - If the Value field evaluates to null, and the target field is not nullable, the merge fails and an error object of type msmErrorBadNullSubstitution is created and added to the error list. For details, see the error types described in get_Type Function. - - - If the Value field evaluates to the null GUID: {00000000-0000-0000-0000-000000000000}, the null GUID is replaced by the name of the feature before the row is merged into the module. For details, see Referencing Features in Merge Modules. - - - The template in the Value field is evaluated before being inserted into the target field. Substitution into a row is done before replacing any features. - - - If the Value column evaluates to a string of only integer characters (with an optional + or -), the string is converted into an integer before being substituted into an target field of the Integer Format Type. If the template evaluates to a string that does not consist only of integer characters (and an optional + or -) the result cannot be substituted into an integer target field. Attempting to insert a non-integer into an integer field causes the merge to fail and adds a msmErrorBadSubstitutionType error object to the error list. - - - If the target column specified in the Table and Column fields is a Text Format Type, and evaluation of the Value field results in an Integer Format Type, a decimal representation of the number is inserted into the target text field. - - - If the target field is an Integer Format Type, and the Value field consists of a non-delimited list of items in Bitfield Format, the value in the target field is combined using the bitwise AND operator with the inverse of the bitwise OR of all of the mask values from the items, then combined using the bitwise OR operator with each of the integer or bitfield items when masked by their corresponding mask values. Essentially, this explicitly sets the bits from the properties to the provided values but leaves all other bits in the cell alone. - - - If the Value field evaluates to a Key Format Type, and is a key into a table that uses multiple primary keys, the item name may be followed by a semicolon and an integer value that indicates the 1-based index into the set of values that together make a primary key. If no integer is specified, the value 1 is used. For example, the Control table has two primary key columns, Dialog_ and Control. The value of an item "Item1" that is a key into the Control table will be of the form "DialogName;ControlName", where DialogName is the value in the Dialog_ table and ControlName is the value in the Control column. To substitute just ControlName, the substitution string [=Item1;2] should be used. - - - - False - - - + + + The ModuleSubstitution table specifies the configurable fields of a + module database and provides a template for the configuration of each + field. The user or merge tool may query this table to determine what + configuration operations are to take place. This table is not merged + into the target database. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + table + string + Name of the table being modified in the module database. + True + + + row + string + Specifies the primary keys of the target row in the table named in the Table column. Multiple primary keys are separated by semicolons. Target rows are selected for modification before any changes are made to the target table. If one record in the ModuleSubstitution table changes the primary key field of a target row, other records in the ModuleSubstitution table are applied based on the original primary key data, not the resulting of primary key substitutions. The order of row substitution is undefined.
Values in this column are always in CMSM special format. A literal semicolon (';') or equal sign ('=') can be added by prefixing the character with a backslash. '\'. A null value for a key is signified by a null, a leading semicolon, two consecutive semicolons, or a trailing semicolon, depending on whether the null value is a sole, first, middle, or final key column value. + True + + + column + string + Specifies the target column in the row named in the Row column. If multiple rows in the ModuleSubstitution table change different columns of the same target row, all the column substitutions are performed before the modified row is inserted into the database. The order of column substitution is undefined. + True + + + value + string + Contains a string that provides a formatting template for the data being substituted into the target field specified by Table, Row, and Column. When a substitution string of the form [=ItemA] is encountered, the string, including the bracket characters, is replaced by the value for the configurable "ItemA." The configurable item "ItemA" is specified in the Name column of the ModuleConfiguration table and its value is provided by the merge tool. If the merge tool declines to provide a value for any item in a replacement string, the default value specified in the DefaultValue column of the ModuleConfiguration Table is substituted. If a string references an item not in the ModuleConfiguration table, the merge fails. + + + This column uses CMSM special format. A literal semicolon (';') or equals sign ('=') can be added to the table by prefixing the character with a backslash. '\'. + + + The Value field may contain multiple substitution strings. For example, the configuration of items "Food1" and "Food2" in the string: "[=Food1] is good, but [=Food2] is better because [=Food2] is more nutritious." + + + Replacement strings must not be nested. The template "[=AB[=CDE]]" is invalid. + + + If the Value field evaluates to null, and the target field is not nullable, the merge fails and an error object of type msmErrorBadNullSubstitution is created and added to the error list. For details, see the error types described in get_Type Function. + + + If the Value field evaluates to the null GUID: {00000000-0000-0000-0000-000000000000}, the null GUID is replaced by the name of the feature before the row is merged into the module. For details, see Referencing Features in Merge Modules. + + + The template in the Value field is evaluated before being inserted into the target field. Substitution into a row is done before replacing any features. + + + If the Value column evaluates to a string of only integer characters (with an optional + or -), the string is converted into an integer before being substituted into an target field of the Integer Format Type. If the template evaluates to a string that does not consist only of integer characters (and an optional + or -) the result cannot be substituted into an integer target field. Attempting to insert a non-integer into an integer field causes the merge to fail and adds a msmErrorBadSubstitutionType error object to the error list. + + + If the target column specified in the Table and Column fields is a Text Format Type, and evaluation of the Value field results in an Integer Format Type, a decimal representation of the number is inserted into the target text field. + + + If the target field is an Integer Format Type, and the Value field consists of a non-delimited list of items in Bitfield Format, the value in the target field is combined using the bitwise AND operator with the inverse of the bitwise OR of all of the mask values from the items, then combined using the bitwise OR operator with each of the integer or bitfield items when masked by their corresponding mask values. Essentially, this explicitly sets the bits from the properties to the provided values but leaves all other bits in the cell alone. + + + If the Value field evaluates to a Key Format Type, and is a key into a table that uses multiple primary keys, the item name may be followed by a semicolon and an integer value that indicates the 1-based index into the set of values that together make a primary key. If no integer is specified, the value 1 is used. For example, the Control table has two primary key columns, Dialog_ and Control. The value of an item "Item1" that is a key into the Control table will be of the form "DialogName;ControlName", where DialogName is the value in the Dialog_ table and ControlName is the value in the Control column. To substitute just ControlName, the substitution string [=Item1;2] should be used. + + + + False + + + - - - Identifies the configurable attributes of the module. This table is - not merged into the database. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table. - True - - - format - msi:MSMModuleConfigurationFormat - Specifies the format of the data being changed - - text - key - integer - bitfield - - - True - - - type - string - Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute. - False - - - contextdata - string - Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes. - False - - - defaultvalue - string - Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally.
Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state. - False - - - attr - int - Bit field containing attributes for this configurable item. Null is equivalent to 0. - - - Value - Description - - - 1 - This attribute only applies to records that list a foreign key to a module table in their DefaultValue field. - - - 2 - When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types. - - - - False - - - displayname - string - Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI. - False - - - description - string - Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform. - False - - - helplocation - string - Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available. - False - - - helpkeyword - string - Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute. - False - - - + + + Identifies the configurable attributes of the module. This table is + not merged into the database. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table. + True + + + format + msi:MSMModuleConfigurationFormat + Specifies the format of the data being changed + + text + key + integer + bitfield + + + True + + + type + string + Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute. + False + + + contextdata + string + Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes. + False + + + defaultvalue + string + Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally.
Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state. + False + + + attr + int + Bit field containing attributes for this configurable item. Null is equivalent to 0. + + + Value + Description + + + 1 + This attribute only applies to records that list a foreign key to a module table in their DefaultValue field. + + + 2 + When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types. + + + + False + + + displayname + string + Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI. + False + + + description + string + Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform. + False + + + helplocation + string + Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available. + False + + + helpkeyword + string + Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute. + False + + + - - Maintains a forward reference to a .tlb file - in the same directory as an assembly .dll - that has been registered for COM interop. - + + Maintains a forward reference to a .tlb file + in the same directory as an assembly .dll + that has been registered for COM interop. + @@ -6226,106 +6299,106 @@ The name of the Assembly's component. - - Retrieves the name of the Assembly's component. - - The Assembly's component Name. + + Retrieves the name of the Assembly's component. + + The Assembly's component Name. - - Retrieves the typelibrary filename. - - The typelibrary filename. + + Retrieves the typelibrary filename. + + The typelibrary filename. - - Retrieves the typelibrary id. - - The typelibrary id. + + Retrieves the typelibrary id. + + The typelibrary id. - - Retrieves the name of the assembly. - - The name of the assembly. + + Retrieves the name of the assembly. + + The name of the assembly. - - Retrieves the feature containing the typelibrary's file. - - The feature containing the typelibrary's file. + + Retrieves the feature containing the typelibrary's file. + + The feature containing the typelibrary's file. - - A task that generates a summary HTML - from a set of NUnit xml report files. - - - - This task can generate a combined HTML report out of a set of NUnit - result files generated using the XML Result Formatter. - - - All the properties defined in the current project will be passed - down to the XSLT file as template parameters, so you can access - properties such as nant.project.name, nant.version, etc. - - - - - - - - - - ]]> - - + + A task that generates a summary HTML + from a set of NUnit xml report files. + + + + This task can generate a combined HTML report out of a set of NUnit + result files generated using the XML Result Formatter. + + + All the properties defined in the current project will be passed + down to the XSLT file as template parameters, so you can access + properties such as nant.project.name, nant.version, etc. + + + + + + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Load a stylesheet from the assemblies resource stream. - - File name of the file to extract. + + Load a stylesheet from the assemblies resource stream. + + File name of the file to extract. - - Load a stylesheet from the file system. - - The XSLT file to load. + + Load a stylesheet from the file system. + + The XSLT file to load. - - Initializes the XmlDocument instance - used to summarize the test results - - + + Initializes the XmlDocument instance + used to summarize the test results + + - - Builds an XsltArgumentList with all - the properties defined in the - current project as XSLT parameters. - - + + Builds an XsltArgumentList with all + the properties defined in the + current project as XSLT parameters. + + - - Run the transform and output to filename - - - + + Run the transform and output to filename + + + @@ -6334,30 +6407,30 @@ - - The output language. - + + The output language. + - - Open all description method. Default to "false". - + + Open all description method. Default to "false". + - - The directory where the files resulting from the transformation - should be written to. The default is the project's base directory. - + + The directory where the files resulting from the transformation + should be written to. The default is the project's base directory. + - - Set of XML files to use as input - + + Set of XML files to use as input + - - Set of summary XML files to use as input. - + + Set of summary XML files to use as input. + @@ -6366,43 +6439,43 @@ - - Custom XmlResolver used to load the - XSLT files out of this assembly resources. - + + Custom XmlResolver used to load the + XSLT files out of this assembly resources. + - - Loads the specified file from our internal resources if its there - - - - - + + Loads the specified file from our internal resources if its there + + + + + - - Open file(s) in a client workspace for addition to the depot. - - - - Add all cs files under the given directory into the "new" changelist - (will be created if it doesn't already exist). - - - - ]]> - - - - Add Test.txt into the default changelist. - - - ]]> - - + + Open file(s) in a client workspace for addition to the depot. + + + + Add all cs files under the given directory into the "new" changelist + (will be created if it doesn't already exist). + + + + ]]> + + + + Add Test.txt into the default changelist. + + + ]]> + + @@ -6421,76 +6494,76 @@ - - Execute the perforce command assembled by subclasses. - + + Execute the perforce command assembled by subclasses. + - - The p4 server and port to connect to. The default is "perforce:1666". - + + The p4 server and port to connect to. The default is "perforce:1666". + - - The p4 client spec to use. The default is the current client. - + + The p4 client spec to use. The default is the current client. + - - The p4 username. The default is the current user. - + + The p4 username. The default is the current user. + - - The client, branch or label view to operate upon. The default is - "//...". - + + The client, branch or label view to operate upon. The default is + "//...". + - - Prepends a descriptive field (for example, text:, info:, error:, exit:) - to each line of output produced by a Perforce command. This is most - often used when scripting. The default is . - + + Prepends a descriptive field (for example, text:, info:, error:, exit:) + to each line of output produced by a Perforce command. This is most + often used when scripting. The default is . + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Override the ExeName paramater for p4.exe - + + Override the ExeName paramater for p4.exe + - - Derived classes should override this to provide command-specific - commandline arguments. - + + Derived classes should override this to provide command-specific + commandline arguments. + - - Build the command string for this particular command. - - - The command string for this particular command. - + + Build the command string for this particular command. + + + The command string for this particular command. + - - File(s) to add. File name can contain wildcard characters. (Note: - this is not using p4 wildcard syntax, but the OS wildcards). - + + File(s) to add. File name can contain wildcard characters. (Note: + this is not using p4 wildcard syntax, but the OS wildcards). + - - Changelist that files will be added into. Changelist will be created - if not already present. - + + Changelist that files will be added into. Changelist will be created + if not already present. + @@ -6499,906 +6572,906 @@ - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Create or delete a changelist specification. - - - Create a new changelist called "mynewchange". - - - ]]> - - - - Delete the changelist called "mynewchange". - - - ]]> - - + + Create or delete a changelist specification. + + + Create a new changelist called "mynewchange". + + + ]]> + + + + Delete the changelist called "mynewchange". + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to create or delete. - + + Changelist to create or delete. + - - If causes passed in changelist to be - deleted. The default is . - + + If causes passed in changelist to be + deleted. The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Add/modify/delete a client spec in perforce. - - - - Add a client (modify if already present and have sufficient rights). - - - - ]]> - - - - Delete a client. - - - ]]> - - + + Add/modify/delete a client spec in perforce. + + + + Add a client (modify if already present and have sufficient rights). + + + + ]]> + + + + Delete a client. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Name of client to create/delete. - + + Name of client to create/delete. + - - Root path for client spec. - + + Root path for client spec. + - - Delete the named client. The default is . - + + Delete the named client. The default is . + - - Force a delete even if files are open. The default is - . - + + Force a delete even if files are open. The default is + . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Open file(s) in a client workspace for deletion from the depot. - - - - Mark all cs files under the give view for deletion and place them in - the "Deleting" changelist. - - - - ]]> - - + + Open file(s) in a client workspace for deletion from the depot. + + + + Mark all cs files under the give view for deletion and place them in + the "Deleting" changelist. + + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to place the marked for deletion item into. - + + Changelist to place the marked for deletion item into. + - - The client, branch or label view to operate upon. - + + The client, branch or label view to operate upon. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Opens file(s) in a client workspace for edit. - - - - Open all files in the ProjectX Test folder for edit, and place into - the default changelist. - - - - ]]> - - - - - Open all *.txt files in the ProjectX Test folder for edit, and place - into the "testing" changelist. - - - - ]]> - - + + Opens file(s) in a client workspace for edit. + + + + Open all files in the ProjectX Test folder for edit, and place into + the default changelist. + + + + ]]> + + + + + Open all *.txt files in the ProjectX Test folder for edit, and place + into the "testing" changelist. + + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to place the opened files into. - + + Changelist to place the opened files into. + - - File Type settings. - + + File Type settings. + - - The client, branch or label view to operate upon. - + + The client, branch or label view to operate upon. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Returns information from the "p4 info" command back into variables for - use within the build process. - - - Fill the variables using the task. - - - - ]]> - - + + Returns information from the "p4 info" command back into variables for + use within the build process. + + + Fill the variables using the task. + + + + ]]> + + - - The name of the property to store the p4 user name in. - + + The name of the property to store the p4 user name in. + - - The name of the property to store the p4 client name in. - + + The name of the property to store the p4 client name in. + - - The name of the property to store the p4 host name in. - + + The name of the property to store the p4 host name in. + - - The name of the property to store the p4 client root in. - + + The name of the property to store the p4 client root in. + - - Create or edit a label specification and its view. - - - Create a new label called "SDK_V1.2". - - - ]]> - - - - Delete the previously created label. - - - ]]> - - + + Create or edit a label specification and its view. + + + Create a new label called "SDK_V1.2". + + + ]]> + + + + Delete the previously created label. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Name of label to create/delete. - + + Name of label to create/delete. + - - Delete the named label. The default is . - + + Delete the named label. The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Synchronize a label with the contents of the current client workspace. - - - Apply a previously created label to the specified view. - - - ]]> - - + + Synchronize a label with the contents of the current client workspace. + + + Apply a previously created label to the specified view. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Name of the label to sync the specified or default view with. - + + Name of the label to sync the specified or default view with. + - - Delete the view defined in the label, or matching the input view - from the label. The default is . - + + Delete the view defined in the label, or matching the input view + from the label. The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Fetch a specific file from a Perforce depot without needing a clientspec - to map it. - - - - - - ]]> - - + + Fetch a specific file from a Perforce depot without needing a clientspec + to map it. + + + + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - The depot or local filename (including optional path) of the file - to fetch. - + + The depot or local filename (including optional path) of the file + to fetch. + - - The local filename to write the fetched file to. - + + The local filename to write the fetched file to. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Move opened files between changelists or change the files’ type. - - - This task has two different but related uses: - Moving opened files between changelists (default or named). - Changing the type of an opened file. - - - - Move the specified files matching the view into the "New" changelist. - - - - ]]> - - - - - Modify the specified files matching the view to the given file type. - The change won't affect the repository until submitted. - - - - ]]> - - + + Move opened files between changelists or change the files’ type. + + + This task has two different but related uses: + Moving opened files between changelists (default or named). + Changing the type of an opened file. + + + + Move the specified files matching the view into the "New" changelist. + + + + ]]> + + + + + Modify the specified files matching the view to the given file type. + The change won't affect the repository until submitted. + + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - The client, branch or label view to operate upon. - + + The client, branch or label view to operate upon. + - - Changelist to place the reopened files into. - + + Changelist to place the reopened files into. + - - File Type settings. - + + File Type settings. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Discard changes made to open files. - - - Revert all txt files in a given changelist. - - - ]]> - - - - - Revert all unchanged files opened in the given changelist. - - - - ]]> - - - - Revert all unchanged files opened in any changelist. - - - ]]> - - + + Discard changes made to open files. + + + Revert all txt files in a given changelist. + + + ]]> + + + + + Revert all unchanged files opened in the given changelist. + + + + ]]> + + + + Revert all unchanged files opened in any changelist. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to perform the revert action on. optional. - + + Changelist to perform the revert action on. optional. + - - Revert all unchanged or missing files from the changelist. default is false. optional. - + + Revert all unchanged or missing files from the changelist. default is false. optional. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Set registry variables that perforce uses. - - - Note: the environment variables that p4 uses will be set, but will not - be validated. - - - Modify any of the three variables (at least one required). - - - ]]> - - + + Set registry variables that perforce uses. + + + Note: the environment variables that p4 uses will be set, but will not + be validated. + + + Modify any of the three variables (at least one required). + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Send changes made to open files to the depot. - - - - Submit changelist "Temp", but first revert all unchanged files in the - changelist. - - - - ]]> - - - - Submit changelist, but leave the files open afterwards. - - - ]]> - - + + Send changes made to open files to the depot. + + + + Submit changelist "Temp", but first revert all unchanged files in the + changelist. + + + + ]]> + + + + Submit changelist, but leave the files open afterwards. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to submit. - + + Changelist to submit. + - - Keep the files open after submitting. The default is - . - + + Keep the files open after submitting. The default is + . + - - Revert all unchanged or missing files from the changelist. - The default is . - + + Revert all unchanged or missing files from the changelist. + The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Synchronize client space to a Perforce depot view. - - - - Sync to head using P4USER, P4PORT and P4CLIENT settings specified. - - - - ]]> - - - - Sync to head using default p4 environment variables. - - - ]]> - - - - Force a re-sync to head, refreshing all files. - - - ]]> - - - - Sync to a label. - - - ]]> - - + + Synchronize client space to a Perforce depot view. + + + + Sync to head using P4USER, P4PORT and P4CLIENT settings specified. + + + + ]]> + + + + Sync to head using default p4 environment variables. + + + ]]> + + + + Force a re-sync to head, refreshing all files. + + + ]]> + + + + Sync to a label. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - Label to sync client to; optional. - + Label to sync client to; optional. + - - Force a refresh of files. The default is . - + + Force a refresh of files. The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Static helper class for Perforce tasks. - + + Static helper class for Perforce tasks. + - - ask p4 for the user name - - + + ask p4 for the user name + + - - ask p4 for the client name - - + + ask p4 for the client name + + - - Get a changelist number based on on its name - - - - - - + + Get a changelist number based on on its name + + + + + + - - Get a changelist number based on on its name - - - - - + + Get a changelist number based on on its name + + + + + - - Create a new label - - - - + + Create a new label + + + + - - Create a new Client - - - - - + + Create a new Client + + + + + - - Create a new changelist - - - - Description of Changelist - + + Create a new changelist + + + + Description of Changelist + - - call the p4 process to - - - + + call the p4 process to + + + - - call the p4 process to - - - + + call the p4 process to + + + - - Execute a process and return its ourput - - - - - + + Execute a process and return its ourput + + + + + - - Execute a process and return its ourput - - - - - - + + Execute a process and return its ourput + + + + + + - - Execute a process by name - - - - - + + Execute a process by name + + + + + - - Adds files to a PVCS repository. - - - - This task uses the addfiles PCLI command to add files to a PVCS repository. - - - - - Adds File1.txt and File2.txt to the root level of the - project database specified by the project-database property. - - - - - - - - - ]]> - - - - - Adds File1.txt and File2.txt to the folder project - of the project database specified by the project-database - property. - - - - - - - - - ]]> - - - - - Adds another_file.txt and all files and folders at and below - C:\Data to the project database specified by the project-database - property. - - - - - - - - - ]]> - - - - - Adds all files at and below C:\Data\ to the project database specified by the project-database - property. Workfiles will be copied to the workfile location and will overwrite any existing files (as - dictated by the copymode attribute). The relevant revisions will be locked in PVCS. Added files - will be assigned the SYSTEST promotion group. - - - - - - - - ]]> - - + + Adds files to a PVCS repository. + + + + This task uses the addfiles PCLI command to add files to a PVCS repository. + + + + + Adds File1.txt and File2.txt to the root level of the + project database specified by the project-database property. + + + + + + + + + ]]> + + + + + Adds File1.txt and File2.txt to the folder project + of the project database specified by the project-database + property. + + + + + + + + + ]]> + + + + + Adds another_file.txt and all files and folders at and below + C:\Data to the project database specified by the project-database + property. + + + + + + + + + ]]> + + + + + Adds all files at and below C:\Data\ to the project database specified by the project-database + property. Workfiles will be copied to the workfile location and will overwrite any existing files (as + dictated by the copymode attribute). The relevant revisions will be locked in PVCS. Added files + will be assigned the SYSTEST promotion group. + + + + + + + + ]]> + + - - Base class for all PVCS project database tasks that operate against one or more entities. - + + Base class for all PVCS project database tasks that operate against one or more entities. + - - A base class for PVCS tasks that deal with project databases. - - - - This class can be used as a base class for PVCS tasks that operate against a project database. It provides - common attributes and functionality for such tasks. - - + + A base class for PVCS tasks that deal with project databases. + + + + This class can be used as a base class for PVCS tasks that operate against a project database. It provides + common attributes and functionality for such tasks. + + - - Base class functionality for all PVCS tasks. - + + Base class functionality for all PVCS tasks. + - - This is the PCLI process that is run by this task. - + + This is the PCLI process that is run by this task. + - - Starts the process that is wrapped by this PVCS task. - - - Provided only to seal the implementation of StartProcess(). - - The process that was started. + + Starts the process that is wrapped by this PVCS task. + + + Provided only to seal the implementation of StartProcess(). + + The process that was started. - - Executes the task. - - - Provided only to seal the implementation of ExecuteTask(). - + + Executes the task. + + + Provided only to seal the implementation of ExecuteTask(). + - - Prepares the process wrapped by this task for execution. - - The process to prepare for execution. + + Prepares the process wrapped by this task for execution. + + The process to prepare for execution. - - Allows tasks to add their task-specific arguments to the collection of arguments to be passed to the - PVCS command-line tool. - - The collection of arguments. + + Allows tasks to add their task-specific arguments to the collection of arguments to be passed to the + PVCS command-line tool. + + The collection of arguments. - - Constructs the program arguments that should be used when executing the wrapped PVCS process. - - A string containing the program arguments. + + Constructs the program arguments that should be used when executing the wrapped PVCS process. + + A string containing the program arguments. - - Gets or sets the location of the PVCS binary command-line tools. - - - - Generally, the PVCS command-line tools will be available on the current path. However, if this is not - the case then this property allows an exact location to be specified. If this property is not set, the - task will assume that the PVCS binaries are available on the current path. - - + + Gets or sets the location of the PVCS binary command-line tools. + + + + Generally, the PVCS command-line tools will be available on the current path. However, if this is not + the case then this property allows an exact location to be specified. If this property is not set, the + task will assume that the PVCS binaries are available on the current path. + + - - Gets or sets the process that is run as a result of running this task. - + + Gets or sets the process that is run as a result of running this task. + - - Gets the program arguments with which to run the wrapped PVCS process. - + + Gets the program arguments with which to run the wrapped PVCS process. + - - Gets the executable name for the command-line tool to run for the PVCS task. - + + Gets the executable name for the command-line tool to run for the PVCS task. + - - Gets the PCLI command name that corresponds to the operation the task performs. - - - - By default, this property will return the name of the task minus the starting "pvcs". Subclasses need - only override this property if there is a mismatch between the task name and the PCLI command name. - - + + Gets the PCLI command name that corresponds to the operation the task performs. + + + + By default, this property will return the name of the task minus the starting "pvcs". Subclasses need + only override this property if there is a mismatch between the task name and the PCLI command name. + + @@ -7428,86 +7501,86 @@ - - Gets or sets a value indicating whether the operation should include subprojects. - - - - This is equivalent to the -z command-line option. - - + + Gets or sets a value indicating whether the operation should include subprojects. + + + + This is equivalent to the -z command-line option. + + - - Gets a value indicating whether the specific task implementation supports the includesubprojects - task attribute. If not, an exception will be thrown if an attempt is made to set the attribute. - + + Gets a value indicating whether the specific task implementation supports the includesubprojects + task attribute. If not, an exception will be thrown if an attempt is made to set the attribute. + - - Gets or sets the password to use when connecting to the project database. - - - - This is equivalent to the password part of the -id command-line option. - - + + Gets or sets the password to use when connecting to the project database. + + + + This is equivalent to the password part of the -id command-line option. + + - - Gets or sets the user ID to use when connecting to the project database. - - - - This is equivalent to the user ID part of the -id command-line option. - - + + Gets or sets the user ID to use when connecting to the project database. + + + + This is equivalent to the user ID part of the -id command-line option. + + - - Gets or sets the workspace to use when connecting to the project database. - - - - This is equivalent to the -sp command-line option. - - + + Gets or sets the workspace to use when connecting to the project database. + + + + This is equivalent to the -sp command-line option. + + - - Gets or sets the project database to utilize during the operation. - - - - This is equivalent to the -pr command-line option. - - + + Gets or sets the project database to utilize during the operation. + + + + This is equivalent to the -pr command-line option. + + - - Gets or sets the project path to utilize during the operation. - - - - This is equivalent to the -pp command-line option. - - + + Gets or sets the project path to utilize during the operation. + + + + This is equivalent to the -pp command-line option. + + - - Constructs and initializes an instance of PVCSMultipleEntityTask. - + + Constructs and initializes an instance of PVCSMultipleEntityTask. + - - Gets or sets the entities involved in the operation. - + + Gets or sets the entities involved in the operation. + @@ -7534,89 +7607,89 @@ - - Constructs and initializes an instance of PVCSAddFilesTask. - + + Constructs and initializes an instance of PVCSAddFilesTask. + - - Gets or sets the archive description for versioned files. - - - - This is equivalent to the -t parameter to the pcli addfiles command. - - + + Gets or sets the archive description for versioned files. + + + + This is equivalent to the -t parameter to the pcli addfiles command. + + - - Gets or sets the copy mode for the operation. - + + Gets or sets the copy mode for the operation. + - - Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS. - - - - This is equivalent to the -d parameter to the pcli addfiles command. - - + + Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS. + + + + This is equivalent to the -d parameter to the pcli addfiles command. + + - - Gets or sets the description for versioned files. - - - - This is equivalent to the -m parameter to the pcli addfiles command. - - + + Gets or sets the description for versioned files. + + + + This is equivalent to the -m parameter to the pcli addfiles command. + + - - Gets or sets a value indicating whether versioned files should be locked after being added to PVCS. - - - - This is equivalent to the -l parameter to the pcli addfiles command. - - + + Gets or sets a value indicating whether versioned files should be locked after being added to PVCS. + + + + This is equivalent to the -l parameter to the pcli addfiles command. + + - - Gets or sets the promotion group to which added files will be assigned. Setting this attribute to an - empty string indicates the versioned files will not be assigned to any promotion group. - - - - This is equivalent to the -g parameter to the pcli addfiles command. - - + + Gets or sets the promotion group to which added files will be assigned. Setting this attribute to an + empty string indicates the versioned files will not be assigned to any promotion group. + + + + This is equivalent to the -g parameter to the pcli addfiles command. + + - - Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS - repository. - - - - This is equivalent to the -qw parameter to the pcli addfiles command. - - + + Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS + repository. + + + + This is equivalent to the -qw parameter to the pcli addfiles command. + + - - Gets or sets the version label to assign to the added versioned files. - - - - This is equivalent to the -v parameter to the pcli addfiles command. - - + + Gets or sets the version label to assign to the added versioned files. + + + + This is equivalent to the -v parameter to the pcli addfiles command. + + @@ -7624,52 +7697,52 @@ - - Indicates the default copy mode should be used. - + + Indicates the default copy mode should be used. + - - Indicates that workfiles should be copied to the project workfile location is it doesn't already exist. - + + Indicates that workfiles should be copied to the project workfile location is it doesn't already exist. + - - Indicates that workfiles should be copied to the project workfile location and overwrite any existing - workfile. - + + Indicates that workfiles should be copied to the project workfile location and overwrite any existing + workfile. + - - Adds a user to a PVCS project or project database. - - - - This task uses the adduser PCLI command to add the user to the PVCS project or database. - - - - - Adds a user with name kb and password *Muse* to the project database specified by the - project-database property. - - - - ]]> - - - - - Adds a user with name kb and password *Muse* to the project database specified by the - project-database property. The user's logon will expire on the 26th of October, 2005. - - - - ]]> - - + + Adds a user to a PVCS project or project database. + + + + This task uses the adduser PCLI command to add the user to the PVCS project or database. + + + + + Adds a user with name kb and password *Muse* to the project database specified by the + project-database property. + + + + ]]> + + + + + Adds a user with name kb and password *Muse* to the project database specified by the + project-database property. The user's logon will expire on the 26th of October, 2005. + + + + ]]> + + @@ -7681,71 +7754,71 @@ - - Constructs and initializes an instance of PVCSAddUserTask. - + + Constructs and initializes an instance of PVCSAddUserTask. + - - Gets or sets the expiration date for the new user. - - - - This is equivalent to the -e parameter to the pcli adduser command. - - + + Gets or sets the expiration date for the new user. + + + + This is equivalent to the -e parameter to the pcli adduser command. + + - - Gets or sets the password for the new user. - + + Gets or sets the password for the new user. + - - Gets or sets the user name for the new user. - + + Gets or sets the user name for the new user. + - - Assigns a promotion group to versioned files. - - - - This task uses the assigngroup PCLI command to assign the group to versioned files. - - - - - Assigns the SYSTEST promotion group to all entities with the DEV promotion group in the - folder project. - - - - ]]> - - - - - Assigns the SYSTEST promotion group to revision 1.2 of all entities. - - - - ]]> - - + + Assigns a promotion group to versioned files. + + + + This task uses the assigngroup PCLI command to assign the group to versioned files. + + + + + Assigns the SYSTEST promotion group to all entities with the DEV promotion group in the + folder project. + + + + ]]> + + + + + Assigns the SYSTEST promotion group to revision 1.2 of all entities. + + + + ]]> + + - - Base class for all PVCS project database tasks that operate against a single entity. - + + Base class for all PVCS project database tasks that operate against a single entity. + @@ -7754,9 +7827,9 @@ - - Gets or sets the entity involved in the operation. - + + Gets or sets the entity involved in the operation. + @@ -7771,85 +7844,85 @@ - - Constructs and initializes an instance of PVCSAssignGroupTask. - + + Constructs and initializes an instance of PVCSAssignGroupTask. + - - Gets or sets the promotion group to assign to the versioned files. - - - - This is equivalent to the -g parameter to the pcli assigngroup command. - - + + Gets or sets the promotion group to assign to the versioned files. + + + + This is equivalent to the -g parameter to the pcli assigngroup command. + + - - Gets or sets the promotion group for the versioned files to be assigned the promotion group. - - - - This is equivalent to the -r parameter to the pcli assigngroup command. - - + + Gets or sets the promotion group for the versioned files to be assigned the promotion group. + + + + This is equivalent to the -r parameter to the pcli assigngroup command. + + - - Gets or sets the revision for the versioned files to be assigned the promotion group. - - - - This is equivalent to the -r parameter to the pcli assigngroup command. - - - If this property has not yet been set, it will return Double.MaxValue. - - + + Gets or sets the revision for the versioned files to be assigned the promotion group. + + + + This is equivalent to the -r parameter to the pcli assigngroup command. + + + If this property has not yet been set, it will return Double.MaxValue. + + - - Gets or sets the version label for the versioned files to be assigned the promotion group. - - - - This is equivalent to the -r parameter to the pcli assigngroup command. - - + + Gets or sets the version label for the versioned files to be assigned the promotion group. + + + + This is equivalent to the -r parameter to the pcli assigngroup command. + + - - Changes the promotion group for specified versioned files. - - - - This task uses the changegroup PCLI command to change the group for versioned files. - - - - - Changes the promotion group for file.txt from SYSTEST to DEV. - - - - ]]> - - - - - Changes the promotion group for all files from DEV to PROD. - - - - ]]> - - + + Changes the promotion group for specified versioned files. + + + + This task uses the changegroup PCLI command to change the group for versioned files. + + + + + Changes the promotion group for file.txt from SYSTEST to DEV. + + + + ]]> + + + + + Changes the promotion group for all files from DEV to PROD. + + + + ]]> + + @@ -7861,24 +7934,24 @@ - - Gets or sets the promotion group to change from. - - - - This is equivalent to the -gf parameter to the pcli changegroup command. - - + + Gets or sets the promotion group to change from. + + + + This is equivalent to the -gf parameter to the pcli changegroup command. + + - - Gets or sets the promotion group to change to. - - - - This is equivalent to the -gt parameter to the pcli changegroup command. - - + + Gets or sets the promotion group to change to. + + + + This is equivalent to the -gt parameter to the pcli changegroup command. + + @@ -7930,48 +8003,48 @@ The value for the command, or null if no value applies. - - Constructs an instance of PVCSCommandArgument with the specified information. - - The command string. - The value for the command, or null if no value applies. - The position for the command. + + Constructs an instance of PVCSCommandArgument with the specified information. + + The command string. + The value for the command, or null if no value applies. + The position for the command. - - Compares two PVCS command arguments based on their position. - - The PVCS command argument to compare to this. - - Less than zero if this instance is less than . - Zero if this instance is equal to . - Greater than zero if this instance is greater than . - + + Compares two PVCS command arguments based on their position. + + The PVCS command argument to compare to this. + + Less than zero if this instance is less than . + Zero if this instance is equal to . + Greater than zero if this instance is greater than . + - - Converts this command argument to its string representation. - - The string representation of this command argument. + + Converts this command argument to its string representation. + + The string representation of this command argument. - - Escapes a string command line argument. - - - - This method attempts to deal with the mess of keeping both PCLI and the shell happy with string - arguments. It's not perfect yet (try an argument with several backslashes before a double quote). It - would be nice to have a regex to handle this but I wouldn't even bother until this logic is spot on. - - - The string argument to escape. - The escaped string argument. + + Escapes a string command line argument. + + + + This method attempts to deal with the mess of keeping both PCLI and the shell happy with string + arguments. It's not perfect yet (try an argument with several backslashes before a double quote). It + would be nice to have a regex to handle this but I wouldn't even bother until this logic is spot on. + + + The string argument to escape. + The escaped string argument. - - Gets a string that contains the command to pass to PVCS. - + + Gets a string that contains the command to pass to PVCS. + @@ -7984,9 +8057,9 @@ - - Gets the position for the command. - + + Gets the position for the command. + @@ -7997,35 +8070,35 @@ - - Adds a new command argument to this collection with the specified information. - - The command string for the new command. + + Adds a new command argument to this collection with the specified information. + + The command string for the new command. - - Adds a new command argument to this collection with the specified information. - - The command string for the new command. - - The command value for the new command, or null if no value applies. - + + Adds a new command argument to this collection with the specified information. + + The command string for the new command. + + The command value for the new command, or null if no value applies. + - - Adds a new command argument to this collection with the specified information. - - The command string for the new command. - - The command value for the new command, or null if no value applies. - - The position for the new command. + + Adds a new command argument to this collection with the specified information. + + The command string for the new command. + + The command value for the new command, or null if no value applies. + + The position for the new command. - - Adds all specified command arguments to this collection. - - The collection of command arguments to add. + + Adds all specified command arguments to this collection. + + The collection of command arguments to add. @@ -8081,15 +8154,15 @@ - - Arguments that should appear before the PCLI command argument. This is useful for arguments to PCLI - itself (as opposed to the PCLI command). - + + Arguments that should appear before the PCLI command argument. This is useful for arguments to PCLI + itself (as opposed to the PCLI command). + - - PCLI command arguments that should appear before other PCLI command arguments. - + + PCLI command arguments that should appear before other PCLI command arguments. + @@ -8098,30 +8171,30 @@ - - PCLI command arguments that should appear after other PCLI command arguments. - + + PCLI command arguments that should appear after other PCLI command arguments. + - - Creates a project in a PVCS repository. - - - - This task uses the createproject PCLI command to create the project in the PVCS repository. - - - - - Creates a project called Songs in the project database specified by the project-database - property. The workfile location for the project is set to C:\Work\Songs. - - - - ]]> - - + + Creates a project in a PVCS repository. + + + + This task uses the createproject PCLI command to create the project in the PVCS repository. + + + + + Creates a project called Songs in the project database specified by the project-database + property. The workfile location for the project is set to C:\Work\Songs. + + + + ]]> + + @@ -8130,49 +8203,49 @@ - - Gets or sets the workfile location for the created project. - - - - This is equivalent to the -w parameter to the pcli createproject command. - - + + Gets or sets the workfile location for the created project. + + + + This is equivalent to the -w parameter to the pcli createproject command. + + - - Removes a specified promotion group from versioned files. - - - - This task uses the deletegroup PCLI command to remove the promotion group from the versioned files. - - - - - Removes the DEV promotion group from App.ico in the project database specified by the - project-database property. - - - - ]]> - - - - - Removes the DEV promotion group all files in the project database specified by the - project-database property. - - - - ]]> - - + + Removes a specified promotion group from versioned files. + + + + This task uses the deletegroup PCLI command to remove the promotion group from the versioned files. + + + + + Removes the DEV promotion group from App.ico in the project database specified by the + project-database property. + + + + ]]> + + + + + Removes the DEV promotion group all files in the project database specified by the + project-database property. + + + + ]]> + + @@ -8181,55 +8254,55 @@ - - Gets or sets the promotion group to delete. - - - - This is equivalent to the -g parameter to the pcli deletegroup command. - - + + Gets or sets the promotion group to delete. + + + + This is equivalent to the -g parameter to the pcli deletegroup command. + + - - Removes a label from specified versioned files or projects. - - - - This task uses the deletelabel PCLI command to remove the version label from the versioned files. - - - - - Removes the label called My Label from the versioned file called App.ico from the project - database specified by the project-database property. - - - - - - - - ]]> - - - - - Removes the label called My Label from all files at and below both folder1 and folder2 - in the project database specified by the project-database property. - - - - - - - - - ]]> - - + + Removes a label from specified versioned files or projects. + + + + This task uses the deletelabel PCLI command to remove the version label from the versioned files. + + + + + Removes the label called My Label from the versioned file called App.ico from the project + database specified by the project-database property. + + + + + + + + ]]> + + + + + Removes the label called My Label from all files at and below both folder1 and folder2 + in the project database specified by the project-database property. + + + + + + + + + ]]> + + @@ -8238,85 +8311,85 @@ - - Gets or sets the version label to remove. - - - - This is equivalent to the -v parameter to the pcli deletelabel command. - - + + Gets or sets the version label to remove. + + + + This is equivalent to the -v parameter to the pcli deletelabel command. + + - - Deletes folder, projects, versioned items and workspaces in a PVCS repository. - - - - This task uses the delete PCLI command to delete the items. - - - - - Deletes the versioned file called App.ico from the project database specified by the - project-database property. - - - - - - - - ]]> - - - - - Deletes the files called file1.txt and file2.txt from the project called folder in the - project database specified by the project-database property. - - - - - - - - - ]]> - - + + Deletes folder, projects, versioned items and workspaces in a PVCS repository. + + + + This task uses the delete PCLI command to delete the items. + + + + + Deletes the versioned file called App.ico from the project database specified by the + project-database property. + + + + + + + + ]]> + + + + + Deletes the files called file1.txt and file2.txt from the project called folder in the + project database specified by the project-database property. + + + + + + + + + ]]> + + - - Deletes the specified users from the PVCS access control database. - - - - This task uses the deleteuser PCLI command to delete the users. - - - - - Deletes the users called kb, kv and tb from the project database specified by the - project-database property. - - - - - - - - - - ]]> - - + + Deletes the specified users from the PVCS access control database. + + + + This task uses the deleteuser PCLI command to delete the users. + + + + + Deletes the users called kb, kv and tb from the project database specified by the + project-database property. + + + + + + + + + + ]]> + + @@ -8325,59 +8398,59 @@ - - Gets files from a PVCS repository. - - - - This task uses the get PCLI command to get the versioned files from PVCS. - - - - - Gets the versioned file called App.ico from the project database specified by the - project-database property. - - - - - - - - ]]> - - - - - Gets the versioned file called App.ico from the project database specified by the - project-database property. The file is also locked. - - - - - - - - ]]> - - - - - Gets all revisions assigned the SYSTEST promotion group from the project database specified by the - project-database property. The workfiles are touched after the get operation. - - - - - - - - ]]> - - + + Gets files from a PVCS repository. + + + + This task uses the get PCLI command to get the versioned files from PVCS. + + + + + Gets the versioned file called App.ico from the project database specified by the + project-database property. + + + + + + + + ]]> + + + + + Gets the versioned file called App.ico from the project database specified by the + project-database property. The file is also locked. + + + + + + + + ]]> + + + + + Gets all revisions assigned the SYSTEST promotion group from the project database specified by the + project-database property. The workfiles are touched after the get operation. + + + + + + + + ]]> + + @@ -8413,170 +8486,170 @@ - - Constructs and initializes an instance of PVCSGetTask. - + + Constructs and initializes an instance of PVCSGetTask. + - - Gets or sets the base project path. - - - - This is equivalent to the -bp parameter to the pcli get command. - - + + Gets or sets the base project path. + + + + This is equivalent to the -bp parameter to the pcli get command. + + - - Gets or sets an alternative location for workfiles. - - - - This is equivalent to the -a parameter to the pcli get command. - - + + Gets or sets an alternative location for workfiles. + + + + This is equivalent to the -a parameter to the pcli get command. + + - - Gets or sets a value indicating whether revisions involved in the get operation should be locked. - - - - This is equivalent to the -l parameter to the pcli get command. - - + + Gets or sets a value indicating whether revisions involved in the get operation should be locked. + + + + This is equivalent to the -l parameter to the pcli get command. + + - - Gets or sets whether the workfiles should be made writable. - - - - This is equivalent to the -w parameter to the pcli get command. - - + + Gets or sets whether the workfiles should be made writable. + + + + This is equivalent to the -w parameter to the pcli get command. + + - - Gets or sets the maximum date and time of workfiles to retrieve. - - - - This is equivalent to the -d parameter to the pcli get command. - - - If this property has not yet been set, it will return DateTime.MaxValue. - - + + Gets or sets the maximum date and time of workfiles to retrieve. + + + + This is equivalent to the -d parameter to the pcli get command. + + + If this property has not yet been set, it will return DateTime.MaxValue. + + - - Gets or sets a value indicating whether the workfile location for files should be overridden. - - - - This is equivalent to the -o parameter to the pcli get command. - - + + Gets or sets a value indicating whether the workfile location for files should be overridden. + + + + This is equivalent to the -o parameter to the pcli get command. + + - - Gets or sets the promotion group to get. - - - - This is equivalent to the -g parameter to the pcli get command. - - + + Gets or sets the promotion group to get. + + + + This is equivalent to the -g parameter to the pcli get command. + + - - Gets or sets the revision to get against. - - - - This is equivalent to the -r parameter to the pcli get command. - - - If this property has not yet been set, it will return Double.MaxValue. - - + + Gets or sets the revision to get against. + + + + This is equivalent to the -r parameter to the pcli get command. + + + If this property has not yet been set, it will return Double.MaxValue. + + - - Gets or sets a value indicating whether workfiles should be touched after the get. - - - - This is equivalent to the -t parameter to the pcli get command. - - + + Gets or sets a value indicating whether workfiles should be touched after the get. + + + + This is equivalent to the -t parameter to the pcli get command. + + - - Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the - current workfile. - - - - This is equivalent to the -u parameter to the pcli get command (without specifying a - date or time). - - + + Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the + current workfile. + + + + This is equivalent to the -u parameter to the pcli get command (without specifying a + date or time). + + - - Gets or sets the version label to get against. - - - - This is equivalent to the -v parameter to the pcli get command. - - + + Gets or sets the version label to get against. + + + + This is equivalent to the -v parameter to the pcli get command. + + - - Assigns a version label to a revision of the specified versioned files. - - - - This task uses the label PCLI command to label the items. - - - - - Labels all files in the project database specified by the project-database property. The label - applied is Beta. - - - - - - - - ]]> - - - - - Labels revision 1.8 of App.ico as Dodgy in the project database specified by the - project-database property. - - - - - - - - ]]> - - + + Assigns a version label to a revision of the specified versioned files. + + + + This task uses the label PCLI command to label the items. + + + + + Labels all files in the project database specified by the project-database property. The label + applied is Beta. + + + + + + + + ]]> + + + + + Labels revision 1.8 of App.ico as Dodgy in the project database specified by the + project-database property. + + + + + + + + ]]> + + @@ -8588,84 +8661,84 @@ - - Constructs and initializes an instance of PVCSLabel. - + + Constructs and initializes an instance of PVCSLabel. + - - Gets or sets a value indicating whether the label should "float" to the newest revision. - - - - This is equivalent to the -f parameter to the pcli label command. - - + + Gets or sets a value indicating whether the label should "float" to the newest revision. + + + + This is equivalent to the -f parameter to the pcli label command. + + - - Gets or sets the revision to label. - - - - This is equivalent to the -r parameter to the pcli label command. - - - If this property has not yet been set, it will return Double.MaxValue. - - + + Gets or sets the revision to label. + + + + This is equivalent to the -r parameter to the pcli label command. + + + If this property has not yet been set, it will return Double.MaxValue. + + - - Gets or sets the version label to assign. - - - - This is equivalent to the -v parameter to the pcli label command. - - + + Gets or sets the version label to assign. + + + + This is equivalent to the -v parameter to the pcli label command. + + - - Locks a revision of the specified versioned files. - - - - This task uses the lock PCLI command to lock the versioned files. - - - - - Locks App.ico in the project database specified by the project-database property. - - - - - - - - ]]> - - - - - Locks all files at and below folder in the project database specified by the project-database - property. - - - - - - - - ]]> - - + + Locks a revision of the specified versioned files. + + + + This task uses the lock PCLI command to lock the versioned files. + + + + + Locks App.ico in the project database specified by the project-database property. + + + + + + + + ]]> + + + + + Locks all files at and below folder in the project database specified by the project-database + property. + + + + + + + + ]]> + + @@ -8686,111 +8759,111 @@ - - Constructs and initializes an instance of PVCSLock. - + + Constructs and initializes an instance of PVCSLock. + - - Gets or sets a value indicating whether locking files will take place if checking in those files would - result in a branch. - - - - This is equivalent to the -nb parameter to the pcli lock command. - - + + Gets or sets a value indicating whether locking files will take place if checking in those files would + result in a branch. + + + + This is equivalent to the -nb parameter to the pcli lock command. + + - - Gets or sets a value indicating whether already locked revisions will be locked. - - - - This is equivalent to the -nm parameter to the pcli lock command. - - + + Gets or sets a value indicating whether already locked revisions will be locked. + + + + This is equivalent to the -nm parameter to the pcli lock command. + + - - Gets or sets the promotion group to assign the locked revision. - - - - This is equivalent to the -g parameter to the pcli lock command. - - + + Gets or sets the promotion group to assign the locked revision. + + + + This is equivalent to the -g parameter to the pcli lock command. + + - - Gets or sets the revision to lock. - - - - This is equivalent to the -r parameter to the pcli lock command. - - - If this property has not yet been set, it will return Double.MaxValue. - - + + Gets or sets the revision to lock. + + + + This is equivalent to the -r parameter to the pcli lock command. + + + If this property has not yet been set, it will return Double.MaxValue. + + - - Gets or sets a value indicating whether revisions will be locked even if that will result in a branch - upon check in. - - - - This is equivalent to the -yb parameter to the pcli lock command. - - + + Gets or sets a value indicating whether revisions will be locked even if that will result in a branch + upon check in. + + + + This is equivalent to the -yb parameter to the pcli lock command. + + - - Gets or sets a value indicating whether revisions will be locked even if that will result in multiple - locks against the same revision. - - - - This is equivalent to the -ym parameter to the pcli lock command. - - + + Gets or sets a value indicating whether revisions will be locked even if that will result in multiple + locks against the same revision. + + + + This is equivalent to the -ym parameter to the pcli lock command. + + - - Promotes versioned files to the next promotion group. - - - - This task uses the promotegroup PCLI command to promote versioned files. - - - - - Promotes all files in the root of the project database specified by the project-database property. - The files are promoted from the DEV promotion group to the next. Promotion will not take place across - branches. - - - - ]]> - - - - - Promotes all files in the project database specified by the project-database property. The files are - promoted from the SYSTEST promotion group to the next. Promotion will take place across branches. - - - - ]]> - - + + Promotes versioned files to the next promotion group. + + + + This task uses the promotegroup PCLI command to promote versioned files. + + + + + Promotes all files in the root of the project database specified by the project-database property. + The files are promoted from the DEV promotion group to the next. Promotion will not take place across + branches. + + + + ]]> + + + + + Promotes all files in the project database specified by the project-database property. The files are + promoted from the SYSTEST promotion group to the next. Promotion will take place across branches. + + + + ]]> + + @@ -8802,83 +8875,83 @@ - - Gets or sets a value indicating whether the promotion may occur across branches. - - - - This is equivalent to the -nb and -yb parameters to the pcli promotegroup command. - - + + Gets or sets a value indicating whether the promotion may occur across branches. + + + + This is equivalent to the -nb and -yb parameters to the pcli promotegroup command. + + - - Gets or sets the promotion group to be promoted. - - - - This is equivalent to the -g parameter to the pcli promotegroup command. - - + + Gets or sets the promotion group to be promoted. + + + + This is equivalent to the -g parameter to the pcli promotegroup command. + + - - Puts files into a PVCS repository. - - - - This task uses the put PCLI command to put the files into PVCS. - - - - - Puts the file called App.ico into the project database specified by the project-database - property. The description for the change is Added more colour. - - - - - - - - ]]> - - - - - Puts all files into the project database specified by the project-database property. The description - for the changes is Major changes. Even if the workfiles have not been changed, they will result in a - new revision in PVCS. - - - - - - - - ]]> - - - - - Puts file.txt and all files in folder into the project database specified by the - project-database property. The description for the changes is Some changes. A new branch is - forcibly created via the forcebranch attribute. Leading and trailing whitespace is ignored when - determining whether the workfile has been altered. - - - - - - - - - ]]> - - + + Puts files into a PVCS repository. + + + + This task uses the put PCLI command to put the files into PVCS. + + + + + Puts the file called App.ico into the project database specified by the project-database + property. The description for the change is Added more colour. + + + + + + + + ]]> + + + + + Puts all files into the project database specified by the project-database property. The description + for the changes is Major changes. Even if the workfiles have not been changed, they will result in a + new revision in PVCS. + + + + + + + + ]]> + + + + + Puts file.txt and all files in folder into the project database specified by the + project-database property. The description for the changes is Some changes. A new branch is + forcibly created via the forcebranch attribute. Leading and trailing whitespace is ignored when + determining whether the workfile has been altered. + + + + + + + + + ]]> + + @@ -8926,42 +8999,42 @@ - - Constructs and initializes an instance of PVCSPut. - + + Constructs and initializes an instance of PVCSPut. + - - Gets or sets the base project path. - - - - This is equivalent to the -bp parameter to the pcli put command. - - + + Gets or sets the base project path. + + + + This is equivalent to the -bp parameter to the pcli put command. + + - - Gets or sets a value indicating whether unchanged workfiles should be checked in. - - - - This is equivalent to the -yf parameter to the pcli put command. - - + + Gets or sets a value indicating whether unchanged workfiles should be checked in. + + + + This is equivalent to the -yf parameter to the pcli put command. + + - - Gets or sets the description to be applied to the checked in revisions. - - - - This is equivalent to the -m parameter to the pcli put command. - - + + Gets or sets the description to be applied to the checked in revisions. + + + + This is equivalent to the -m parameter to the pcli put command. + + @@ -8975,78 +9048,78 @@ - - Gets or sets a value indicating whether a new branch will be created. - - - - This is equivalent to the -fb parameter to the pcli put command. - - + + Gets or sets a value indicating whether a new branch will be created. + + + + This is equivalent to the -fb parameter to the pcli put command. + + - - Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining - whether the revision has changed. - - - - This is equivalent to the -b parameter to the pcli put command. - - + + Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining + whether the revision has changed. + + + + This is equivalent to the -b parameter to the pcli put command. + + - - Gets or sets a value indicating whether the workfile should kept in its original state. - - - - This is equivalent to the -k parameter to the pcli put command. - - + + Gets or sets a value indicating whether the workfile should kept in its original state. + + + + This is equivalent to the -k parameter to the pcli put command. + + - - Gets or sets an alternative location for workfiles. - - - - This is equivalent to the -a parameter to the pcli put command. - - + + Gets or sets an alternative location for workfiles. + + + + This is equivalent to the -a parameter to the pcli put command. + + - - Gets or sets a value indicating the files should be locked after the put operation. - - - - This is equivalent to the -l parameter to the pcli put command. - - + + Gets or sets a value indicating the files should be locked after the put operation. + + + + This is equivalent to the -l parameter to the pcli put command. + + - - Gets or sets a value indicating whether the workfile location for files should be overridden. - - - - This is equivalent to the -o parameter to the pcli put command. - - + + Gets or sets a value indicating whether the workfile location for files should be overridden. + + + + This is equivalent to the -o parameter to the pcli put command. + + - - Gets or sets the promotion in use. If a promotion group is specified, this option identifies the - promotion group to which the revision is currently assigned. If no promotion group is specified (ie. - this property is set to an empty string), this option indicates that one is not identifying the - revision by promotion group. - - - - This is equivalent to the -g parameter to the pcli put command. - - + + Gets or sets the promotion in use. If a promotion group is specified, this option identifies the + promotion group to which the revision is currently assigned. If no promotion group is specified (ie. + this property is set to an empty string), this option indicates that one is not identifying the + revision by promotion group. + + + + This is equivalent to the -g parameter to the pcli put command. + + @@ -9060,75 +9133,75 @@ - - Gets or sets the revision number to use for the new revision. - - - - This is equivalent to the -r parameter to the pcli put command. - - + + Gets or sets the revision number to use for the new revision. + + + + This is equivalent to the -r parameter to the pcli put command. + + - - Gets or sets a value indicating whether the same description should be used for all versioned items. - This is true by default. - - - - This is equivalent to the -ym parameter to the pcli put command. - - + + Gets or sets a value indicating whether the same description should be used for all versioned items. + This is true by default. + + + + This is equivalent to the -ym parameter to the pcli put command. + + - - Gets or sets the version label to assign to the new revisions. - - - - This is equivalent to the -v parameter to the pcli put command. - - + + Gets or sets the version label to assign to the new revisions. + + + + This is equivalent to the -v parameter to the pcli put command. + + - - Renames a label in a PVCS repository. - - - - This task uses the renamelabel PCLI command to rename the label. - - - - - Renames the label on App.ico from Beater to Beta in the project database specified by - the project-database property. - - - - - - - - ]]> - - - - - Renames the label on all files from Alfa to Alpha in the project database specified by the - project-database property. - - - - - - - - ]]> - - + + Renames a label in a PVCS repository. + + + + This task uses the renamelabel PCLI command to rename the label. + + + + + Renames the label on App.ico from Beater to Beta in the project database specified by + the project-database property. + + + + + + + + ]]> + + + + + Renames the label on all files from Alfa to Alpha in the project database specified by the + project-database property. + + + + + + + + ]]> + + @@ -9140,63 +9213,63 @@ - - Gets or sets the existing label. - - - - This is equivalent to the -vf parameter to the pcli renamelabel command. - - + + Gets or sets the existing label. + + + + This is equivalent to the -vf parameter to the pcli renamelabel command. + + - - Gets or sets the new label. - - - - This is equivalent to the -vt parameter to the pcli renamelabel command. - - + + Gets or sets the new label. + + + + This is equivalent to the -vt parameter to the pcli renamelabel command. + + - - Unlocks revisions of versioned files in a PVCS repository. - - - - This task uses the unlock PCLI command to perform the unlock operation. - - - - - Unlocks App.ico in the project database specified by the project-database property. - - - - - - - - ]]> - - - - - Unlocks all files in the project specified by the project-database property. Locks by all users are - removed. - - - - - - - - ]]> - - + + Unlocks revisions of versioned files in a PVCS repository. + + + + This task uses the unlock PCLI command to perform the unlock operation. + + + + + Unlocks App.ico in the project database specified by the project-database property. + + + + + + + + ]]> + + + + + Unlocks all files in the project specified by the project-database property. Locks by all users are + removed. + + + + + + + + ]]> + + @@ -9208,32 +9281,32 @@ - - Constructs and initializes an instance of PVCSUnlock. - + + Constructs and initializes an instance of PVCSUnlock. + - - Gets or sets the revision number to use for the new revision. - - - - This is equivalent to the -r parameter to the pcli unlock command. - - + + Gets or sets the revision number to use for the new revision. + + + + This is equivalent to the -r parameter to the pcli unlock command. + + - - Gets or sets the unlock mode for the operation. - - - - This is equivalent to the -u parameter to the pcli unlock command. - - + + Gets or sets the unlock mode for the operation. + + + + This is equivalent to the -u parameter to the pcli unlock command. + + @@ -9247,51 +9320,51 @@ - - All locks held by the current user are removed. - + + All locks held by the current user are removed. + - - All locks held by a specified user are removed. - + + All locks held by a specified user are removed. + - - All locks held by all users are removed. - + + All locks held by all users are removed. + - - Used to add files to a Visual SourceSafe database. If the file is currently - in the SourceSafe database a message will be logged but files will continue to be added. - - - This version does not support recursive adds. Only adds in the root directory will be added to the - SourceSafe database. - - - - - - - - ]]> - + + Used to add files to a Visual SourceSafe database. If the file is currently + in the SourceSafe database a message will be logged but files will continue to be added. + + + This version does not support recursive adds. Only adds in the root directory will be added to the + SourceSafe database. + + + + + + + + ]]> + - - The base abstract class for all Visual Source Safe Tasks. - Provides the core attributes, and functionality for opening an item - in a Visual Source Safe database. - + + The base abstract class for all Visual Source Safe Tasks. + Provides the core attributes, and functionality for opening an item + in a Visual Source Safe database. + - - Opens the Source Safe database and sets the reference to the specified - item and version. - + + Opens the Source Safe database and sets the reference to the specified + item and version. + @@ -9305,20 +9378,20 @@ - - The path to the folder that contains "srcsafe.ini". - + + The path to the folder that contains "srcsafe.ini". + - - The Visual SourceSafe project or file path you wish the perform the - action on (starting with "$/"). - + + The Visual SourceSafe project or file path you wish the perform the + action on (starting with "$/"). + - - The password to use to login to the SourceSafe database. - + + The password to use to login to the SourceSafe database. + @@ -9337,220 +9410,220 @@ - - A version of the path to reference. Accepts multiple forms, - including the label, version number, or date of the version. - If omitted, the latest version is used. - + + A version of the path to reference. Accepts multiple forms, + including the label, version number, or date of the version. + If omitted, the latest version is used. + - - Main task execution method - + + Main task execution method + - - Create project hierarchy in vss - - - + + Create project hierarchy in vss + + + - - Places a comment on all files added into the SourceSafe repository. - + + Places a comment on all files added into the SourceSafe repository. + - - List of files that should be added to SourceSafe. - + + List of files that should be added to SourceSafe. + - - Defines how the local timestamp of files retrieved from a SourceSafe - database should be set. - + + Defines how the local timestamp of files retrieved from a SourceSafe + database should be set. + - - The timestamp of the local file is set to the current date and time. - + + The timestamp of the local file is set to the current date and time. + - - The timestamp of the local file is set to the file's last - modification date and time. - + + The timestamp of the local file is set to the file's last + modification date and time. + - - The timestamp of the local file is set to the date and time that - the file was last checked in to the database. - + + The timestamp of the local file is set to the date and time that + the file was last checked in to the database. + - - Used to checkin files into Visual Source Safe. - - - Checkin all files from an absolute directory to a local sourcesafe database. - - ]]> - - - Checkin a file from a relative directory to a remote sourcesafe database. - - ]]> - + + Used to checkin files into Visual Source Safe. + + + Checkin all files from an absolute directory to a local sourcesafe database. + + ]]> + + + Checkin a file from a relative directory to a remote sourcesafe database. + + ]]> + - - The comment for the new version. - + + The comment for the new version. + - - The path to the local working directory. - + + The path to the local working directory. + - - Determines whether to perform a recursive checkin. - The default is . - + + Determines whether to perform a recursive checkin. + The default is . + - - Determines whether to leave the file(s) as writable. - The default is . - + + Determines whether to leave the file(s) as writable. + The default is . + - - Task used to checkout files from Visual Source Safe. - - - Checkout the latest files from a local sourcesafe database. - - ]]> - - - Checkout a file from a remote sourcesafe database. Put it in a relative directory. - - ]]> - + + Task used to checkout files from Visual Source Safe. + + + Checkout the latest files from a local sourcesafe database. + + ]]> + + + Checkout a file from a remote sourcesafe database. Put it in a relative directory. + + ]]> + - - The path to the local working directory. - + + The path to the local working directory. + - - Determines whether to perform a recursive checkout. - The default is . - + + Determines whether to perform a recursive checkout. + The default is . + - - Determines whether to leave the file(s) as writable. - The default is . - + + Determines whether to leave the file(s) as writable. + The default is . + - - Set the behavior for timestamps of local files. The default is - . - + + Set the behavior for timestamps of local files. The default is + . + - - Used to delete or Destroy files or projects in Visual Source Safe. - - - Delete a project from a local sourcesafe database. - - ]]> - - - Delete a file from the remote sourcesafe database. - - ]]> - - - Destroy a project from a local sourcesafe database. - - ]]> - - - Destroy a file from the remote sourcesafe database. - - ]]> - + + Used to delete or Destroy files or projects in Visual Source Safe. + + + Delete a project from a local sourcesafe database. + + ]]> + + + Delete a file from the remote sourcesafe database. + + ]]> + + + Destroy a project from a local sourcesafe database. + + ]]> + + + Destroy a file from the remote sourcesafe database. + + ]]> + @@ -9559,129 +9632,129 @@ - - Determines whether or not the item is Destroyed. - The default is . - + + Determines whether or not the item is Destroyed. + The default is . + - - Used to generate differences in a vss database. It will show all changes to a project - after the specified label. - - - This only shows differences between the current version and the version specified. - - - - ]]> - + + Used to generate differences in a vss database. It will show all changes to a project + after the specified label. + + + This only shows differences between the current version and the version specified. + + + + ]]> + - - The value of the label to compare to. Required. - + + The value of the label to compare to. Required. + - - The output file to generate (xml) - + + The output file to generate (xml) + - - Used to retrieve an item or project from a Visual Source Safe database. - - - Get the latest files from a local sourcesafe database. - - ]]> - - - Get the latest version of a file from a remote sourcesafe database. Put it in a relative directory. - - ]]> - - - Get the latest version of a file from a remote sourcesafe database. Remove any deleted files from local image. - - ]]> - + + Used to retrieve an item or project from a Visual Source Safe database. + + + Get the latest files from a local sourcesafe database. + + ]]> + + + Get the latest version of a file from a remote sourcesafe database. Put it in a relative directory. + + ]]> + + + Get the latest version of a file from a remote sourcesafe database. Remove any deleted files from local image. + + ]]> + - - Checks to see if we should remove local copies of deleted files, and starts - the scan. - + + Checks to see if we should remove local copies of deleted files, and starts + the scan. + - - Scans the Project Item for deleted files and removes their local - copies from the local image of the project. Obeys the recursive setting - (and thus optionally calls itself recursively). - - The VSS Item (project) to check for deletions - The path to the folder of the item being processed + + Scans the Project Item for deleted files and removes their local + copies from the local image of the project. Obeys the recursive setting + (and thus optionally calls itself recursively). + + The VSS Item (project) to check for deletions + The path to the folder of the item being processed - - The path to the local working directory. - + + The path to the local working directory. + - - Determines whether to perform the get recursively. - The default is . - + + Determines whether to perform the get recursively. + The default is . + - - Determines whether to replace writable files. - The default is . - + + Determines whether to replace writable files. + The default is . + - - Determines whether the files will be writable. - The default is . - + + Determines whether the files will be writable. + The default is . + @@ -9691,94 +9764,94 @@ - - Determines whether the timestamp on the local copy - will be the modification time (if false or omitted, - the checkout time will be used) - + + Determines whether the timestamp on the local copy + will be the modification time (if false or omitted, + the checkout time will be used) + - - Set the behavior for timestamps of local files. The default is - . - + + Set the behavior for timestamps of local files. The default is + . + - - Generates an XML file showing all changes made to a Visual SourceSafe - project/file between specified labels or dates (by a given user). - - - - Write all changes between "Release1" and "Release2" to XML file - "changelog.xml". - - - - ]]> - - - - - Write all changes between January 1st 2004 and March 31st 2004 to XML - file "history.xml". - - - - ]]> - - + + Generates an XML file showing all changes made to a Visual SourceSafe + project/file between specified labels or dates (by a given user). + + + + Write all changes between "Release1" and "Release2" to XML file + "changelog.xml". + + + + ]]> + + + + + Write all changes between January 1st 2004 and March 31st 2004 to XML + file "history.xml". + + + + ]]> + + - - The value of the label to start comparing to. If it is not included, - the compare will start with the very first history item. - + + The value of the label to start comparing to. If it is not included, + the compare will start with the very first history item. + - - The value of the label to compare up to. If it is not included, - the compare will end with the last history item. - + + The value of the label to compare up to. If it is not included, + the compare will end with the last history item. + - - Start date for comparison. - + + Start date for comparison. + - - End date for comparison. - + + End date for comparison. + - - Output file to save history to (as XML). - + + Output file to save history to (as XML). + - - Determines whether to perform the comparison recursively. - The default is . - + + Determines whether to perform the comparison recursively. + The default is . + - - Name of the user whose changes you want to see. - + + Name of the user whose changes you want to see. + @@ -9787,124 +9860,124 @@ - - Override to avoid exposing the corresponding attribute to build - authors. - + + Override to avoid exposing the corresponding attribute to build + authors. + - - Override to avoid exposing the corresponding attribute to build - authors. - + + Override to avoid exposing the corresponding attribute to build + authors. + - - Used to apply a label to a Visual Source Safe item. - - - Label all files in a local sourcesafe database. (Automatically applies the label recursively) - - ]]> - - - Label a file in a remote sourcesafe database. - - ]]> - + + Used to apply a label to a Visual Source Safe item. + + + Label all files in a local sourcesafe database. (Automatically applies the label recursively) + + ]]> + + + Label a file in a remote sourcesafe database. + + ]]> + - - The label comment. - + + The label comment. + - - The name of the label. - + + The name of the label. + - - Task is used to undo a checkout from SourceSafe - - - Undo a checkout of all of the files from a local sourcesafe database. - - ]]> - - - Checkout a file from a remote sourcesafe database. Put it in a relative directory. - - ]]> - + + Task is used to undo a checkout from SourceSafe + + + Undo a checkout of all of the files from a local sourcesafe database. + + ]]> + + + Checkout a file from a remote sourcesafe database. Put it in a relative directory. + + ]]> + - - The path to the local working directory. This is required if you wish to - have your local file replaced with the latest version from SourceSafe. - + + The path to the local working directory. This is required if you wish to + have your local file replaced with the latest version from SourceSafe. + - - Determines whether to perform a recursive undo of the checkout. - The default is . - + + Determines whether to perform a recursive undo of the checkout. + The default is . + - - Allows creation of view labels in StarTeam repositories. - - - Often when building projects you wish to label the source control repository. - By default this task creates view labels with the build option turned on. - This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel - You need to have the StarTeam SDK installed for this task to function correctly. - - - Creates a label in a StarTeam repository. - - - - - ]]> - - + + Allows creation of view labels in StarTeam repositories. + + + Often when building projects you wish to label the source control repository. + By default this task creates view labels with the build option turned on. + This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel + You need to have the StarTeam SDK installed for this task to function correctly. + + + Creates a label in a StarTeam repository. + + + + + ]]> + + @@ -9924,32 +9997,32 @@ Steve Cohen - The username of the connection + The username of the connection - The username of the connection + The username of the connection - name of Starteam server to connect to + name of Starteam server to connect to - port of Starteam server to connect to + port of Starteam server to connect to - name of Starteam project to connect to + name of Starteam project to connect to - name of Starteam view to connect to + name of Starteam view to connect to - The starteam server through which all activities will be done. + The starteam server through which all activities will be done. - - Derived classes must override this method to instantiate a view configured appropriately to its task. - - the unconfigured View - the view appropriately configured. + + Derived classes must override this method to instantiate a view configured appropriately to its task. + + the unconfigured View + the view appropriately configured. @@ -9959,9 +10032,9 @@ - Returns the name of the user or a blank string if the user is not found. - a user's ID - the name of the user + Returns the name of the user or a blank string if the user is not found. + a user's ID + the name of the user @@ -10039,39 +10112,39 @@ - The name of the label to be set in Starteam. + The name of the label to be set in Starteam. - The label description to be set in Starteam. + The label description to be set in Starteam. - Is the label being created a build label. + Is the label being created a build label. - If set the datetime to set the label as of. + If set the datetime to set the label as of. - Kludgy flag to keep track if date has been set. - Please kill this if you can. Here based on experiences I have had with VB.NET + Kludgy flag to keep track if date has been set. + Please kill this if you can. Here based on experiences I have had with VB.NET - Does user wish to make a revision label? + Does user wish to make a revision label? - - Override of base-class abstract function creates an appropriately configured view. - For labels this a view configured as of this.lastBuild. - - the unconfigured View - the snapshot View appropriately configured. + + Override of base-class abstract function creates an appropriately configured view. + For labels this a view configured as of this.lastBuild. + + the unconfigured View + the snapshot View appropriately configured. - - The name to be given to the label; required. - + + The name to be given to the label; required. + - Should label be marked build : default is true + Should label be marked build : default is true @@ -10084,7 +10157,7 @@ - Optional description of the label to be stored in the StarTeam project. + Optional description of the label to be stored in the StarTeam project. @@ -10189,28 +10262,28 @@ - - Locate the versionnumber.xml file in the repository. If it - is not present, the file is created. The file is checked out - exclusively for editing. - - StarTeam view we are working with. - - StarTeam file handle containing version xml. - + + Locate the versionnumber.xml file in the repository. If it + is not present, the file is created. The file is checked out + exclusively for editing. + + StarTeam view we are working with. + + StarTeam file handle containing version xml. + - - Creates the versionumber.xml file in the repository. - - StarTeam folder desired to put the versionnumber.xml files into - StarTeam File handle to the created file. + + Creates the versionumber.xml file in the repository. + + StarTeam folder desired to put the versionnumber.xml files into + StarTeam File handle to the created file. - - Allows user to specify the filename where the version xml is stored. - The default is versionnumber.xml. - + + Allows user to specify the filename where the version xml is stored. + The default is versionnumber.xml. + @@ -10294,15 +10367,15 @@ - - Helper method calls on the StarTeam API to retrieve an ID number for the specified view, corresponding to this.label. - - The Label identifier or -1 if no label was provided. + + Helper method calls on the StarTeam API to retrieve an ID number for the specified view, corresponding to this.label. + + The Label identifier or -1 if no label was provided. - Derived classes must override this class to define actual processing to be performed on each folder in the tree defined for the task - the StarTeam folderto be visited - the local mapping of rootStarteamFolder + Derived classes must override this class to define actual processing to be performed on each folder in the tree defined for the task + the StarTeam folderto be visited + the local mapping of rootStarteamFolder @@ -10312,16 +10385,16 @@ - - Gets the collection of the local file names in the supplied directory. - We need to check this collection against what we find in Starteam to - understand what we need to do in order to synch with the repository. - - - The goal is to keep track of which local files are not controlled by StarTeam. - - Local folder to scan - hashtable whose keys represent a file or directory in localFolder. + + Gets the collection of the local file names in the supplied directory. + We need to check this collection against what we find in Starteam to + understand what we need to do in order to synch with the repository. + + + The goal is to keep track of which local files are not controlled by StarTeam. + + Local folder to scan + hashtable whose keys represent a file or directory in localFolder. @@ -10349,35 +10422,35 @@ Regular expresssion for searching matching file names - - Convert path patterns to regularexpression patterns. Stored in the given string collection. - - collection of paths to expand into regular expressions - collection to store the given regularexpression patterns + + Convert path patterns to regularexpression patterns. Stored in the given string collection. + + collection of paths to expand into regular expressions + collection to store the given regularexpression patterns - - Root StarTeam folder to begin operations on. Defaults to the root of the view. - + + Root StarTeam folder to begin operations on. Defaults to the root of the view. + - - Root Local folder where files are to be checkout/in or manipulated. Defaults to the StarTeam default folder. - + + Root Local folder where files are to be checkout/in or manipulated. Defaults to the StarTeam default folder. + - - Accepts comma de-limited list of expressions to include in tree operations. - If nothing is set ALL filespecs are included. - - - Match all C# files in the directory - *.cs - - - Expressions should be just for filename matching. - Technically relative directory information is accepted but will never match. - + + Accepts comma de-limited list of expressions to include in tree operations. + If nothing is set ALL filespecs are included. + + + Match all C# files in the directory + *.cs + + + Expressions should be just for filename matching. + Technically relative directory information is accepted but will never match. + @@ -10397,9 +10470,9 @@ - - Default : true - should tasks recurse through tree. - + + Default : true - should tasks recurse through tree. + @@ -10413,70 +10486,70 @@ - - Label used for checkout. If no label is set latest state of repository is checked out. - - - The label must exist in starteam or an exception will be thrown. - + + Label used for checkout. If no label is set latest state of repository is checked out. + + + The label must exist in starteam or an exception will be thrown. + - classes used to access static values + classes used to access static values - Facotry classes used when files and folders are added to the repository. Populated when adduncontrolled is enabled. + Facotry classes used when files and folders are added to the repository. Populated when adduncontrolled is enabled. - will folders be created for new items found with the checkin. + will folders be created for new items found with the checkin. - The comment which will be stored with the checkin. + The comment which will be stored with the checkin. - holder for the add Uncontrolled attribute. If true, all local files not in StarTeam will be added to the repository. + holder for the add Uncontrolled attribute. If true, all local files not in StarTeam will be added to the repository. - This attribute tells whether unlocked files on checkin (so that other users may access them) checkout or to - leave the checkout status alone (default). - + This attribute tells whether unlocked files on checkin (so that other users may access them) checkout or to + leave the checkout status alone (default). + - - Override of base-class abstract function creates an appropriately configured view. For checkins this is - always the current or "tip" view. - - the unconfigured View - the snapshot View appropriately configured. + + Override of base-class abstract function creates an appropriately configured view. For checkins this is + always the current or "tip" view. + + the unconfigured View + the snapshot View appropriately configured. - Implements base-class abstract function to define tests for any preconditons required by the task + Implements base-class abstract function to define tests for any preconditons required by the task - Implements base-class abstract function to perform the checkin operation on the files in each folder of the tree. - the StarTeam folder to which files will be checked in - local folder from which files will be checked in + Implements base-class abstract function to perform the checkin operation on the files in each folder of the tree. + the StarTeam folder to which files will be checked in + local folder from which files will be checked in - Adds to the StarTeam repository everything on the local machine that is not currently in the repository. - Hasttable containing files missing in the repository for the current folder - StarTeam folder to which these items are to be added. + Adds to the StarTeam repository everything on the local machine that is not currently in the repository. + Hasttable containing files missing in the repository for the current folder + StarTeam folder to which these items are to be added. - Adds the file or directpry to the repository. - StarTeam folder underwhich items will be added. - the file or directory to add - true if the file was successfully added otherwise false. + Adds the file or directpry to the repository. + StarTeam folder underwhich items will be added. + the file or directory to add + true if the file was successfully added otherwise false. - - if true, any files or folders NOT in StarTeam will be added to the repository. Defaults to "false". - + + if true, any files or folders NOT in StarTeam will be added to the repository. Defaults to "false". + - - Set to do an unlocked checkout; optional, default is false; - If true, file will be unlocked so that other users may change it. If false, lock status will not change. - + + Set to do an unlocked checkout; optional, default is false; + If true, file will be unlocked so that other users may change it. If false, lock status will not change. + @@ -10503,130 +10576,130 @@ - holder for the createDirs property. + holder for the createDirs property. - holder for the deleteUncontrolled property. + holder for the deleteUncontrolled property. - holder for the lockstatus property. + holder for the lockstatus property. - - Override of base-class abstract function creates an appropriately configured view for checkout. - If a label is specified it is used otherwise the current view of the repository is used. - - the unconfigured StarTeam View - the snapshot StarTeam View appropriately configured. + + Override of base-class abstract function creates an appropriately configured view for checkout. + If a label is specified it is used otherwise the current view of the repository is used. + + the unconfigured StarTeam View + the snapshot StarTeam View appropriately configured. - Implements base-class abstract function to define tests for any preconditons required by the task + Implements base-class abstract function to define tests for any preconditons required by the task - - Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree. - - the StarTeam folder from which files to be checked out - the local mapping of the starteam folder + + Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree. + + the StarTeam folder from which files to be checked out + the local mapping of the starteam folder - - Deletes everything on the local machine that is not in the repository. - - Hashtable containing filenames to be deleted + + Deletes everything on the local machine that is not in the repository. + + Hashtable containing filenames to be deleted - Utility method to delete the file (and it's children) from the local drive. - the file or directory to delete. - was the file successfully deleted + Utility method to delete the file (and it's children) from the local drive. + the file or directory to delete. + was the file successfully deleted - - Default : true - Create directories that are in the Starteam repository even if they are empty. - + + Default : true - Create directories that are in the Starteam repository even if they are empty. + - - Not fully tested CAREFUL Default : false - Should all local files NOT in StarTeam be deleted? - + + Not fully tested CAREFUL Default : false - Should all local files NOT in StarTeam be deleted? + - - What type of lock to apply to files checked out. - - - LockType - - - unchanged - default: do not make any changes to the lock state of items. - - - exclusive - Exclusively lock items. No other users can update the object while it is exclusively locked. - - - nonexclusive - Put a non-exclusive lock on the item. - - - unlocked - Remove locks from all items checked out. This accompanied by force would effectively override a lock and replace local contents with the current version. - - - + + What type of lock to apply to files checked out. + + + LockType + + + unchanged + default: do not make any changes to the lock state of items. + + + exclusive + Exclusively lock items. No other users can update the object while it is exclusively locked. + + + nonexclusive + Put a non-exclusive lock on the item. + + + unlocked + Remove locks from all items checked out. This accompanied by force would effectively override a lock and replace local contents with the current version. + + + - - Allows creation of view labels in StarTeam repositories. - - - Often when building projects you wish to label the source control repository. - By default this task creates view labels with the build option turned on. - This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel - You need to have the StarTeam SDK installed for this task to function correctly. - - - Creates a label in a StarTeam repository. - - - - - ]]> - - + + Allows creation of view labels in StarTeam repositories. + + + Often when building projects you wish to label the source control repository. + By default this task creates view labels with the build option turned on. + This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel + You need to have the StarTeam SDK installed for this task to function correctly. + + + Creates a label in a StarTeam repository. + + + + + ]]> + + - - This method does the work of creating the new view and checking it - into Starteam. - + + This method does the work of creating the new view and checking it + into Starteam. + - - List items in StarTeam repositories. - - - This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlist - You need to have the StarTeam SDK installed for this task to function correctly. - - - Lists all files in a StarTeam repository. - - - - - ]]> - - + + List items in StarTeam repositories. + + + This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlist + You need to have the StarTeam SDK installed for this task to function correctly. + + + Lists all files in a StarTeam repository. + + + + + ]]> + + @@ -10637,59 +10710,59 @@ the snapshot View appropriately configured. - Required base-class abstract function implementation is a no-op here. + Required base-class abstract function implementation is a no-op here. - Implements base-class abstract function to perform the checkout - operation on the files in each folder of the tree. - the StarTeam folder from which files to be checked out - the local mapping of rootStarteamFolder + Implements base-class abstract function to perform the checkout + operation on the files in each folder of the tree. + the StarTeam folder from which files to be checked out + the local mapping of rootStarteamFolder - - Processes Surround SCM batch files. - - - Processes the batch commands found in the input file. Each line in the - input file should contain a single Surround SCM command including proper - command line options. The sscm command, Surround SCM server address, - port number, username and password are not required for each command line. - - - - Run the batch file ${src}/sscm.batch on the server at localhost, - port 4900 with username 'administrator' and a blank password. All script - output is directed to the console. - - - <sscmbatch - serverconnect="localhost:4900" - serverlogin="administrator:" - input="${src}/sscm.batch" - /> - - - - - Run the batch file ${src}/sscm.batch on the server at localhost, - port 4900 with username 'administrator' and a blank password. All script - output is redirected to ${dist}/sscm.batch.out. - - - <sscmbatch - serverconnect="localhost:4900" - serverconnect="administrator:" - input="${src}/sscm.batch" - output="${dist}/sscm.batch.out" - /> - - + + Processes Surround SCM batch files. + + + Processes the batch commands found in the input file. Each line in the + input file should contain a single Surround SCM command including proper + command line options. The sscm command, Surround SCM server address, + port number, username and password are not required for each command line. + + + + Run the batch file ${src}/sscm.batch on the server at localhost, + port 4900 with username 'administrator' and a blank password. All script + output is directed to the console. + + + <sscmbatch + serverconnect="localhost:4900" + serverlogin="administrator:" + input="${src}/sscm.batch" + /> + + + + + Run the batch file ${src}/sscm.batch on the server at localhost, + port 4900 with username 'administrator' and a blank password. All script + output is redirected to ${dist}/sscm.batch.out. + + + <sscmbatch + serverconnect="localhost:4900" + serverconnect="administrator:" + input="${src}/sscm.batch" + output="${dist}/sscm.batch.out" + /> + + - - Surround SCM - abstract task base. - + + Surround SCM + abstract task base. + @@ -10699,31 +10772,31 @@ The to write the task-specific arguments to. - - The address and port number of the Surround SCM server host computer. - Format is server:port. If not entered, the last saved connection - parameters are used. - + + The address and port number of the Surround SCM server host computer. + Format is server:port. If not entered, the last saved connection + parameters are used. + - - The username and password used to login to the Surround SCM server. - Format is username:password. If not entered, the last saved login - parameters are used. - + + The username and password used to login to the Surround SCM server. + Format is username:password. If not entered, the last saved login + parameters are used. + - - Override ExeName paramater to sscm.exe for Surround SCM. - + + Override ExeName paramater to sscm.exe for Surround SCM. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + @@ -10733,74 +10806,74 @@ The to write the task-specific arguments to. - - File to read commands from. - + + File to read commands from. + - - File to direct all standard output to. When executing commands from - the input file, all output is written to this file instead of being - displayed on the screen. - + + File to direct all standard output to. When executing commands from + the input file, all output is written to this file instead of being + displayed on the screen. + - - Creates new branches for Surround SCM. - - - - Create a new Baseline branch 'Widget 1.0' from branch 'Mainline', - repository 'Mainline/Widget' with the given comments. All files - are branched at the tip version. - - - <sscmbranch - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="Widget 1.0" - repository="Mainline/Widget" - parent="Mainline" - comment="Branch for continuing Widget 1.0 development" - type="baseline" - /> - - - - - Create a new Workspace branch 'MyWidgetDevelopment' from branch - 'Widget 1.0', repository 'Mainline/Widget'. All files are branched - at the tip version. - - - <sscmbranch - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="MyWidgetDevelopment" - repository="Mainline/Widget" - parent="Widget 1.0" - /> - - - - - Create a new Snapshot branch 'Build as of 12-1-03' from branch - 'Widget 1.0', repository 'Mainline/Widget' with the given comments. - All files are branched at their version as of 12-01-03. - - - <sscmbranch - serverconnect="localhost:4900" - serverlogin="administrator:" - name="Build as of 12-1-03" - repository="Mainline/Widget" - branch="Widget 1.0" - comment="Snapshot of source as it was on December 1st, 2003" - timestamp="2003120300:00:00" - type="snapshot" - /> - - + + Creates new branches for Surround SCM. + + + + Create a new Baseline branch 'Widget 1.0' from branch 'Mainline', + repository 'Mainline/Widget' with the given comments. All files + are branched at the tip version. + + + <sscmbranch + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="Widget 1.0" + repository="Mainline/Widget" + parent="Mainline" + comment="Branch for continuing Widget 1.0 development" + type="baseline" + /> + + + + + Create a new Workspace branch 'MyWidgetDevelopment' from branch + 'Widget 1.0', repository 'Mainline/Widget'. All files are branched + at the tip version. + + + <sscmbranch + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="MyWidgetDevelopment" + repository="Mainline/Widget" + parent="Widget 1.0" + /> + + + + + Create a new Snapshot branch 'Build as of 12-1-03' from branch + 'Widget 1.0', repository 'Mainline/Widget' with the given comments. + All files are branched at their version as of 12-01-03. + + + <sscmbranch + serverconnect="localhost:4900" + serverlogin="administrator:" + name="Build as of 12-1-03" + repository="Mainline/Widget" + branch="Widget 1.0" + comment="Snapshot of source as it was on December 1st, 2003" + timestamp="2003120300:00:00" + type="snapshot" + /> + + @@ -10810,31 +10883,31 @@ The to write the task-specific arguments to. - - The name of the branch you want to create. - + + The name of the branch you want to create. + - - The full repository path. - + + The full repository path. + - - The parent branch you want to create the new, child branch from. - If not specified, the mainline branch is used. - + + The parent branch you want to create the new, child branch from. + If not specified, the mainline branch is used. + - - Specifies a comment for the branch operation. - + + Specifies a comment for the branch operation. + - - Specifies which parent branch file versions are copied into the - child branch. - + + Specifies which parent branch file versions are copied into the + child branch. + @@ -10851,61 +10924,61 @@ - - Specifies the type of branch you want to create. Possible values are - workspace, baseline, or snapshot. The default is - workspace. - + + Specifies the type of branch you want to create. Possible values are + workspace, baseline, or snapshot. The default is + workspace. + - - Checks in files in Surround SCM - repository. - - - Check in updated Surround SCM files with changes, removes the lock on - the files, and makes changes available to other users. - - - - Check In all files and repositories from repository 'Mainline/Widget' - recursively from the 'Widget 1.0' branch to the working directory setup - for user 'administrator'. This call outputs the progress of the Check In - to the console. - - - <sscmcheckin - serverconnect="localhost:4900" - serverlogin="administrator:" - file="/" - branch="Widget 1.0" - repository="Mainline/Widget" - recursive="true" - comment="I made some changes" - /> - - - - - Check in file 'Mainline/Widget/Widget.java' from the 'Widget 1.0' - branch from the working directory setup for user 'administrator' - with comment 'I made some changes'. Set the 'Release 1.1.1' label - to this new version, even if the label already exists on an earlier - version. - - - <sscmcheckin - serverconnect="localhost:4900" - serverlogin="administrator:" - file="Widget.java" - branch="Widget 1.0" - repository="Mainline/Widget" - comment="I made some changes" - label="Release 1.1.1" - overwritelabel="true" - /> - - + + Checks in files in Surround SCM + repository. + + + Check in updated Surround SCM files with changes, removes the lock on + the files, and makes changes available to other users. + + + + Check In all files and repositories from repository 'Mainline/Widget' + recursively from the 'Widget 1.0' branch to the working directory setup + for user 'administrator'. This call outputs the progress of the Check In + to the console. + + + <sscmcheckin + serverconnect="localhost:4900" + serverlogin="administrator:" + file="/" + branch="Widget 1.0" + repository="Mainline/Widget" + recursive="true" + comment="I made some changes" + /> + + + + + Check in file 'Mainline/Widget/Widget.java' from the 'Widget 1.0' + branch from the working directory setup for user 'administrator' + with comment 'I made some changes'. Set the 'Release 1.1.1' label + to this new version, even if the label already exists on an earlier + version. + + + <sscmcheckin + serverconnect="localhost:4900" + serverlogin="administrator:" + file="Widget.java" + branch="Widget 1.0" + repository="Mainline/Widget" + comment="I made some changes" + label="Release 1.1.1" + overwritelabel="true" + /> + + @@ -10915,154 +10988,154 @@ The to write the task-specific arguments to. - - Surround SCM branch name. The default is pulled from the local - working directory. - + + Surround SCM branch name. The default is pulled from the local + working directory. + - - Surround SCM repository path. The default is pulled from the local - working directory. - + + Surround SCM repository path. The default is pulled from the local + working directory. + - - File or repository name. Can be / or empty, which means the - repository specified by the repository option or the default - repository. - + + File or repository name. Can be / or empty, which means the + repository specified by the repository option or the default + repository. + - - Comment for the check-in. - + + Comment for the check-in. + - - Force check in without merge. Ignores code changes checked in after - the user's last checkout or merge. The default is . - + + Force check in without merge. Ignores code changes checked in after + the user's last checkout or merge. The default is . + - - Get file after check in. The default is . - + + Get file after check in. The default is . + - - Keep the lock after check in. The default is . - + + Keep the lock after check in. The default is . + - - A label for the check in code. - + + A label for the check in code. + - - Overwrite previous label on file. The default is - . - + + Overwrite previous label on file. The default is + . + - - Do not list repository and local full path of the Surround - SCM server. The default is . - + + Do not list repository and local full path of the Surround + SCM server. The default is . + - - Recursively check in all files and sub-repositories. - The default is . - + + Recursively check in all files and sub-repositories. + The default is . + - - The TestTrack Pro database configuration name. - + + The TestTrack Pro database configuration name. + - - The TestTrack Pro username and password. - + + The TestTrack Pro username and password. + - - The TestTrack Pro defect number(s) for attachment. Format is "#:#:#:#". - + + The TestTrack Pro defect number(s) for attachment. Format is "#:#:#:#". + - - Make file writable after check in. The default is - . - + + Make file writable after check in. The default is + . + - - Update version even if no changes. The default is - . - + + Update version even if no changes. The default is + . + - - Remove local file after check in. The default is - . - + + Remove local file after check in. The default is + . + - - Checks out files from a Surround SCM - repository. - - - You can check out single files, multiple files, or a full repository. - Surround SCM creates a read-write copy of the files in the working - directory. - - - - Check Out all files and repositories from repository 'Mainline/Widget' - recursively from the 'Widget 1.0' branch to the working directory setup - for user 'administrator'. This call forces the file retrieval from the - server even if the local file is current and overwrites any writable - local files with the server copy. - - - <sscmcheckout - serverconnect="localhost:4900" - serverlogin="administrator:" - file="/" - branch="Widget 1.0" - repository="Mainline/Widget" - recursive="true" - force="true" - comment="This is my Check Out comment" - /> - - - - - Check Out version 1 of the file 'Mainline/Widget/Widget.java' exclusively - from the 'Widget 1.0' branch to the working directory setup for user - 'administrator'. Writable local files are not overwritten, even if they - are out of date. - - - <sscmcheckout - serverconnect="localhost:4900" - serverlogin="administrator:" - quiet="true" - file="Widget.java" - branch="Widget 1.0" - repository="Mainline/Widget" - overwrite="false" - writable="true" - version="1" - exclusive="true" - /> - - + + Checks out files from a Surround SCM + repository. + + + You can check out single files, multiple files, or a full repository. + Surround SCM creates a read-write copy of the files in the working + directory. + + + + Check Out all files and repositories from repository 'Mainline/Widget' + recursively from the 'Widget 1.0' branch to the working directory setup + for user 'administrator'. This call forces the file retrieval from the + server even if the local file is current and overwrites any writable + local files with the server copy. + + + <sscmcheckout + serverconnect="localhost:4900" + serverlogin="administrator:" + file="/" + branch="Widget 1.0" + repository="Mainline/Widget" + recursive="true" + force="true" + comment="This is my Check Out comment" + /> + + + + + Check Out version 1 of the file 'Mainline/Widget/Widget.java' exclusively + from the 'Widget 1.0' branch to the working directory setup for user + 'administrator'. Writable local files are not overwritten, even if they + are out of date. + + + <sscmcheckout + serverconnect="localhost:4900" + serverlogin="administrator:" + quiet="true" + file="Widget.java" + branch="Widget 1.0" + repository="Mainline/Widget" + overwrite="false" + writable="true" + version="1" + exclusive="true" + /> + + @@ -11072,16 +11145,16 @@ The to write the task-specific arguments to. - - Surround SCM branch name. The default is pulled from the local - working directory. - + + Surround SCM branch name. The default is pulled from the local + working directory. + - - Surround SCM repository path. The default is pulled from the local - working directory. - + + Surround SCM repository path. The default is pulled from the local + working directory. + @@ -11091,44 +11164,44 @@ - - Comment for the check-out. - + + Comment for the check-out. + - - Force file retrieval from server regardless of the local copy status. - The default is . - + + Force file retrieval from server regardless of the local copy status. + The default is . + - - Do not list repository and local full path of the Surround SCM server. - The default is . - + + Do not list repository and local full path of the Surround SCM server. + The default is . + - - Recursively get files and sub-repositories. The default is - . - + + Recursively get files and sub-repositories. The default is + . + - - Specifies whether to overwrite local writable files. The default is - . - + + Specifies whether to overwrite local writable files. The default is + . + - - Specifies how to set the local file's date/time. Possible values are - current, modify or checkin. - + + Specifies how to set the local file's date/time. Possible values are + current, modify or checkin. + - - Exclusively lock the files. The default is . - + + Exclusively lock the files. The default is . + @@ -11137,30 +11210,30 @@ - - Freezes branches in a Surround SCM - repository. - - - Freezing a branch prevents any code changes being made to files in the - branch. When a branch is frozen, it is locked and no changes can be - made to it. - - - - Freeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the - server at localhost, port 4900 with username 'administrator' and a - blank password. - - - <sscmfreeze - serverconnect="localhost:4900" - serverlogin="administrator:" - mainline="Mainline" - branch="Widget 1.0" - /> - - + + Freezes branches in a Surround SCM + repository. + + + Freezing a branch prevents any code changes being made to files in the + branch. When a branch is frozen, it is locked and no changes can be + made to it. + + + + Freeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the + server at localhost, port 4900 with username 'administrator' and a + blank password. + + + <sscmfreeze + serverconnect="localhost:4900" + serverlogin="administrator:" + mainline="Mainline" + branch="Widget 1.0" + /> + + @@ -11170,88 +11243,88 @@ The to write the task-specific arguments to. - - Surround SCM branch name. - + + Surround SCM branch name. + - - Surround SCM mainline branch name. The default is pulled from the - local working directory. - + + Surround SCM mainline branch name. The default is pulled from the + local working directory. + - - Gets files from a Surround SCM - repository. - - - You can get a single file, multiple files, or a repository. A read-only - copy of the file is created in the specified directory. - - - - Get all files and repositories from repository 'Mainline/Widget' - recursively from the 'Widget 1.0' branch to the working directory - setup for user 'administrator'. This call forces the file retrieval - from the server even if the local file is current and overwrites any - local files that are writable with the server copy. - - - <sscmget - serverconnect="localhost:4900" - serverlogin="administrator:" - file="/" - branch="Widget 1.0" - repository="Mainline/Widget" - recursive="true" - force="true" - overwrite="true" - /> - - - - - Get version 1 of the file 'Mainline/Widget/Widget.java' from the - 'Widget 1.0' branch to the working directory setup for user 'administrator'. - Writable local files are not overwritten, even if they are out of date. - - - <sscmget - serverconnect="localhost:4900" - serverlogin="administrator:" - quiet="true" - file="Widget.java" - branch="Widget 1.0" - repository="Mainline/Widget" - overwrite="false" - writable="true" - version="1" - /> - - - - - Get all files and repositories labeled with 'Release 1.0.0' (even those - removed from Surround) from repository 'Mainline/Widget' recursively - from the 'Widget 1.0' branch to the '${build}/src' directory. Writable - local files are overwritten with the server copy. - - - <sscmget - serverconnect="localhost:4900" - serverlogin="administrator:" - quiet="true" - file="/" - branch="Widget 1.0" - repository="Mainline/Widget" - recursive="true" - label="Release 1.0.1" - destdir="${build}/src" - overwrite="true" - /> - - + + Gets files from a Surround SCM + repository. + + + You can get a single file, multiple files, or a repository. A read-only + copy of the file is created in the specified directory. + + + + Get all files and repositories from repository 'Mainline/Widget' + recursively from the 'Widget 1.0' branch to the working directory + setup for user 'administrator'. This call forces the file retrieval + from the server even if the local file is current and overwrites any + local files that are writable with the server copy. + + + <sscmget + serverconnect="localhost:4900" + serverlogin="administrator:" + file="/" + branch="Widget 1.0" + repository="Mainline/Widget" + recursive="true" + force="true" + overwrite="true" + /> + + + + + Get version 1 of the file 'Mainline/Widget/Widget.java' from the + 'Widget 1.0' branch to the working directory setup for user 'administrator'. + Writable local files are not overwritten, even if they are out of date. + + + <sscmget + serverconnect="localhost:4900" + serverlogin="administrator:" + quiet="true" + file="Widget.java" + branch="Widget 1.0" + repository="Mainline/Widget" + overwrite="false" + writable="true" + version="1" + /> + + + + + Get all files and repositories labeled with 'Release 1.0.0' (even those + removed from Surround) from repository 'Mainline/Widget' recursively + from the 'Widget 1.0' branch to the '${build}/src' directory. Writable + local files are overwritten with the server copy. + + + <sscmget + serverconnect="localhost:4900" + serverlogin="administrator:" + quiet="true" + file="/" + branch="Widget 1.0" + repository="Mainline/Widget" + recursive="true" + label="Release 1.0.1" + destdir="${build}/src" + overwrite="true" + /> + + @@ -11261,16 +11334,16 @@ The to write the task-specific arguments to. - - Surround SCM branch name. The default is pulled from the local - working directory. - + + Surround SCM branch name. The default is pulled from the local + working directory. + - - Surround SCM repository path. The default is pulled from the local - working directory. - + + Surround SCM repository path. The default is pulled from the local + working directory. + @@ -11290,22 +11363,22 @@ - - Make local file editable or writable. The default is - . - + + Make local file editable or writable. The default is + . + - - Force file retrieval from server regardless of the local copy status. - The default is . - + + Force file retrieval from server regardless of the local copy status. + The default is . + - - Label to search for when getting a file. If a file version is - specified, this parameter is ignored. - + + Label to search for when getting a file. If a file version is + specified, this parameter is ignored. + @@ -11315,35 +11388,35 @@ - - Include removed files when getting files by label or timestamp. - The default is . Ignored if a label or - timestamp is not specified. - + + Include removed files when getting files by label or timestamp. + The default is . Ignored if a label or + timestamp is not specified. + - - Do not list repository and local full path of files. The default is - . - + + Do not list repository and local full path of files. The default is + . + - - Recursively get files and sub-repositories. The default is - . - + + Recursively get files and sub-repositories. The default is + . + - - Specifies whether to overwrite local writable files. The default is - . - + + Specifies whether to overwrite local writable files. The default is + . + - - Specifies how to set the local file's date/time. Possible values are - current, modify or checkin. - + + Specifies how to set the local file's date/time. Possible values are + current, modify or checkin. + @@ -11352,74 +11425,74 @@ - - Creates file or repository labels for a Surround SCM - repository. - - - Labels provide a way to mark a specific version of a file or repository. - You can create labels for single files, multiple files, or all files in - a repository. When you create a label, a new entry is created in the history. - The file, and the version number, do not change. Existing 'Release 1.0.1' - labels on a file will be moved to the tip version of the file. - - - - Label all files under the 'Mainline/Widget' repository recursively in - the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. - - - <sscmlabel - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="Widget 1.0" - repository="Mainline/Widget" - file="readme.txt" - recursive="true" - label="Release 1.0.1" - overwritelabel="false" - comment="This labels the final build for the release of Widget 1.0.1." - /> - - - - - Label all files under the 'Mainline/Widget' repository recursively in - the 'Widget 1.0' branch with 'Release 1.0.1' and no comments. - - - <sscmlabel - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="Widget 1.0" - repository="Mainline/Widget" - file="readme.txt" - recursive="true" - label="Release 1.0.1" - /> - - - - - Label version 4 of the file 'Mainline/Widget/Widget.java' in the - 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. An - existing 'Release 1.0.1' label on this file to be moved to version 4 - of the file. - - - <sscmlabel - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="Widget 1.0" - repository="Mainline/Widget" - file="readme.txt" - label="Release 1.0.1" - overwritelabel=" true" - comment=" This labels the final build for the release of Widget 1.0.1." - version=" 4" - /> - - + + Creates file or repository labels for a Surround SCM + repository. + + + Labels provide a way to mark a specific version of a file or repository. + You can create labels for single files, multiple files, or all files in + a repository. When you create a label, a new entry is created in the history. + The file, and the version number, do not change. Existing 'Release 1.0.1' + labels on a file will be moved to the tip version of the file. + + + + Label all files under the 'Mainline/Widget' repository recursively in + the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. + + + <sscmlabel + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="Widget 1.0" + repository="Mainline/Widget" + file="readme.txt" + recursive="true" + label="Release 1.0.1" + overwritelabel="false" + comment="This labels the final build for the release of Widget 1.0.1." + /> + + + + + Label all files under the 'Mainline/Widget' repository recursively in + the 'Widget 1.0' branch with 'Release 1.0.1' and no comments. + + + <sscmlabel + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="Widget 1.0" + repository="Mainline/Widget" + file="readme.txt" + recursive="true" + label="Release 1.0.1" + /> + + + + + Label version 4 of the file 'Mainline/Widget/Widget.java' in the + 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. An + existing 'Release 1.0.1' label on this file to be moved to version 4 + of the file. + + + <sscmlabel + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="Widget 1.0" + repository="Mainline/Widget" + file="readme.txt" + label="Release 1.0.1" + overwritelabel=" true" + comment=" This labels the final build for the release of Widget 1.0.1." + version=" 4" + /> + + @@ -11429,16 +11502,16 @@ The to write the task-specific arguments to. - - Surround SCM branch name. The default is pulled from the local - working directory. - + + Surround SCM branch name. The default is pulled from the local + working directory. + - - Surround SCM repository path. The default is pulled from the local - working directory. - + + Surround SCM repository path. The default is pulled from the local + working directory. + @@ -11448,24 +11521,24 @@ - - The new label to create. - + + The new label to create. + - - Recursively label all files. The default is . - + + Recursively label all files. The default is . + - - Overwrite the existing label. The default is . - + + Overwrite the existing label. The default is . + - - Comment for the label. - + + Comment for the label. + @@ -11474,25 +11547,25 @@ - - Unlocks frozen branches for a Surround SCM - repository. - - - - Unfreeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the - server at localhost, port 4900 with username 'administrator' and a - blank password. - - - <sscmunfreeze - serverconnect="localhost:4900" - serverlogin="administrator:" - mainline="Mainline" - branch="Widget 1.0" - /> - - + + Unlocks frozen branches for a Surround SCM + repository. + + + + Unfreeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the + server at localhost, port 4900 with username 'administrator' and a + blank password. + + + <sscmunfreeze + serverconnect="localhost:4900" + serverlogin="administrator:" + mainline="Mainline" + branch="Widget 1.0" + /> + + @@ -11502,47 +11575,47 @@ The to write the task-specific arguments to. - - Surround SCM branch name. - + + Surround SCM branch name. + - - Surround SCM mainline branch name. The default is pulled from the local working directory. - + + Surround SCM mainline branch name. The default is pulled from the local working directory. + - - A base class for creating tasks for executing CVS client commands on a - CVS repository. - + + A base class for creating tasks for executing CVS client commands on a + CVS repository. + - - An environment variable that holds path information about where - svn is located. - + + An environment variable that holds path information about where + svn is located. + - - The prefix used for command arguments. - + + The prefix used for command arguments. + - - The name of the svn executable. - + + The name of the svn executable. + - - Environment variable that holds the executable name that is used for - ssh communication. - + + Environment variable that holds the executable name that is used for + ssh communication. + - - Name of the password file that is used to cash password settings. - + + Name of the password file that is used to cash password settings. + @@ -11551,19 +11624,19 @@ - - Build up the command line arguments, determine which executable is being - used and find the path to that executable and set the working - directory. - - The process to prepare. + + Build up the command line arguments, determine which executable is being + used and find the path to that executable and set the working + directory. + + The process to prepare. - - Append the command line options or commen names for the options - to the generic options collection. This is then piped to the - command line as a switch. - + + Append the command line options or commen names for the options + to the generic options collection. This is then piped to the + command line as a switch. + @@ -11578,420 +11651,422 @@ - - Set default values for non-requiered parameters. - + + Set default values for non-requiered parameters. + - - The name of the executable. - + + The name of the executable. + - - The name of the password file. - + + The name of the password file. + - - Name of the home environment variable. - + + Name of the home environment variable. + - - The name of the ssh/ rsh environment variable. - + + The name of the ssh/ rsh environment variable. + - - The full path of the svn executable. - + + The full path of the svn executable. + - - - TODO: Add more documentation when I understand all svn root possibilities/ - protocols. - The svn root is usually in the form of a URL from which the server, protocol - and path information can be derived. Although the path to the repository - can also be determined from this the information is more implicit - than explicit. For example a subversion root URL of: - http://svn.collab.net/repos/svn/trunk/doc/book/tools - would have the following components: - protocol: http/ web_dav - username: anonymous - servername: svn.collab.net - repository: /repos/svn - server path: /trunk/doc/book/tools - - In addition the revision path or branch can also be determined as - subversion stores this information as a seperate physical directory. - In this example: - - revision: trunk - - + + + TODO: Add more documentation when I understand all svn root possibilities/ + protocols. + The svn root is usually in the form of a URL from which the server, protocol + and path information can be derived. Although the path to the repository + can also be determined from this the information is more implicit + than explicit. For example a subversion root URL of: + + http://svn.collab.net/repos/svn/trunk/doc/book/tools + + would have the following components: + protocol: http/ web_dav + username: anonymous + servername: svn.collab.net + repository: /repos/svn + server path: /trunk/doc/book/tools + + In addition the revision path or branch can also be determined as + subversion stores this information as a seperate physical directory. + In this example: + + revision: trunk + + - - The user performing the checkout. - + + The user performing the checkout. + - - The pasword to use to login to svn. - + + The pasword to use to login to svn. + - - Indicates whether the task should be interactive or not. This is - set to by default, and I don't see a reason - to expose this to the NAnt task. - + + Indicates whether the task should be interactive or not. This is + set to by default, and I don't see a reason + to expose this to the NAnt task. + - - The executable to use for ssh communication. - + + The executable to use for ssh communication. + - - The command to execute. - + + The command to execute. + - - Specifies whether to print as little information as possible. - The default is . - + + Specifies whether to print as little information as possible. + The default is . + - - Determines if the root is used for the command based on - the command name. Returns true if the root - is used, otherwise returns false. - + + Determines if the root is used for the command based on + the command name. Returns true if the root + is used, otherwise returns false. + - - Executes the svn checkout command. - - - Checkout Gentle.NET. - - - ]]> - - + + Executes the svn checkout command. + + + Checkout Gentle.NET. + + + ]]> + + - - Initialize the task, and set the default parameters. - + + Initialize the task, and set the default parameters. + - - Gets the svn command to execute. - - - The svn command to execute. The default value is "checkout". - + + Gets the svn command to execute. + + + The svn command to execute. The default value is "checkout". + - - if the command should be executed recursively. - The default is . - + + if the command should be executed recursively. + The default is . + - - The revision to checkout. If no revision is specified then subversion - will return the HEAD. - - - A revision argument can be one of: - NUMBER revision number - "{" DATE "}" revision at start of the date - "HEAD" latest in repository - "BASE" base rev of item's working copy - "COMMITTED" last commit at or before BASE - "PREV" revision just before COMMITTED - + + The revision to checkout. If no revision is specified then subversion + will return the HEAD. + + + A revision argument can be one of: + NUMBER revision number + "{" DATE "}" revision at start of the date + "HEAD" latest in repository + "BASE" base rev of item's working copy + "COMMITTED" last commit at or before BASE + "PREV" revision just before COMMITTED + - - if the authentiction token should be cached - locally. - + + if the authentiction token should be cached + locally. + - - The location of the configuration directory. - + + The location of the configuration directory. + - - Executes the svn command specified by the command attribute. - - - Checkout Gentle.NET. - - - ]]> - - + + Executes the svn command specified by the command attribute. + + + Checkout Gentle.NET. + + + ]]> + + - - The svn command to execute. - + + The svn command to execute. + - - Executes the svn update specified by the command attribute. - - - Update Gentle.NET. - - - ]]> - - + + Executes the svn update specified by the command attribute. + + + Update Gentle.NET. + + + ]]> + + - - Gets the svn command to execute. - - - The svn command to execute. The default value is "update". - + + Gets the svn command to execute. + + + The svn command to execute. The default value is "update". + - - Allows an IIS application pool to be controlled. - - - - Starts the "StsAdminAppPool" application pool on server - "SV-ARD-WEB". - - - - ]]> - - - - - Stops and restarts the "DefaultAppPool" application pool - on server "SV-ARD-WEB". - - - - ]]> - - + + Allows an IIS application pool to be controlled. + + + + Starts the "StsAdminAppPool" application pool on server + "SV-ARD-WEB". + + + + ]]> + + + + + Stops and restarts the "DefaultAppPool" application pool + on server "SV-ARD-WEB". + + + + ]]> + + - - The name of the server on which to perform the action. The default - is the local computer. - + + The name of the server on which to perform the action. The default + is the local computer. + - - The name of the application pool on which to perform the action. - + + The name of the application pool on which to perform the action. + - - The action that should be performed on the application pool. - + + The action that should be performed on the application pool. + - - Defines the actions that can be performed on an application pool. - + + Defines the actions that can be performed on an application pool. + - - Starts the application pool. - + + Starts the application pool. + - - Stops the application pool. - + + Stops the application pool. + - - Stops and restarts the application pool. - + + Stops and restarts the application pool. + - - Recycles an application pool. - + + Recycles an application pool. + - - Creates or modifies a virtual directory of a web site hosted on Internet - Information Server. - - - - If the virtual directory does not exist it is created, and if it already - exists it is modified. Only the IIS-properties specified will be set. If set - by other means (e.g. the Management Console), the unspecified properties retain their current value, - otherwise they are inherited from the parent. - - - For a list of optional parameters see IIsWebVirtualDir. - - - More information on metabase parameters is available here. - - - - - Create a virtual directory named Temp pointing to c:\temp - on the local machine. - - - - ]]> - - - - - Create a virtual directory named Temp pointing to c:\temp - on machine Staging. - - - - ]]> - - - - - Configure the home directory of for http://svc.here.dev/ to point to - D:\Develop\Here and require authentication - - - - ]]> - - - - - Create a virtual directory named WebServices/Dev pointing to - c:\MyProject\dev on the web site running on port 81 of - machine MyHost. - - - - ]]> - - Note that if WebServices is neither an existing virtual directory nor an - existing physical subdirectory of the web root, your IIS Management Console - will get confused. Even though http://MyHost:81/WebServices/Dev/theService.asmx - may be a perfectly working webservice, the Management Console will not show it. - + + Creates or modifies a virtual directory of a web site hosted on Internet + Information Server. + + + + If the virtual directory does not exist it is created, and if it already + exists it is modified. Only the IIS-properties specified will be set. If set + by other means (e.g. the Management Console), the unspecified properties retain their current value, + otherwise they are inherited from the parent. + + + For a list of optional parameters see IIsWebVirtualDir. + + + More information on metabase parameters is available here. + + + + + Create a virtual directory named Temp pointing to c:\temp + on the local machine. + + + + ]]> + + + + + Create a virtual directory named Temp pointing to c:\temp + on machine Staging. + + + + ]]> + + + + + Configure the home directory of for http://svc.here.dev/ to point to + D:\Develop\Here and require authentication + + + + ]]> + + + + + Create a virtual directory named WebServices/Dev pointing to + c:\MyProject\dev on the web site running on port 81 of + machine MyHost. + + + + ]]> + + Note that if WebServices is neither an existing virtual directory nor an + existing physical subdirectory of the web root, your IIS Management Console + will get confused. Even though http://MyHost:81/WebServices/Dev/theService.asmx + may be a perfectly working webservice, the Management Console will not show it. + - - Base class for all IIS-related task. - - - Basically this class hold the logic to determine the IIS version as well - as the IIS server/port determination/checking logic. - + + Base class for all IIS-related task. + + + Basically this class hold the logic to determine the IIS version as well + as the IIS server/port determination/checking logic. + - - Name of the IIS virtual directory. - + + Name of the IIS virtual directory. + - - The IIS server, which can be specified using the format [host]:[port]. - The default is localhost:80. - - - - This allows for targeting a specific virtual site on a physical box. - - + + The IIS server, which can be specified using the format [host]:[port]. + The default is localhost:80. + + + + This allows for targeting a specific virtual site on a physical box. + + - - The website on the IIS server. - - - - This allows for targeting a specific virtual site on a physical box. - - + + The website on the IIS server. + + + + This allows for targeting a specific virtual site on a physical box. + + - - Gets the version of IIS corresponding with the current OS. - - - The version of IIS corresponding with the current OS. - + + Gets the version of IIS corresponding with the current OS. + + + The version of IIS corresponding with the current OS. + - - Defines the IIS versions supported by the IIS tasks. - + + Defines the IIS versions supported by the IIS tasks. + - - The user-friendly name of the package or application. - + + The user-friendly name of the package or application. + - - The file system path. - + + The file system path. + - - Indicates whether the file or the contents of the folder may be - executed, regardless of file type. The default is . - + + Indicates whether the file or the contents of the folder may be + executed, regardless of file type. The default is . + @@ -12016,46 +12091,46 @@ - - A value of true indicates that remote requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests. - + + A value of true indicates that remote requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests. + - - indicates that remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests. - + + indicates that remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests. + - - Indicates whether the file or the contents of the folder may be - read. The default is . - + + Indicates whether the file or the contents of the folder may be + read. The default is . + - - Indicates whether users are allowed to access source code if either - Read or Write permissions are set. The default is . - + + Indicates whether users are allowed to access source code if either + Read or Write permissions are set. The default is . + - - Indicates whether the file or the contents of the folder may be - executed if they are script files or static content. The default - is . - + + Indicates whether the file or the contents of the folder may be + executed if they are script files or static content. The default + is . + - - Indicates whether file access requires SSL file permission processing, - with or without a client certificate. The default is . - + + Indicates whether file access requires SSL file permission processing, + with or without a client certificate. The default is . + - - Indicates whether file access requires SSL file permission processing - with a minimum key size of 128 bits, with or without a client - certificate. The default is . - + + Indicates whether file access requires SSL file permission processing + with a minimum key size of 128 bits, with or without a client + certificate. The default is . + @@ -12067,10 +12142,10 @@ - - Indicates whether SSL file access processing requests a certificate - from the client. The default is . - + + Indicates whether SSL file access processing requests a certificate + from the client. The default is . + @@ -12082,19 +12157,19 @@ - - Indicates whether users are allowed to upload files and their - associated properties to the enabled directory on your server or - to change content in a Write-enabled file. The default is - . - + + Indicates whether users are allowed to upload files and their + associated properties to the enabled directory on your server or + to change content in a Write-enabled file. The default is + . + - - Indicates whether IIS should handle the user password for anonymous - users attempting to access resources. The default is - . - + + Indicates whether IIS should handle the user password for anonymous + users attempting to access resources. The default is + . + @@ -12103,38 +12178,38 @@ - - Specifies whether ASP client-side debugging is enabled. The default - is . - + + Specifies whether ASP client-side debugging is enabled. The default + is . + - - Specifies whether ASP debugging is enabled on the server. The default - is . - + + Specifies whether ASP debugging is enabled on the server. The default + is . + - - Specifies the application pool where the application is routed - (IIS 6.0 or higher). - + + Specifies the application pool where the application is routed + (IIS 6.0 or higher). + - - Enables session state persistence for the ASP application. The - default is . - + + Enables session state persistence for the ASP application. The + default is . + - - Specifies whether output from an ASP application will be buffered. - If , all output from the application is - collected in the buffer before the buffer is flushed to the client. - With buffering on, the ASP application has to completely process the - ASP script before the client receives any output. The default is - . - + + Specifies whether output from an ASP application will be buffered. + If , all output from the application is + collected in the buffer before the buffer is flushed to the client. + With buffering on, the ASP application has to completely process the + ASP script before the client receives any output. The default is + . + @@ -12150,21 +12225,21 @@ - - Controls the behavior of ASP when a new request is to be rejected - due to a full request queue. If , an .htm file - with a similar name as the requested .asp file, will be sent instead - of the .asp file. The naming convention for the .htm file is the - name of the .asp file with _asp appended. The default is - . - + + Controls the behavior of ASP when a new request is to be rejected + due to a full request queue. If , an .htm file + with a similar name as the requested .asp file, will be sent instead + of the .asp file. The naming convention for the .htm file is the + name of the .asp file with _asp appended. The default is + . + - - Specifies whether HTTP 1.1 chunked transfer encoding is enabled for - the World Wide Web Publishing Service (WWW service). The default is - . - + + Specifies whether HTTP 1.1 chunked transfer encoding is enabled for + the World Wide Web Publishing Service (WWW service). The default is + . + @@ -12203,37 +12278,37 @@ - - Specifies whether an ASP page allows paths relative to the current - directory. The default is . - + + Specifies whether an ASP page allows paths relative to the current + directory. The default is . + - - Specifies whether type libraries are cached on the server. The - default is . - - - - The World Wide Web Publishing Service (WWW service) setting for - this property is applicable to all in-process and pooled out-of-process - application nodes, at all levels. - - - Metabase settings at the Web server level or lower are ignored - for in-process and pooled out-of-process applications. However, - settings at the Web server level or lower are used if that node - is an isolated out-of-process application. - - + + Specifies whether type libraries are cached on the server. The + default is . + + + + The World Wide Web Publishing Service (WWW service) setting for + this property is applicable to all in-process and pooled out-of-process + application nodes, at all levels. + + + Metabase settings at the Web server level or lower are ignored + for in-process and pooled out-of-process applications. However, + settings at the Web server level or lower are used if that node + is an isolated out-of-process application. + + - - Specifies whether ASP pages trap exceptions thrown by components. - If set to , the Microsoft Script Debugger tool - does not catch exceptions sent by the component that you are debugging. - The default is . - + + Specifies whether ASP pages trap exceptions thrown by components. + If set to , the Microsoft Script Debugger tool + does not catch exceptions sent by the component that you are debugging. + The default is . + @@ -12273,235 +12348,235 @@ - - Specifies whether the Web server writes debugging specifics - (file name, error, line number, description) to the client browser, - in addition to logging them to the Windows Event Log. The default - is . - + + Specifies whether the Web server writes debugging specifics + (file name, error, line number, description) to the client browser, + in addition to logging them to the Windows Event Log. The default + is . + - - Indicates whether IIS thread gating is enabled (only applies to IIS 4 and 5). - The default is . - - - IIS performs thread gating to dynamically control the number of - concurrently executing threads, in response to varying load conditions. - + + Indicates whether IIS thread gating is enabled (only applies to IIS 4 and 5). + The default is . + + + IIS performs thread gating to dynamically control the number of + concurrently executing threads, in response to varying load conditions. + - - Specifies whether IIS checks the threading model of any components - that your application creates. The default is . - + + Specifies whether IIS checks the threading model of any components + that your application creates. The default is . + - - Specifies Anonymous authentication as one of the possible authentication - schemes returned to clients as being available. The default is - . - + + Specifies Anonymous authentication as one of the possible authentication + schemes returned to clients as being available. The default is + . + - - Specifies Basic authentication as one of the possible authentication - schemes returned to clients as being available. The default is - . - + + Specifies Basic authentication as one of the possible authentication + schemes returned to clients as being available. The default is + . + - - Specifies Integrated Windows authentication as one of the possible - authentication schemes returned to clients as being available. The - default is . - + + Specifies Integrated Windows authentication as one of the possible + authentication schemes returned to clients as being available. The + default is . + - - Specifies that authentication persists only for a single request on - a connection. IIS resets the authentication at the end of each request, - and forces re-authentication on the next request of the session. - - - [IIS 6.0] When the AuthPersistSingleRequest flag is set to true when - using NTLM authentication, IIS 6.0 automatically reauthenticates every - request, even those on the same connection. - + + Specifies that authentication persists only for a single request on + a connection. IIS resets the authentication at the end of each request, + and forces re-authentication on the next request of the session. + + + [IIS 6.0] When the AuthPersistSingleRequest flag is set to true when + using NTLM authentication, IIS 6.0 automatically reauthenticates every + request, even those on the same connection. + - - Specifies authentication will persist only across single requests - on a connection if the connection is by proxy. Applies to IIS 5.0 - and 5.1. The default is - - - IIS will reset the authentication at the end of the request if the current authenticated - request is by proxy and it is not the special case where IIS is running MSPROXY - + + Specifies authentication will persist only across single requests + on a connection if the connection is by proxy. Applies to IIS 5.0 + and 5.1. The default is + + + IIS will reset the authentication at the end of the request if the current authenticated + request is by proxy and it is not the special case where IIS is running MSPROXY + - - Specifies whether authentication is valid for a single request - if by proxy. IIS will reset the authentication at the end of the - request and force re-authentication on the next request if the - current authenticated request is by proxy of any type. Applies to - IIS 5.0 and 5.1. The default is . - + + Specifies whether authentication is valid for a single request + if by proxy. IIS will reset the authentication at the end of the + request and force re-authentication on the next request if the + current authenticated request is by proxy of any type. Applies to + IIS 5.0 and 5.1. The default is . + - - Specifies whether the HTTP 1.1 directive to prevent caching of content - should be sent to clients. The default is . - + + Specifies whether the HTTP 1.1 directive to prevent caching of content + should be sent to clients. The default is . + - - Indicates whether ISAPI extensions are cached in memory after first - use. The default is . - + + Indicates whether ISAPI extensions are cached in memory after first + use. The default is . + - - Specifies whether the installed content indexer should index content - under this directory tree. The default is . - + + Specifies whether the installed content indexer should index content + under this directory tree. The default is . + - - Specifies whether process accounting and throttling should be performed - for ISAPI extensions and ASP applications. The default is - . - + + Specifies whether process accounting and throttling should be performed + for ISAPI extensions and ASP applications. The default is + . + - - Indicates whether IIS should perform process accounting for CGI - applications. The default is . - + + Indicates whether IIS should perform process accounting for CGI + applications. The default is . + - - Indicates whether a CGI application runs in its own console. The - default is . - + + Indicates whether a CGI application runs in its own console. The + default is . + - - Specifies whether a CGI process is created in the system context - or in the context of the requesting user. The default is - . - + + Specifies whether a CGI process is created in the system context + or in the context of the requesting user. The default is + . + - - Specifies whether date information is displayed when browsing - directories. The default is . - + + Specifies whether date information is displayed when browsing + directories. The default is . + - - Specifies whether file extensions are displayed when browsing - directories. The default is . - + + Specifies whether file extensions are displayed when browsing + directories. The default is . + - - Specifies whether date information is displayed in extended format - when displaying directories. The default is . - + + Specifies whether date information is displayed in extended format + when displaying directories. The default is . + - - Specifies whether file size information is displayed when displaying - directories. The default is . - + + Specifies whether file size information is displayed when displaying + directories. The default is . + - - Specifies whether file creation time is displayed when browsing - directories. The default is . - + + Specifies whether file creation time is displayed when browsing + directories. The default is . + - - Specifies whether client requests are written to the IIS log files. - The default is . - + + Specifies whether client requests are written to the IIS log files. + The default is . + - - When set to true, the default document (specified by the DefaultDoc property) for a directory is loaded when the directory is browsed. - + + When set to true, the default document (specified by the DefaultDoc property) for a directory is loaded when the directory is browsed. + - - Specifies whether directory browsing is enabled. The default is - . - + + Specifies whether directory browsing is enabled. The default is + . + - - Enables or disables custom footers. The default is - . - + + Enables or disables custom footers. The default is + . + - - Enables or disables reverse Domain Name Server (DNS) lookups for - the World Wide Web Publishing Service (WWW service). The default is - . - + + Enables or disables reverse Domain Name Server (DNS) lookups for + the World Wide Web Publishing Service (WWW service). The default is + . + - - Specifies whether server-side include (SSI) #exec directives are - disabled under this path. The default is . - + + Specifies whether server-side include (SSI) #exec directives are + disabled under this path. The default is . + - - - + + + - - - + + + - - One or more file names of default documents that will be returned to - the client if no file name is included in the client's request. - + + One or more file names of default documents that will be returned to + the client if no file name is included in the client's request. + - - Specifies the user name for Universal Naming Convention (UNC) virtual - roots. - + + Specifies the user name for Universal Naming Convention (UNC) virtual + roots. + - - Specifies the encrypted password used to gain access to UNC - (Universal Naming Convention) virtual roots. - + + Specifies the encrypted password used to gain access to UNC + (Universal Naming Convention) virtual roots. + - - The different ways a (virtual) directory in IIS can be configured - as an application. - + + The different ways a (virtual) directory in IIS can be configured + as an application. + - - Virtual directory is not configured as an application. - + + Virtual directory is not configured as an application. + - - Virtual directory is configured as an in-process application. - + + Virtual directory is configured as an in-process application. + @@ -12510,126 +12585,126 @@ - - Virtual directory is configured as an out-of-process application. - + + Virtual directory is configured as an out-of-process application. + - - Deletes a virtual directory from a given web site hosted on Internet - Information Server. - - - - Delete a virtual directory named Temp from the web site running - on port 80 of the local machine. If more than one web site is - running on port 80, take the web site bound to the hostname - localhost if existent or bound to no hostname otherwise. - - - - ]]> - - - - - Delete a virtual directory named Temp from the website running - on port 81 of machine MyHost. - - - - ]]> - - + + Deletes a virtual directory from a given web site hosted on Internet + Information Server. + + + + Delete a virtual directory named Temp from the web site running + on port 80 of the local machine. If more than one web site is + running on port 80, take the web site bound to the hostname + localhost if existent or bound to no hostname otherwise. + + + + ]]> + + + + + Delete a virtual directory named Temp from the website running + on port 81 of machine MyHost. + + + + ]]> + + - - Lists the configuration settings of a specified virtual directory in a - web site hosted on Internet Information Server. - - - - List the settings of a virtual directory named Temp. - - - - ]]> - - + + Lists the configuration settings of a specified virtual directory in a + web site hosted on Internet Information Server. + + + + List the settings of a virtual directory named Temp. + + + + ]]> + + - - Base NAnt task for working with ADSI. This task contains only the path of the ADSI - object that you want to work with. - + + Base NAnt task for working with ADSI. This task contains only the path of the ADSI + object that you want to work with. + - - The ADSI path of the location where we want to work with. - + + The ADSI path of the location where we want to work with. + - - Used to get the value of a property from an ADSI object. - + + Used to get the value of a property from an ADSI object. + - - Sets the specified property - + + Sets the specified property + - - The name of the property to get. - + + The name of the property to get. + - - The name of the property to store the value in. - + + The name of the property to store the value in. + - - Sets a property on an ADSI object. - - - This task uses a heuristic to determine the type of the property in ADSI. The following cases are notable: - - If the property does not exist on the item, it is inserted as a string. - If the property already exists, this method will attempt to preserve - the type of the property. The types this method knows about are String, - Boolean, and Int32. - If the property exists and is an array, the value is added to - the array, but only if it is not already present. - - - - - - ]]> - - - - - - - - - ]]> - - + + Sets a property on an ADSI object. + + + This task uses a heuristic to determine the type of the property in ADSI. The following cases are notable: + + If the property does not exist on the item, it is inserted as a string. + If the property already exists, this method will attempt to preserve + the type of the property. The types this method knows about are String, + Boolean, and Int32. + If the property exists and is an array, the value is added to + the array, but only if it is not already present. + + + + + + ]]> + + + + + + + + + ]]> + + - - Sets the specified property - + + Sets the specified property + @@ -12659,1099 +12734,1039 @@ - - The name of the property to set. - + + The name of the property to set. + - - The new value of the property. - + + The new value of the property. + - - Formats source code in a given directory to a specified code format. - - - - Most examples inline have been produced by Tal Davidson and team and - are part of the astyle documentation. They have been included in - the task documentation as an easy reference. - - NOTE: This task relies on the astyle.exe file being in your path variable. - Please download the astyle.exe from http://astyle.sourceforge.net. - - - - - - - - - ]]> - - + + Formats source code in a given directory to a specified code format. + + + + Most examples inline have been produced by Tal Davidson and team and + are part of the astyle documentation. They have been included in + the task documentation as an easy reference. + + NOTE: This task relies on the astyle.exe file being in your path variable. + Please download the astyle.exe from http://astyle.sourceforge.net. + + + + + + + + + ]]> + + - - The default style seems to be the closest to C# standards. - + + The default style seems to be the closest to C# standards. + - - Build up the command line arguments, determine which executable is - being used and find the path to that executable and set the working - directory. - - The process to prepare. + + Build up the command line arguments, determine which executable is + being used and find the path to that executable and set the working + directory. + + The process to prepare. - - Adds a new command option if none exists. If one does exist then - the use switch is toggled on or of. - - The common name of the option. - The option value or command line switch of the option. - if the option should be appended to the commandline, otherwise . + + Adds a new command option if none exists. If one does exist then + the use switch is toggled on or of. + + The common name of the option. + The option value or command line switch of the option. + if the option should be appended to the commandline, otherwise . - - Append the command line options or commen names for the options - to the generic options collection. This is then piped to the - command line as a switch. - + + Append the command line options or commen names for the options + to the generic options collection. This is then piped to the + command line as a switch. + - - Append the files specified in the fileset to the command line argument. - + + Append the files specified in the fileset to the command line argument. + - - A collection of command line option switches. - + + A collection of command line option switches. + - - Used to select the files to copy. - + + Used to select the files to copy. + - - The command-line arguments for the program. - + + The command-line arguments for the program. + - - Indicate the preset style to use. - - ansi - - namespace foospace - { - int Foo() - { - if (isBar) - { - bar(); - return 1; - } - else - return 0; - } - } - - - kr ( Kernighan&Ritchie ) - - namespace foospace { - int Foo() { - if (isBar) { - bar(); - return 1; - } else - return 0; - } - } - - - linux - - namespace foospace - { - int Foo() - { - if (isBar) { - bar(); - return 1; - } else - return 0; - } - } - - - gnu - - namespace foospace - { - int Foo() - { - if (isBar) - { - bar(); - return 1; - } - else - return 0; - } - } - - - java - - class foospace { - int Foo() { - if (isBar) { - bar(); - return 1; - } else - return 0; - } - } - - - NAnt - - namespace foospace { - class foo() { - #region Protected Static Fields - private int Foo() { - if (isBar) { - bar(); - return 1; - } else { - return 0; - } - } - #endregion - } - - - - + + Indicate the preset style to use. + + ansi + + namespace foospace + { + int Foo() + { + if (isBar) + { + bar(); + return 1; + } + else + return 0; + } + } + + + kr ( Kernighan&Ritchie ) + + namespace foospace { + int Foo() { + if (isBar) { + bar(); + return 1; + } else + return 0; + } + } + + + linux + + namespace foospace + { + int Foo() + { + if (isBar) { + bar(); + return 1; + } else + return 0; + } + } + + + gnu + + namespace foospace + { + int Foo() + { + if (isBar) + { + bar(); + return 1; + } + else + return 0; + } + } + + + java + + class foospace { + int Foo() { + if (isBar) { + bar(); + return 1; + } else + return 0; + } + } + + + NAnt + + namespace foospace { + class foo() { + #region Protected Static Fields + private int Foo() { + if (isBar) { + bar(); + return 1; + } else { + return 0; + } + } + #endregion + } + + + + - - Astyle leaves the original files around, renamed with a different - suffix. Setting this to true - will remove these files. - + + Astyle leaves the original files around, renamed with a different + suffix. Setting this to true + will remove these files. + - - The suffix to append to original files, defaults to .orig - if not specified. - + + The suffix to append to original files, defaults to .orig + if not specified. + - - Indicate the maximum number of spaces to indent relative to a - previous line. - + + Indicate the maximum number of spaces to indent relative to a + previous line. + - - Indicate that tabs should be used to indent sources. The number - specified indicates the maximum number of spaces the tab character - will represent. - + + Indicate that tabs should be used to indent sources. The number + specified indicates the maximum number of spaces the tab character + will represent. + - - Indent using tab characters. Treat each tab as # spaces. Uses tabs as - indents in areas '--indent=tab' prefers to use spaces, such as - inside multi-line statements. - + + Indent using tab characters. Treat each tab as # spaces. Uses tabs as + indents in areas '--indent=tab' prefers to use spaces, such as + inside multi-line statements. + - - to convert tabs to spaces. - + + to convert tabs to spaces. + - - if class statements should be indented. - - - The default: - class Foo - { - public: - Foo(); - virtual ~Foo(); - }; - becomes: - class Foo - { - public: - Foo(); - virtual ~Foo(); - }; - - - + + if class statements should be indented. + + + The default: + + class Foo + { + public: + Foo(); + virtual ~Foo(); + }; + + becomes: + + class Foo + { + public: + Foo(); + virtual ~Foo(); + }; + + + - - if switch statements should be indented. - - - The default: - switch (foo) - { - case 1: - a += 2; - break; - default: - a += 2; - break; - } - becomes: - switch (foo) - { - case 1: - a += 2; - break; - default: - a += 2; - break; - } - - - + + if switch statements should be indented. + + + The default: + + switch (foo) + { + case 1: + a += 2; + break; + + default: + a += 2; + break; + } + + becomes: + + switch (foo) + { + case 1: + a += 2; + break; + + default: + a += 2; + break; + } + + + - - if case statements should be indented. - - - The default: - switch (foo) - { - case 1: - { - a += 2; - break; - } - default: - { - a += 2; - break; - } - } - becomes: - switch (foo) - { - case 1: - { - a += 2; - break; - } - default: - { - a += 2; - break; - } - } - - - + + if case statements should be indented. + + + The default: + + switch (foo) + { + case 1: + { + a += 2; + break; + } + + default: + { + a += 2; + break; + } + } + + becomes: + + switch (foo) + { + case 1: + { + a += 2; + break; + } + + default: + { + a += 2; + break; + } + } + + + - - true if bracket statements should be indented. - - - The default: - if (isFoo) - { - bar(); - } - else - { - anotherBar(); - } - becomes: - if (isFoo) - { - bar(); - } - else - { - anotherBar(); - } - - - + + true if bracket statements should be indented. + + + The default: + + if (isFoo) + { + bar(); + } + else + { + anotherBar(); + } + + becomes: + + if (isFoo) + { + bar(); + } + else + { + anotherBar(); + } + + + - - if block statements should be indented. - The default: - if (isFoo) - { - bar(); - } - else - anotherBar(); - becomes: - if (isFoo) - { - bar(); - } - else - anotherBar(); - + + if block statements should be indented. + The default: + + if (isFoo) + { + bar(); + } + else + anotherBar(); + + becomes: + + if (isFoo) + { + bar(); + } + else + anotherBar(); + - - if namespace statements should be indented. - - The default: - namespace foospace - { - class Foo - { - public: - Foo(); - virtual ~Foo(); - }; - } - becomes: - namespace foospace - { - class Foo - { - public: - Foo(); - virtual ~Foo(); - }; - } - - + + if namespace statements should be indented. + + + The default: + + namespace foospace + { + class Foo + { + public: + Foo(); + virtual ~Foo(); + }; + } + + becomes: + + namespace foospace + { + class Foo + { + public: + Foo(); + virtual ~Foo(); + }; + } + + + - - if label statements should be indented. - - - The default: - int foospace() - { - while (isFoo) - { - ... - goto error; - error: - ... - } - } - becomes: - int foospace() - { - while (isFoo) - { - ... - goto error; - error: - ... - } - } - - + + if label statements should be indented. + + + The default: + + int foospace() + { + while (isFoo) + { + ... + goto error; + + error: + ... + } + } + + becomes: + + int foospace() + { + while (isFoo) + { + ... + goto error; + + error: + ... + } + } + + + - - Indicate the maximum number of spaces to indent relative to a - previous line. - + + Indicate the maximum number of spaces to indent relative to a + previous line. + - - Indicate the maximum number of spaces to indent relative to a - previous line. - + + Indicate the maximum number of spaces to indent relative to a + previous line. + - - if empty lines should be filled with the - whitespace of the previous line. - + + if empty lines should be filled with the + whitespace of the previous line. + - - if brackets should be put on a new line. - - if (isFoo) - { - bar(); - } - else - { - anotherBar(); - } - - - + + if brackets should be put on a new line. + + + if (isFoo) + { + bar(); + } + else + { + anotherBar(); + } + + + - - if brackets should be attached. - - - if (isFoo){ - bar(); - } else { - anotherBar(); - } - - - + + if brackets should be attached. + + + if (isFoo){ + bar(); + } else { + anotherBar(); + } + + + - - if brackets should be put on a new line and - indented. - - namespace foospace - { - int Foo() - { - if (isBar) { - bar(); - return 1; - } else - return 0; - } - } - - + + if brackets should be put on a new line and + indented. + + + namespace foospace + { + int Foo() + { + if (isBar) { + bar(); + return 1; + } else + return 0; + } + } + + + - - if the line after a bracket (i.e. an else - statement after the closing if) should be placed on the next line. - - - if (isFoo){ - bar(); - }else { - anotherBar(); - } - becomes: - if (isFoo) { - bar(); - } - else { - anotherBar(); - } - - - + + if the line after a bracket (i.e. an else + statement after the closing if) should be placed on the next line. + + + if (isFoo){ + bar(); + }else { + anotherBar(); + } + + becomes: + + if (isFoo) { + bar(); + } + else { + anotherBar(); + } + + + - - to break block statements with an empty line. - - isFoo = true; - if (isFoo) { - bar(); - } else { - anotherBar(); - } - isBar = false; - becomes: - isFoo = true; - if (isFoo) { - bar(); - } else { - anotherBar(); - } - isBar = false; - - + + to break block statements with an empty line. + + + isFoo = true; + if (isFoo) { + bar(); + } else { + anotherBar(); + } + isBar = false; + + becomes: + + isFoo = true; + + if (isFoo) { + bar(); + } else { + anotherBar(); + } + + isBar = false; + + + - - to break all block statements, even on - nested ifs with an empty line. - - isFoo = true; - if (isFoo) { - bar(); - } else { - anotherBar(); - } - isBar = false; - becomes: - isFoo = true; - if (isFoo) { - bar(); - } else { - anotherBar(); - } - isBar = false; - - + + to break all block statements, even on + nested ifs with an empty line. + + + isFoo = true; + if (isFoo) { + bar(); + } else { + anotherBar(); + } + isBar = false; + + becomes: + + isFoo = true; + + if (isFoo) { + bar(); + + } else { + anotherBar(); + } + + isBar = false; + + + - - to put the if component of an else if on a - new line. - - if (isFoo) { - bar(); - } else if (isBar()){ - anotherBar(); - } - becomes: - if (isFoo) { - bar(); - } else - if (isBar()){ - anotherBar(); - } - - - + + to put the if component of an else if on a + new line. + + + if (isFoo) { + bar(); + } else if (isBar()){ + anotherBar(); + } + + becomes: + + if (isFoo) { + bar(); + } else + if (isBar()){ + anotherBar(); + } + + + + - - to pad operators with a space. - - - if (isFoo) - a = bar((b-c)*a,*d--); - becomes: - if (isFoo) - a = bar((b - c) * a, *d--); - - + + to pad operators with a space. + + + if (isFoo) + a = bar((b-c)*a,*d--); + + becomes: + + if (isFoo) + a = bar((b - c) * a, *d--); + + + - - to pad parenthesis with a space. - - if (isFoo) - a = bar((b-c)*a,*d--); - becomes: - if ( isFoo ) - a = bar( ( b-c )*a, *d-- ); - - + + to pad parenthesis with a space. + + + if (isFoo) + a = bar((b-c)*a,*d--); + + becomes: + + if ( isFoo ) + a = bar( ( b-c )*a, *d-- ); + + + - - to pad operators and parenthesis. - - - if (isFoo) - a = bar((b-c)*a,*d--); - becomes: - if ( isFoo ) - a = bar( ( b - c ) * a, *d-- ); - - + + to pad operators and parenthesis. + + + if (isFoo) + a = bar((b-c)*a,*d--); + + becomes: + + if ( isFoo ) + a = bar( ( b - c ) * a, *d-- ); + + + - - to keep complex statements on the same line. - - - if (isFoo) - { - isFoo = false; cout << isFoo << endl; - } - remains as is. - if (isFoo) DoBar(); - remains as is. - - + + to keep complex statements on the same line. + + + if (isFoo) + { + isFoo = false; cout << isFoo << endl; + } + + remains as is. + + if (isFoo) DoBar(); + + remains as is. + + + - - to keep single line statements on the same line. - - if (isFoo) - { isFoo = false; cout << isFoo << endl; } - remains as is. - - + + to keep single line statements on the same line. + + + if (isFoo) + { isFoo = false; cout << isFoo << endl; } + + remains as is. + + + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Changes the current working directory. - - - - Changes the current working directory to the "subdir" - directory, relative to the project base directory. - - - - ]]> - - + + Changes the current working directory. + + + + Changes the current working directory to the "subdir" + directory, relative to the project base directory. + + + + ]]> + + - - Changes the current directory. - + + Changes the current directory. + - - The path to which the current working directory should be set. - + + The path to which the current working directory should be set. + - - Calculates checksums for a set of files. - Loosely based on Ant's Checksum task. - - - This task takes a set of input files in a fileset - and calculates a checksum for each one of them. - You can specify the algorithm to use when calculating - the checksum value (MD5 or SHA1, for example). - The calculated value is saved to a file with the same - name as the input file and an added extension either - based on the algorithm name (e.g. .MD5), or whatever - is specified through the fileext attribute. - - - - - - - - - ]]> - - + + Calculates checksums for a set of files. + Loosely based on Ant's Checksum task. + + + This task takes a set of input files in a fileset + and calculates a checksum for each one of them. + You can specify the algorithm to use when calculating + the checksum value (MD5 or SHA1, for example). + The calculated value is saved to a file with the same + name as the input file and an added extension either + based on the algorithm name (e.g. .MD5), or whatever + is specified through the fileext attribute. + + + + + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Writes a checksum to a destination file - - - + + Writes a checksum to a destination file + + + - - Name of Algorithm to use when calculating - the checksum. Can be MD5 or SHA1. - + + Name of Algorithm to use when calculating + the checksum. Can be MD5 or SHA1. + - - The generated checksum file's name will be the - original filename with "." and fileext - added to it. Defaults to the - algorithm name being used - + + The generated checksum file's name will be the + original filename with "." and fileext + added to it. Defaults to the + algorithm name being used + - - Set of files to use as input - + + Set of files to use as input + - + - - Executes an alternate set of task or type definition depending on - conditions that are individually set on each group. - + Generates statistics from source code. - - The selects one among a number of possible - alternatives. It consists of a sequence of <when> elements - followed by an optional <otherwise> element. - - - Each <when> element has a single attribute, test, which - specifies an expression. The content of the <when> and - <otherwise> elements is a set of nested tasks. - - - The content of the first, and only the first, <when> - element whose test is is executed. If no - <when> element is , the - content of the <otherwise> element is executed. - If no <when> element is , and no - <otherwise> element is present, nothing is done. - + Scans files in a fileset counting lines. - Execute alternate set of tasks depending on the configuration being - built. + Generate statistics for a set of C# and VB.NET sources, applying + different labels for both. - - - ... - - - - ... - - - Build configuration '${build.config}' is not supported! - - + + + + + + + + + + + + + + ]]> - Define a sources patternset holding an alternate set of patterns - depending on the configuration being built. + Generate statistics for all C# sources and only output a summary to + the log. - - - - - - - - - - - - - Build configuration '${build.config}' is not supported! - - + + + + + + + + + ]]> - - - One or more alternative sets of tasks to execute. - - The set of tasks to add. - - + - The set of tasks to execute if none of the - elements are . + Set of line counters to enable. - - - Gets a value indicating whether a fallback element is defined. - - - if a fallback element is defined; otherwise, - . - - - - - Groups a set of tasks to execute when a condition is met. - - - - - Executes embedded tasks in the order in which they are defined. - - - - - Creates and executes the embedded (child XML nodes) elements. - - - + - Gets a value indicating whether the element is performing additional - processing using the that was use to - initialize the element. + An identifier to be able to track which build last updated the + code stats file. - - , as a is - responsable for creating tasks from the nested build elements. - - - - - Used to test arbitrary boolean expression. - - - - - Generates statistics from source code. - - - Scans files in a fileset counting lines. - - - - Generate statistics for a set of C# and VB.NET sources, applying - different labels for both. - - - - - - - - - - - - - - - - - ]]> - - - - - Generate statistics for all C# sources and only output a summary to - the log. - - - - - - - - - - - - ]]> - - - - - - Set of line counters to enable. - - - - - An identifier to be able to track which build last updated the - code stats file. - - - Specifies whether the results should be appended to the output file. - The default is . - + + Specifies whether the results should be appended to the output file. + The default is . + - - If you only want to show summary stats for the whole fileset - + + If you only want to show summary stats for the whole fileset + - - The name of the file to save the output to (in XML). - + + The name of the file to save the output to (in XML). + - - Register COM servers or type libraries. - - - - COM register task will try and register any type of COM related file - that needs registering. - - Executable files (.exe) will be registered as exe servers, type - libaries (.tlb) registered with RegisterTypeLib and for all other - filetypes it will attempt to register them as dll servers. - - - - Register a single dll server. - - - ]]> - - - - Register a single exe server - - - ]]> - - - - Register a set of COM files at once. - - - - - - - - - - ]]> - - + + Register COM servers or type libraries. + + + + COM register task will try and register any type of COM related file + that needs registering. + + Executable files (.exe) will be registered as exe servers, type + libaries (.tlb) registered with RegisterTypeLib and for all other + filetypes it will attempt to register them as dll servers. + + + + Register a single dll server. + + + ]]> + + + + Register a single exe server + + + ]]> + + + + Register a set of COM files at once. + + + + + + + + + + ]]> + + - - Register an inproc COM server, usually a .dll or .ocx - - + + Register an inproc COM server, usually a .dll or .ocx + + - - Register a COM type library - - + + Register a COM type library + + - - Register exe servers. - - + + Register exe servers. + + - - The name of the file to register. This is provided as an alternate - to using the task's fileset. - + + The name of the file to register. This is provided as an alternate + to using the task's fileset. + - Unregistering this time. ( /u paramater )Default is "false". + Unregistering this time. ( /u paramater )Default is "false". - - The set of files to register. - + + The set of files to register. + - - Helper class to synamically build an assembly with the correct - P/Invoke signature - + + Helper class to synamically build an assembly with the correct + P/Invoke signature + - - Register a given dll. - - - - + + Register a given dll. + + + + - - A task that concatenates a set of files. - Loosely based on Ant's Concat task. - - - - This task takes a set of input files in a fileset - and concatenates them into a single file. You can - either replace the output file, or append to it - by using the append attribute. - - - The order the files are concatenated in is not - especified. - - - - - - - - - - ]]> - - + + A task that concatenates a set of files. + Loosely based on Ant's Concat task. + + + + This task takes a set of input files in a fileset + and concatenates them into a single file. You can + either replace the output file, or append to it + by using the append attribute. + + + The order the files are concatenated in is not + especified. + + + + + + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Opens the destination file according - to the specified flags - - + + Opens the destination file according + to the specified flags + + - - Appends all specified files - - File to write to + + Appends all specified files + + File to write to - - Name of the destination file. - + + Name of the destination file. + - - Specifies whether to append to the destination file. - The default is . - + + Specifies whether to append to the destination file. + The default is . + - - Set of files to use as input. - + + Set of files to use as input. + @@ -13762,17 +13777,17 @@ The depends task never forces the execution of any target that has already been executed. It works just like the depends attribute of a . - - Executes the specified task. - + + Executes the specified task. + - - A space or comma separated dependency list of targets. - - - Expressions get evaluated when the task is executed. - + + A space or comma separated dependency list of targets. + + + Expressions get evaluated when the task is executed. + @@ -13796,84 +13811,84 @@ - - Discover the details for the specified web service. - + + Discover the details for the specified web service. + - The URL or Path to discover. + The URL or Path to discover. - Suppresses the banner. + Suppresses the banner. - Do not save the discovered documents to the local disk. + Do not save the discovered documents to the local disk. - The output directory to save discovered documents in. + The output directory to save discovered documents in. - Username of an account with credentials to access a - server that requires authentication. + Username of an account with credentials to access a + server that requires authentication. - Password of an account with credentials to access a - server that requires authentication. + Password of an account with credentials to access a + server that requires authentication. - Domain of an account with credentials to access a - server that requires authentication. + Domain of an account with credentials to access a + server that requires authentication. - URL of a proxy server to use for HTTP requests. - The default is to use the system proxy setting. + URL of a proxy server to use for HTTP requests. + The default is to use the system proxy setting. - Username of an account with credentials to access a - proxy that requires authentication. + Username of an account with credentials to access a + proxy that requires authentication. - Password of an account with credentials to access a - proxy that requires authentication. + Password of an account with credentials to access a + proxy that requires authentication. - Domain of an account with credentials to access a - proxy that requires authentication. + Domain of an account with credentials to access a + proxy that requires authentication. - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Analyzes managed code assemblies and reports information about the - assemblies, such as possible design, localization, performance, and - security improvements. - - - - this task relies on fxcopcmd.exe being in your PATH environment variable. - You can download the latest FxCop from . - - - - - - - - - - - - - ]]> - - + + Analyzes managed code assemblies and reports information about the + assemblies, such as possible design, localization, performance, and + security improvements. + + + + this task relies on fxcopcmd.exe being in your PATH environment variable. + You can download the latest FxCop from . + + + + + + + + + + + + + ]]> + + @@ -13881,187 +13896,187 @@ - - Performs logic before the external process is started - - Process. + + Performs logic before the external process is started + + Process. - - Executes the task. - + + Executes the task. + - - Builds the arguments to pass to the exe. - + + Builds the arguments to pass to the exe. + - - Applies the XSL transformation specified in /outXsl to the analysis report before saving the file. - + + Applies the XSL transformation specified in /outXsl to the analysis report before saving the file. + - - Directs analysis output to the console or to the Output window in Visual Studio .NET. By default, the XSL file FxCopConsoleOutput.xsl is applied to the output before it is displayed. - + + Directs analysis output to the console or to the Output window in Visual Studio .NET. By default, the XSL file FxCopConsoleOutput.xsl is applied to the output before it is displayed. + - - Specifies the XSL or XSLT file that contains a transformation to be applied to the analysis output before it is displayed in the console. - + + Specifies the XSL or XSLT file that contains a transformation to be applied to the analysis output before it is displayed in the console. + - - Specifies additional directories to search for assembly dependencies. FxCopCmd always searches the target assembly directory and the current working directory. - + + Specifies additional directories to search for assembly dependencies. FxCopCmd always searches the target assembly directory and the current working directory. + - - Specifies the target assembly to analyze. - + + Specifies the target assembly to analyze. + - - Specifies the name of an analysis report or project file to import. Any messages in the imported file that are marked as excluded are not included in the analysis results. - + + Specifies the name of an analysis report or project file to import. Any messages in the imported file that are marked as excluded are not included in the analysis results. + - - Specifies the file name for the analysis report. - + + Specifies the file name for the analysis report. + - - Specifies the XSL or XSLT file that is referenced by the xml-stylesheet processing instruction in the analysis report. - + + Specifies the XSL or XSLT file that is referenced by the xml-stylesheet processing instruction in the analysis report. + - - Specifies the location of the version of Mscorlib.dll that was used when building the target assemblies if this version is not installed on the computer running FxCopCmd. - + + Specifies the location of the version of Mscorlib.dll that was used when building the target assemblies if this version is not installed on the computer running FxCopCmd. + - - Specifies the filename of FxCop project file. - + + Specifies the filename of FxCop project file. + - - Specifies the filename(s) of FxCop project file(s). - + + Specifies the filename(s) of FxCop project file(s). + - - Includes a summary report with the informational messages returned by FxCopCmd. - + + Includes a summary report with the informational messages returned by FxCopCmd. + - - Comma-separated list of type names to analyze. This option disables analysis of assemblies, namespaces, and resources; only the specified types and their members are included in the analysis. - Use the wildcard character '*' at the end of the name to select multiple types. - + + Comma-separated list of type names to analyze. This option disables analysis of assemblies, namespaces, and resources; only the specified types and their members are included in the analysis. + Use the wildcard character '*' at the end of the name to select multiple types. + - - Saves the results of the analysis in the project file. - + + Saves the results of the analysis in the project file. + - - Determines if the task should fail when analysis errors occur - + + Determines if the task should fail when analysis errors occur + - - The directory in which the command will be executed. - - - The directory in which the command will be executed. The default - is the project's base directory. - - - - It will be evaluated relative to the project's - base directory if it is relative. - - + + The directory in which the command will be executed. + + + The directory in which the command will be executed. The default + is the project's base directory. + + + + It will be evaluated relative to the project's + base directory if it is relative. + + - - Gets the program arguments. - + + Gets the program arguments. + - - Installs assemblies into the Global Assembly Cache (GAC) by using the - gacutil SDK tool. - - - - Assemblies can be installed to the GAC with or without reference counting. - The full details of reference counting can be found in the SDK - documentation. - - - - Installs Shared.dll into the GAC. - - - - - - - ]]> - - - - - Installs Shared.dll and MyWeb.dll into the GAC. - - - - - - - - - ]]> - - - - - Installs Shared.dll and MyWeb.dll into the GAC and - specifies reference information. - - - - - - - - - - ]]> - - + + Installs assemblies into the Global Assembly Cache (GAC) by using the + gacutil SDK tool. + + + + Assemblies can be installed to the GAC with or without reference counting. + The full details of reference counting can be found in the SDK + documentation. + + + + Installs Shared.dll into the GAC. + + + + + + + ]]> + + + + + Installs Shared.dll and MyWeb.dll into the GAC. + + + + + + + + + ]]> + + + + + Installs Shared.dll and MyWeb.dll into the GAC and + specifies reference information. + + + + + + + + + + ]]> + + - - Base class functionality for the GAC tasks. - - - Concrete GAC tasks extend this class in order to obtain common functionality. - + + Base class functionality for the GAC tasks. + + + Concrete GAC tasks extend this class in order to obtain common functionality. + - - Stores the details of the assembly currently being operated against. This could be a name or - path, depending on the concrete task. - + + Stores the details of the assembly currently being operated against. This could be a name or + path, depending on the concrete task. + @@ -14074,101 +14089,101 @@ - - Constructs and initialises an instance of GacTask. - + + Constructs and initialises an instance of GacTask. + - - Starts the process that is wrapped by this GAC task. - - - Provided only to seal the implementation of StartProcess(). - - The process that was started. + + Starts the process that is wrapped by this GAC task. + + + Provided only to seal the implementation of StartProcess(). + + The process that was started. - - Validates the task's configuration. - + + Validates the task's configuration. + - - Executes the task. - - - Provided only to seal the implementation of ExecuteTask(). - + + Executes the task. + + + Provided only to seal the implementation of ExecuteTask(). + - - Appends any task-specific program arguments. - - The StringBuilder on which to append program arguments. - - Subclasses must override this method to return the arguments with which to run the GAC task. - + + Appends any task-specific program arguments. + + The StringBuilder on which to append program arguments. + + Subclasses must override this method to return the arguments with which to run the GAC task. + - - Invoked prior to invoking ExecuteTask() on the base class. - - - Allows, for example, subclasses to output useful information to the log. - + + Invoked prior to invoking ExecuteTask() on the base class. + + + Allows, for example, subclasses to output useful information to the log. + - - Gets or sets a value indicating whether the GAC operation will be forced. - - - The exact meaning of this property is dependent on the subclass. As such, subclasses should override this - property to provide a valid description. - + + Gets or sets a value indicating whether the GAC operation will be forced. + + + The exact meaning of this property is dependent on the subclass. As such, subclasses should override this + property to provide a valid description. + - - Specifies reference details to use when working with the GAC. - + + Specifies reference details to use when working with the GAC. + - - Concrete GAC tasks must override this property to return an array of assembly names or paths - upon which to operate. - + + Concrete GAC tasks must override this property to return an array of assembly names or paths + upon which to operate. + - - Gets the executable name for the gacutil command-line tool. - + + Gets the executable name for the gacutil command-line tool. + - - Specifies whether a reference was specified for the GAC task. - + + Specifies whether a reference was specified for the GAC task. + - - Gets the current assembly being operated against. - + + Gets the current assembly being operated against. + - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + - - Gets the program arguments with which to run the gacutil process. - + + Gets the program arguments with which to run the gacutil process. + @@ -14176,37 +14191,37 @@ - - Constructs and initialises an instance of the GacInstallTask. - + + Constructs and initialises an instance of the GacInstallTask. + - - Appends any install-specific arguments. - - The StringBuilder to append arguments to. + + Appends any install-specific arguments. + + The StringBuilder to append arguments to. - - Outputs log information. - + + Outputs log information. + - - Specifies the assemblies to install. - + + Specifies the assemblies to install. + - - Gets the assembly list to install. - + + Gets the assembly list to install. + - - If , the specified assemblies will be forcibly - installed. Any existing duplicate assemblies in the GAC will be - overwritten. The default is . - + + If , the specified assemblies will be forcibly + installed. Any existing duplicate assemblies in the GAC will be + overwritten. The default is . + @@ -14268,9 +14283,9 @@ - - The name of a file that contains an assembly manifest. - + + The name of a file that contains an assembly manifest. + @@ -14279,22 +14294,22 @@ - - Fileset are used to define multiple assemblies. - + + Fileset are used to define multiple assemblies. + - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + @@ -14303,21 +14318,21 @@ - - Installs an assembly into the global assembly cache. - + + Installs an assembly into the global assembly cache. + - - Installs an assembly into the global assembly cache. If an assembly - with the same name already exists in the global assembly cache, it is - overwritten. - + + Installs an assembly into the global assembly cache. If an assembly + with the same name already exists in the global assembly cache, it is + overwritten. + - - Uninstalls an assembly from the global assembly cache. - + + Uninstalls an assembly from the global assembly cache. + @@ -14425,253 +14440,253 @@ - - Constructs an instance of the GacUninstallTask. - + + Constructs an instance of the GacUninstallTask. + - - Appends any install-specific arguments. - - + + Appends any install-specific arguments. + + - - Outputs log information. - + + Outputs log information. + - - If , specifies that the assemblies should be - uninstalled from the native image cache. The default is . - + + If , specifies that the assemblies should be + uninstalled from the native image cache. The default is . + - - Specifies the assemblies to uninstall. - + + Specifies the assemblies to uninstall. + - - Gets the assembly list to uninstall. - + + Gets the assembly list to uninstall. + - - If , the specified assemblies will be forcibly - removed from the GAC. All references to the specified assemblies will - be removed from the GAC prior to removing the assemblies themselves. - The default is . - - - You cannot use this option to remove an assembly that was installed using Microsoft Windows Installer. - + + If , the specified assemblies will be forcibly + removed from the GAC. All references to the specified assemblies will + be removed from the GAC prior to removing the assemblies themselves. + The default is . + + + You cannot use this option to remove an assembly that was installed using Microsoft Windows Installer. + - - Compiles a Microsoft HTML Help 2.0 Project. - - - Compile a help file. - - - ]]> - - + + Compiles a Microsoft HTML Help 2.0 Project. + + + Compile a help file. + + + ]]> + + - - The name of the contents (.HxC) file. - + + The name of the contents (.HxC) file. + - - ANSI/DBCS log filename. - + + ANSI/DBCS log filename. + - - Unicode log filename. - + + Unicode log filename. + - - Root directory containing Help 2.0 project files. - + + Root directory containing Help 2.0 project files. + - - Output (.HxS) filename. - + + Output (.HxS) filename. + - - Generate no informational messages. - + + Generate no informational messages. + - - Generate no error messages. - + + Generate no error messages. + - - Generate no warning messages. - + + Generate no warning messages. + - - File to be decompiled. - + + File to be decompiled. + - - Directory to place decompiled files into. - + + Directory to place decompiled files into. + - - Arguments of program to execute - + + Arguments of program to execute + - - Registers a Microsoft HTML Help 2.0 Collection. - - - Register a help namespace. - - - ]]> - - + + Registers a Microsoft HTML Help 2.0 Collection. + + + Register a help namespace. + + + ]]> + + - Help collection namespace. + Help collection namespace. - Title identifier. + Title identifier. - Collection (.HxC) filename. + Collection (.HxC) filename. - Description of the namespace. + Description of the namespace. - Help (.HxS) filename. + Help (.HxS) filename. - Index (.HxI) filename. + Index (.HxI) filename. - Combined full-text search (.HxQ) filename. + Combined full-text search (.HxQ) filename. - Combined attribute index (.HxR) filename. + Combined attribute index (.HxR) filename. - Language ID. + Language ID. - Alias. + Alias. - Filename of a file containing HxReg commands. + Filename of a file containing HxReg commands. - Unregister a namespace, title, or alias. + Unregister a namespace, title, or alias. - - Arguments of program to execute - + + Arguments of program to execute + - - Reads String values in INI files. - - Reads the value for AutoRefresh in the MS Transaction Server section - of the VendorMISMO2.ini ini file. Stores the value in the "myvar" property. - - - - ]]> - - The file contents look like this: - - [MS Transaction Server] - Executable="VendorMISMO2.dll" - AutoRefresh=1 - - + + Reads String values in INI files. + + Reads the value for AutoRefresh in the MS Transaction Server section + of the VendorMISMO2.ini ini file. Stores the value in the "myvar" property. + + + + ]]> + + The file contents look like this: + + [MS Transaction Server] + Executable="VendorMISMO2.dll" + AutoRefresh=1 + + - - INI File to Write To. - + + INI File to Write To. + - - Key to set the value for. - + + Key to set the value for. + - - value to set. - + + value to set. + - - Section in the INI file. - + + Section in the INI file. + - - property where we store the return value. - + + property where we store the return value. + - - Sets String values in INI files. - - - Set the value for Executable in the VendorMISMO2.ini ini file - - - ]]> - - The file contents look like this: - - [MS Transaction Server] - Executable="VendorMISMO2.dll" - AutoRefresh=1 - - + + Sets String values in INI files. + + + Set the value for Executable in the VendorMISMO2.ini ini file + + + ]]> + + The file contents look like this: + + [MS Transaction Server] + Executable="VendorMISMO2.dll" + AutoRefresh=1 + + - - INI File to Write To. - + + INI File to Write To. + - - Key to set the value for. - + + Key to set the value for. + - - value to set. - + + value to set. + - - Section in the INI file. - + + Section in the INI file. + @@ -14697,218 +14712,218 @@ - - The unique identifier of the process to stop. - + + The unique identifier of the process to stop. + - - The name of the computer on the network on which the process must - be stopped. The default is the local computer. - + + The name of the computer on the network on which the process must + be stopped. The default is the local computer. + - - The maximum amount of time to wait until the process is stopped, - expressed in milliseconds. The default is to wait indefinitely. - + + The maximum amount of time to wait until the process is stopped, + expressed in milliseconds. The default is to wait indefinitely. + - - Loads a file's contents as NAnt properties. - - - - Each line in a .properties file stores a single property, with the - name and value separated by an equals sign. - - - Empty lines and lines that start with a '#' character are skipped. - - - - - - ]]> - - + + Loads a file's contents as NAnt properties. + + + + Each line in a .properties file stores a single property, with the + name and value separated by an equals sign. + + + Empty lines and lines that start with a '#' character are skipped. + + + + + + ]]> + + - - The encoding to use when loading the file. The default is the - system's current ANSI code page. - + + The encoding to use when loading the file. The default is the + system's current ANSI code page. + - - The file to load properties from. - + + The file to load properties from. + - - Chain of filters used to alter the file's content as it is - copied. - + + Chain of filters used to alter the file's content as it is + copied. + - - A task that generates strongly typed WMI classes using - mgmtclassgen.exe. - - - The Management Strongly Typed Class Generator - enables you to quickly generate an early-bound - managed class for a specified Windows Management - Instrumentation (WMI) class. The generated - class simplifies the code you must write to access - an instance of the WMI class. - - - - - ]]> - - + + A task that generates strongly typed WMI classes using + mgmtclassgen.exe. + + + The Management Strongly Typed Class Generator + enables you to quickly generate an early-bound + managed class for a specified Windows Management + Instrumentation (WMI) class. The generated + class simplifies the code you must write to access + an instance of the WMI class. + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Specifies the name of the WMI class - to generate the strongly typed class - + + Specifies the name of the WMI class + to generate the strongly typed class + - - Specifies the language in which to generate - the class. Possible values are: CS, VB, JS - + + Specifies the language in which to generate + the class. Possible values are: CS, VB, JS + - - Specifies the machine to connect to. - + + Specifies the machine to connect to. + - - Specifies the path to the WMI namespace - that contains the class. - + + Specifies the path to the WMI namespace + that contains the class. + - - Namespace of the generated .NET class - + + Namespace of the generated .NET class + - - Path of the file to generate - + + Path of the file to generate + - - User name to use when connecting to - the specified machine - + + User name to use when connecting to + the specified machine + - - Password to use when connecting to the - specified machine - + + Password to use when connecting to the + specified machine + - - Filename of program to execute - + + Filename of program to execute + - - Arguments of program to execute - + + Arguments of program to execute + - - Builds the specified targets in the project file using MSBuild. - - - - If a project file is not specified, MSBuild searches the current - working directory for a file that has a file extension that ends in - "proj" and uses that file. - - + + Builds the specified targets in the project file using MSBuild. + + + + If a project file is not specified, MSBuild searches the current + working directory for a file that has a file extension that ends in + "proj" and uses that file. + + - - Starts the external process and captures its output. - + + Starts the external process and captures its output. + - - The project to build. - + + The project to build. + - - Set or override these project-level properties. - + + Set or override these project-level properties. + - - Build these targets in this project. Use a semicolon or a comma - comma to separate multiple targets. - + + Build these targets in this project. Use a semicolon or a comma + comma to separate multiple targets. + - - Do not auto-include the MSBuild.rsp file. - + + Do not auto-include the MSBuild.rsp file. + - - Specifies the amount of information to display in the MSBuild log. - + + Specifies the amount of information to display in the MSBuild log. + - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + @@ -14929,175 +14944,175 @@ - - Pre-translates native code for an assembly containing IL (Intermediary - Language bytecode) on the Windows platform. - - - - - ]]> - - + + Pre-translates native code for an assembly containing IL (Intermediary + Language bytecode) on the Windows platform. + + + + + ]]> + + - Assembly path or display name. + Assembly path or display name. - If existing images should be shown. + If existing images should be shown. - If existing images should be deleted. + If existing images should be deleted. - If an image should be generated which - can be used under a debugger. + If an image should be generated which + can be used under a debugger. - If an image should be generated which - can be used under a debugger in optimized - debugging mode. + If an image should be generated which + can be used under a debugger in optimized + debugging mode. - If an image should be generated which - can be used under a profiler. + If an image should be generated which + can be used under a profiler. - - Arguments of program to execute - + + Arguments of program to execute + - - A task that generates a summary HTML - from a set of NUnit xml report files. - Loosely based on Erik Hatcher JUnitReport for Ant. - - - This task can generate a combined HTML report out of a - set of NUnit result files generated using the - XML Result Formatter. - - By default, NUnitReport will generate the combined - report using the NUnitSummary.xsl file located at the - assembly's location, but you can specify a different - XSLT template to use with the xslfile - attribute. - - Also, all the properties defined in the current - project will be passed down to the XSLT file as - template parameters, so you can access properties - such as nant.project.name, nant.version, etc. - - - - - - - - - ]]> - + + A task that generates a summary HTML + from a set of NUnit xml report files. + Loosely based on Erik Hatcher JUnitReport for Ant. + + + This task can generate a combined HTML report out of a + set of NUnit result files generated using the + XML Result Formatter. + + By default, NUnitReport will generate the combined + report using the NUnitSummary.xsl file located at the + assembly's location, but you can specify a different + XSLT template to use with the xslfile + attribute. + + Also, all the properties defined in the current + project will be passed down to the XSLT file as + template parameters, so you can access properties + such as nant.project.name, nant.version, etc. + + + + + + + + + ]]> + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Initializes the XmlDocument instance - used to summarize the test results - - + + Initializes the XmlDocument instance + used to summarize the test results + + - - Builds an XsltArgumentList with all - the properties defined in the - current project as XSLT parameters. - - Property List + + Builds an XsltArgumentList with all + the properties defined in the + current project as XSLT parameters. + + Property List - - Loads the XSLT Transform - - - This method will load the file specified - through the the xslfile attribute, or - the default transformation included - as a managed resource. - - The Transformation to use + + Loads the XSLT Transform + + + This method will load the file specified + through the the xslfile attribute, or + the default transformation included + as a managed resource. + + The Transformation to use - - Name of Output HTML file. - + + Name of Output HTML file. + - - XSLT file used to generate the report. - + + XSLT file used to generate the report. + - - Set of XML files to use as input - + + Set of XML files to use as input + - - Custom XmlResolver used to load the - XSLT files out of this assembly resources. - + + Custom XmlResolver used to load the + XSLT files out of this assembly resources. + - - Loads the XSLT file - - - - - + + Loads the XSLT file + + + + + - - A task that records the build's output to a file. Loosely based on Ant's - Record - task. - - - This task allows you to record the build's output, or parts of it to a - file. You can start and stop recording at any place in the build process. - - - - - - ]]> - - + + A task that records the build's output to a file. Loosely based on Ant's + Record + task. + + + This task allows you to record the build's output, or parts of it to a + file. You can start and stop recording at any place in the build process. + + + + + + ]]> + + - - This is where the work is done. - + + This is where the work is done. + - - Name of destination file. - + + Name of destination file. + @@ -15127,68 +15142,68 @@ - - Registers an assembly for use from COM clients. - - - - Refer to the Regasm - documentation for more information on the regasm tool. - - - - - Register a single assembly. - - - - ]]> - - - - - Register an assembly while exporting a typelibrary. - - - - ]]> - - - - - Register a set of assemblies at once. - - - - - - - - - ]]> - - + + Registers an assembly for use from COM clients. + + + + Refer to the Regasm + documentation for more information on the regasm tool. + + + + + Register a single assembly. + + + + ]]> + + + + + Register an assembly while exporting a typelibrary. + + + + ]]> + + + + + Register a set of assemblies at once. + + + + + + + + + ]]> + + - - The name of the file to register. This is provided as an alternate - to using the task's fileset. - + + The name of the file to register. This is provided as an alternate + to using the task's fileset. + - - Registry file to export to instead of entering the types directly - into the registry. If a fileset is used then the entries are all - collated into this file. - + + Registry file to export to instead of entering the types directly + into the registry. If a fileset is used then the entries are all + collated into this file. + - - Set the code base registry setting. - + + Set the code base registry setting. + @@ -15198,31 +15213,31 @@ - - Only refer to already registered type libraries. - + + Only refer to already registered type libraries. + - - Export the assembly to the specified type library and register it. - This attribute is ignored when a fileset is specified. - + + Export the assembly to the specified type library and register it. + This attribute is ignored when a fileset is specified. + - - Unregister the assembly. The default is . - + + Unregister the assembly. The default is . + - - The set of files to register. - + + The set of files to register. + - - Indicates that class should be validated by an XML Schema. - - None. + + Indicates that class should be validated by an XML Schema. + + None. @@ -15255,151 +15270,151 @@ - - Specifies that no reference counting scheme will be used when performing the GAC task. - + + Specifies that no reference counting scheme will be used when performing the GAC task. + - - Specifies that registry-related reference counting will be used when performing the GAC task. - - - When the scheme type is set to UninstallKey, the related scheme ID should be set to the name of the application - set in the HKLM\Software\Microsoft\Windows\CurrentVersion registry key. - - + + Specifies that registry-related reference counting will be used when performing the GAC task. + + + When the scheme type is set to UninstallKey, the related scheme ID should be set to the name of the application + set in the HKLM\Software\Microsoft\Windows\CurrentVersion registry key. + + - - Specifies that file-based reference counting will be used when performing the GAC task. - - - When the scheme type is set to FilePath, the related scheme ID should be set to the full path to the executable - file that installs the assembly. - - + + Specifies that file-based reference counting will be used when performing the GAC task. + + + When the scheme type is set to FilePath, the related scheme ID should be set to the full path to the executable + file that installs the assembly. + + - - Specifies that custom information will be supplied to accommodate reference counting. - - - When the scheme type is set to Opaque, the related scheme ID can be set to any custom piece of information. - + + Specifies that custom information will be supplied to accommodate reference counting. + + + When the scheme type is set to Opaque, the related scheme ID can be set to any custom piece of information. + - - Copies a file to a remote server using scp. - - - Copies a file using scp to a remote server. - The Username Environment variable is used. - - - Copy a single file to a remote server and path. - - - ]]> - - + + Copies a file to a remote server using scp. + + + Copies a file using scp to a remote server. + The Username Environment variable is used. + + + Copy a single file to a remote server and path. + + + ]]> + + - - The program to execute. The default is "scp". - + + The program to execute. The default is "scp". + - - The command line arguments. - + + The command line arguments. + - - The file to transfer. - + + The file to transfer. + - - The server to send the file to. - + + The server to send the file to. + - - The path on the remote server. The default is "~". - + + The path on the remote server. The default is "~". + - - The username to connect as. The default is the value of the - USERNAME environment variable. - + + The username to connect as. The default is the value of the + USERNAME environment variable. + - - The path separator used by the program. The default is "/". - + + The path separator used by the program. The default is "/". + - - Gets the filename of the external program to start. - - - The filename of the external program. - + + Gets the filename of the external program to start. + + + The filename of the external program. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - The directory in which the command will be executed. - + + The directory in which the command will be executed. + - - Converts a Visual Studio.NET Solution to a NAnt build file or nmake file. - - - - Convert the solution MySolution.sln to the NAnt build file - MySolution.build and call the new build file. - - - - - - - - ]]> - - - - - Convert the solution MySolution.sln to the NAnt build file - MySolution.build. As the solution contains one or more web - projects, one or more maps needs to be specified. - - - - - - - - - ]]> - - + + Converts a Visual Studio.NET Solution to a NAnt build file or nmake file. + + + + Convert the solution MySolution.sln to the NAnt build file + MySolution.build and call the new build file. + + + + + + + + ]]> + + + + + Convert the solution MySolution.sln to the NAnt build file + MySolution.build. As the solution contains one or more web + projects, one or more maps needs to be specified. + + + + + + + + + ]]> + + @@ -15416,119 +15431,119 @@ - - The Visual Studio.NET solution file to convert. - + + The Visual Studio.NET solution file to convert. + - - The output file format - either nant or nmake. - + + The output file format - either nant or nmake. + - - The output file name. - + + The output file name. + - - Mappings from URI to directories. These are required for web projects. - + + Mappings from URI to directories. These are required for web projects. + - - Parameters to pass to SLiNgshoT. The parameter build.basedir is required. - + + Parameters to pass to SLiNgshoT. The parameter build.basedir is required. + - - A task to execute arbitrary SQL statements against a OLEDB data source. - - - You can specify a set of sql statements inside the - sql element, or execute them from a text file that contains them. You can also - choose to execute the statements in a single batch, or execute them one by one - (even inside a transaction, if you want to). - - - - Execute a set of statements inside a transaction. - - - - INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('My Job', 22, 45); - INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('Other Job', 09, 43); - SELECT * FROM jobs; - - ]]> - - - - - Execute a set of statements from a file and write all query results - to a file. - - - - ]]> - - - - - Execute a SQL script generated by SQL Server Enterprise Manager. - - - - ]]> - - + + A task to execute arbitrary SQL statements against a OLEDB data source. + + + You can specify a set of sql statements inside the + sql element, or execute them from a text file that contains them. You can also + choose to execute the statements in a single batch, or execute them one by one + (even inside a transaction, if you want to). + + + + Execute a set of statements inside a transaction. + + + + INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('My Job', 22, 45); + INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('Other Job', 09, 43); + SELECT * FROM jobs; + + ]]> + + + + + Execute a set of statements from a file and write all query results + to a file. + + + + ]]> + + + + + Execute a SQL script generated by SQL Server Enterprise Manager. + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done. - + + This is where the work is done. + - - Executes the SQL Statements one by one. - - + + Executes the SQL Statements one by one. + + - - Executes the SQL statements in a single batch. - - + + Executes the SQL statements in a single batch. + + @@ -15538,94 +15553,94 @@ to write output to. - - Connection string used to access database. - This should be an OleDB connection string. - + + Connection string used to access database. + This should be an OleDB connection string. + - - The encoding of the files containing SQL statements. The default is - the system's current ANSI code page. - + + The encoding of the files containing SQL statements. The default is + the system's current ANSI code page. + - - File where the sql statements are defined. - - - You cannot specify both a source and an inline set of statements. - + + File where the sql statements are defined. + + + You cannot specify both a source and an inline set of statements. + - - String that separates statements from one another. - + + String that separates statements from one another. + - - If true, the statements will be executed as a single batch. - If false, they will be executed one by one. Default is true. - + + If true, the statements will be executed as a single batch. + If false, they will be executed one by one. Default is true. + - - If true, the any nant-style properties on the sql will be - expanded before execution. Default is true. - + + If true, the any nant-style properties on the sql will be + expanded before execution. Default is true. + - - Command timeout to use when creating commands. - + + Command timeout to use when creating commands. + - - Kind of delimiter used. Allowed values are Normal or Line. - - - Delimiters can be of two kinds: Normal delimiters are - always specified inline, so they permit having two - different statements in the same line. Line delimiters, - however, need to be in a line by their own. - Default is Normal. - + + Kind of delimiter used. Allowed values are Normal or Line. + + + Delimiters can be of two kinds: Normal delimiters are + always specified inline, so they permit having two + different statements in the same line. Line delimiters, + however, need to be in a line by their own. + Default is Normal. + - - If set to true, results from the statements will be - output to the build log. - + + If set to true, results from the statements will be + output to the build log. + - - If set, the results from the statements will be output to the - specified file. - + + If set, the results from the statements will be output to the + specified file. + - - If set to , all statements will be executed - within a single transaction. The default is . - + + If set to , all statements will be executed + within a single transaction. The default is . + - - Whether output should be appended to or overwrite - an existing file. The default is . - + + Whether output should be appended to or overwrite + an existing file. The default is . + - - If set to , prints headers for result sets. - The default is . - + + If set to , prints headers for result sets. + The default is . + - - The character(s) to surround result columns with when printing, the - default is an empty string. - + + The character(s) to surround result columns with when printing, the + default is an empty string. + @@ -15637,426 +15652,231 @@ or if is not set. - - - Executes a set of tasks, and optionally catches a build exception to - allow recovery or rollback steps to be taken, or to define some steps - to be taken regardless if the tasks succeed or fail, or both. - + + Generates collection classes based on a given XML specification file. Code generation is in the specified language. - - The tasks defined in the <> block - will be executed in turn, as they normally would in a target. - - - If a <> block is defined, the - tasks in that block will be executed in turn only if one of the tasks - in the <> block fails. This - failure will then be suppressed by the <> - block. - - - The message associated with the failure can also be caught in a - property for use within the <> - block. The original contents of the property will be restored upon - exiting the <> block. - - - If a <> block is defined, the - tasks in that block will be executed after the tasks in both the - <> and <> - blocks have been executed, regardless of whether any task fails in - either block. - + See the CollectionGen tool page for more information. + + + + + + + + ]]> + + + + + + The actual generation work is done here. + + + + + + The language to generate collection classes for. Valid values are "CSharp" or "VB". + + + The name of the template file for collection generation. This is provided as an alternate to using the task's fileset. + + + + All files in this fileset will be run thru the collection generator. + + + + + Validates a set of XML files based on a set of XML Schemas (XSD). + - - - - - - - - - - - + + + + + + + + + ]]> + + + + + This is where the work is done. + + + + + The XML files that must be validated. + + + + + The XML Schemas (XSD) to use for validation. + + + + + Compiles Microsoft Visual Basic 6 programs. + + - The output of this example will be: + Uses the VB6.EXE executable included with the Visual Basic 6 + environment. - - In try - In catch - Finally done - - The failure in the <> block will - not cause the build to fail. + The compiler uses the settings and source files specified in the + project or group file. - + - - - - - - - - - - - - - - - ]]> - - - The output of this example will be: - - - In try - Caught failure: Just because... - Finally done - Build failed: Bad catch - - Like the above, the failure in the <> - block does not cause the build to fail. The failure in the - <> block does, however. - Note that the <> block is - executed even though the <> - block failed. + Build the project HelloWorld.vbp in the build directory. - - - - - - - - - - - - - - + ]]> - - The output of this example will be: - - - In try - Caught failure yet again - Build failed: Property 'failure' has not been set. - - - The in the <> - block failed because the "failure" property was not defined - after exiting the <> block. - Note that the failure in the <> - block has eclipsed the failure in the <> - block. - + + Check compiled property "vb6.compiled" + - - - - - - - - - - - - + + ]]> - - - A more concrete example, that will always clean up the generated - temporary file after it has been created. - + - - - The tasks in this block will be executed as a normal part of - the build script. - - - - - The tasks in this block will be executed if any task in the try - block fails. - - - - - The tasks in this block will always be executed, regardless of - what happens in the try and catch blocks. - - - Note that any failure in any of the tasks in this block will - prevent any subsequent tasks from executing. - - - - - Defines the name of the property to save the message describing - the failure that has been caught. - - - - The failure message is only available in the context of the catch - block. If you wish to preserve the message, you will need to save - it into another property. - - - Readonly properties cannot be overridden by this mechanism. - - - - - Generates collection classes based on a given XML specification file. Code generation is in the specified language. - - See the CollectionGen tool page for more information. - - - - - - - - - ]]> - - - - - - The actual generation work is done here. - - - - - - The language to generate collection classes for. Valid values are "CSharp" or "VB". - - - The name of the template file for collection generation. This is provided as an alternate to using the task's fileset. - - - - All files in this fileset will be run thru the collection generator. - - - - - Validates a set of XML files based on a set of XML Schemas (XSD). - - - - - - - - - - - - - ]]> - - - - - - This is where the work is done. - - - - - The XML files that must be validated. - - - - - The XML Schemas (XSD) to use for validation. - - - - - Compiles Microsoft Visual Basic 6 programs. - - - - Uses the VB6.EXE executable included with the Visual Basic 6 - environment. - - - The compiler uses the settings and source files specified in the - project or group file. - - - - - Build the project HelloWorld.vbp in the build directory. - - - - ]]> - - - - - Check compiled property "vb6.compiled" - - - - - ]]> - - - - - Compiles the Visual Basic project or project group. - + + Compiles the Visual Basic project or project group. + - - Parses a VB group file and extract the file names of the sub-projects - in the group. - - The file name of the group file. - - A string collection containing the list of sub-projects in the group. - + + Parses a VB group file and extract the file names of the sub-projects + in the group. + + The file name of the group file. + + A string collection containing the list of sub-projects in the group. + - - Determines if a VB project needs to be recompiled by comparing the timestamp of - the project's files and references to the timestamp of the last built version. - - The file name of the project file. - - if the project should be compiled; otherwise, - . - + + Determines if a VB project needs to be recompiled by comparing the timestamp of + the project's files and references to the timestamp of the last built version. + + The file name of the project file. + + if the project should be compiled; otherwise, + . + - - VB6 uses a special algorithm to search for the typelib file. It doesn't - rely on the API function QueryPathOfRegTypeLib, because VB could use a newer - version of the TLB. - - The algorithm used by VB is not perfect and has some flaws, which you could - get a newer version even if your requested version is installed. This is because - the algorithm iterates the registry beneath the Guid - entry by entry - from the - beginning and returns the first TLB version that is higher or equal to the - requested version. - - pseudo code: - 1. open the key HKEY_CLASSES_ROOT\TypeLib\{Guid} - 2. If the key exists: - 3. Foreach version under the key that has the requested culture entry: - 4. If the version higher or equal to the requested version: - 5. Get the TLB filename and returns it - - The guid of the tlb to look for - The major version number of the tlb - The minor version number of the tlb. If you parse minor from a string, treat the string as hex value. - The culture id - null if couldn't find a match, otherwise it returns the file. + + VB6 uses a special algorithm to search for the typelib file. It doesn't + rely on the API function QueryPathOfRegTypeLib, because VB could use a newer + version of the TLB. + + The algorithm used by VB is not perfect and has some flaws, which you could + get a newer version even if your requested version is installed. This is because + the algorithm iterates the registry beneath the Guid - entry by entry - from the + beginning and returns the first TLB version that is higher or equal to the + requested version. + + pseudo code: + 1. open the key HKEY_CLASSES_ROOT\TypeLib\{Guid} + 2. If the key exists: + 3. Foreach version under the key that has the requested culture entry: + 4. If the version higher or equal to the requested version: + 5. Get the TLB filename and returns it + + The guid of the tlb to look for + The major version number of the tlb + The minor version number of the tlb. If you parse minor from a string, treat the string as hex value. + The culture id + null if couldn't find a match, otherwise it returns the file. - - Parses a VB project file and extracts the source files, reference files, and - the name of the compiled file for the project. - - The filename of the project file. - - A fileset representing the source files of the project, which will - populated by the method. - - - A fileset representing the references of the project, which will - populated by the method. - - A string containing the output file name for the project. + + Parses a VB project file and extracts the source files, reference files, and + the name of the compiled file for the project. + + The filename of the project file. + + A fileset representing the source files of the project, which will + populated by the method. + + + A fileset representing the references of the project, which will + populated by the method. + + A string containing the output file name for the project. - - Output directory for the compilation target. - + + Output directory for the compilation target. + - - Visual Basic project or group file. - + + Visual Basic project or group file. + - - Determines whether project references are checked when deciding - whether the project needs to be recompiled. The default is - . - + + Determines whether project references are checked when deciding + whether the project needs to be recompiled. The default is + . + - - The file to which the Visual Basic compiler should log errors. - + + The file to which the Visual Basic compiler should log errors. + - - Tells Visual Basic which values to use for conditional compilation - constants. - + + Tells Visual Basic which values to use for conditional compilation + constants. + - - The name of a property in which will be set to - if compilation was needed and done without errors (default: "vb6.compiled") - This can be used for touching the compilation files if - vb6 autoincrement is set to true to avoid recompilation without any - other changes. - + + The name of a property in which will be set to + if compilation was needed and done without errors (default: "vb6.compiled") + This can be used for touching the compilation files if + vb6 autoincrement is set to true to avoid recompilation without any + other changes. + - - Gets the filename of the external program to start. - - - The filename of the external program. - + + Gets the filename of the external program to start. + + + The filename of the external program. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + @@ -16128,22 +15948,22 @@ The version to write to . - - Calculates the build number based on the number of months since the - start date. - - - The build number based on the number of months since the start date. - + + Calculates the build number based on the number of months since the + start date. + + + The build number based on the number of months since the start date. + - - Calculates the number of seconds since midnight. - start date. - - - The number of seconds since midnight. - + + Calculates the number of seconds since midnight. + start date. + + + The number of seconds since midnight. + @@ -16155,26 +15975,26 @@ - - Calculates the complete version. - - - The version. - + + Calculates the complete version. + + + The version. + - - Calculates the revision number of the version number based on RevisionType specified - - - The revision number. - + + Calculates the revision number of the version number based on RevisionType specified + + + The revision number. + - - The string to prefix the properties with. The default is - 'buildnumber.'. - + + The string to prefix the properties with. The default is + 'buildnumber.'. + @@ -16184,10 +16004,10 @@ - - Path to the file containing the current version number. The default - file is 'build.number' in the project base directory. - + + Path to the file containing the current version number. The default + file is 'build.number' in the project base directory. + @@ -16202,40 +16022,40 @@ - - Defines possible algorithms to generate the build number. - + + Defines possible algorithms to generate the build number. + - - Use the number of months since start of project * 100 + current - day in month as build number. - + + Use the number of months since start of project * 100 + current + day in month as build number. + - - Increment an existing build number. - + + Increment an existing build number. + - - Use an existing build number (and do not increment it). - + + Use an existing build number (and do not increment it). + - - Defines possible algorithms to generate the revision number. - + + Defines possible algorithms to generate the revision number. + - - Use the number of seconds since the start of today / 10. - + + Use the number of seconds since the start of today / 10. + - - Increment an existing revision number. - + + Increment an existing revision number. + @@ -16267,110 +16087,110 @@ - - The unique identifier of the process to wait for. - + + The unique identifier of the process to wait for. + - - The maximum amount of time to wait until the process is exited, - expressed in milliseconds. The default is to wait indefinitely. - + + The maximum amount of time to wait until the process is exited, + expressed in milliseconds. The default is to wait indefinitely. + - Generates code for web service clients and xml web services - using ASP.NET from WSDL contract files, XSD Schemas and .discomap - discovery documents. Can be used in conjunction with .disco files. - - Generate a proxy class for a web service. - ]]> - + Generates code for web service clients and xml web services + using ASP.NET from WSDL contract files, XSD Schemas and .discomap + discovery documents. Can be used in conjunction with .disco files. + + Generate a proxy class for a web service. + ]]> + - URL or Path to a WSDL, XSD, or .discomap document. + URL or Path to a WSDL, XSD, or .discomap document. - Suppresses the banner. + Suppresses the banner. - Language of generated code. 'CS', 'VB', 'JS', - or the fully-qualified name of a class implementing - System.CodeDom.Compiler.CodeDomCompiler. + Language of generated code. 'CS', 'VB', 'JS', + or the fully-qualified name of a class implementing + System.CodeDom.Compiler.CodeDomCompiler. - Compiles server-side ASP.NET abstract classes - based on the web service contract. The default is to - create client side proxy classes. + Compiles server-side ASP.NET abstract classes + based on the web service contract. The default is to + create client side proxy classes. - Microsoft.NET namespace of generated classes. + Microsoft.NET namespace of generated classes. - Output filename of the created proxy. Default name is derived from the service name. + Output filename of the created proxy. Default name is derived from the service name. - Override default protocol to implement. Choose from 'SOAP', - 'HttpGet', 'HttpPost', or a custom protocol as specified in the - configuration file. + Override default protocol to implement. Choose from 'SOAP', + 'HttpGet', 'HttpPost', or a custom protocol as specified in the + configuration file. - Username of an account with credentials to access a - server that requires authentication. + Username of an account with credentials to access a + server that requires authentication. - Password of an account with credentials to access a - server that requires authentication. + Password of an account with credentials to access a + server that requires authentication. - Domain of an account with credentials to access a - server that requires authentication. + Domain of an account with credentials to access a + server that requires authentication. - URL of a proxy server to use for HTTP requests. - The default is to use the system proxy setting. + URL of a proxy server to use for HTTP requests. + The default is to use the system proxy setting. - Username of an account with credentials to access a - proxy that requires authentication. + Username of an account with credentials to access a + proxy that requires authentication. - Password of an account with credentials to access a - proxy that requires authentication. + Password of an account with credentials to access a + proxy that requires authentication. - Domain of an account with credentials to access a - proxy that requires authentication. + Domain of an account with credentials to access a + proxy that requires authentication. - Configuration key to use in the code generation to - read the default value for the Url property. The default is - not to read from the config file. + Configuration key to use in the code generation to + read the default value for the Url property. The default is + not to read from the config file. - Base Url to use when calculating the Url fragment. - The UrlKey attribute must also be specified. + Base Url to use when calculating the Url fragment. + The UrlKey attribute must also be specified. - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + @@ -16471,23 +16291,23 @@ - - XML Schema (.xsd) filename. - + + XML Schema (.xsd) filename. + - - Target of XML Schema compilation - either classes or - dataset. The default is classes. - + + Target of XML Schema compilation - either classes or + dataset. The default is classes. + - - XML element in the Schema to process. - - - TO-DO : turn this into collection of elements ! - + + XML element in the Schema to process. + + + TO-DO : turn this into collection of elements ! + @@ -16497,29 +16317,29 @@ - - Specifies the runtime namespace for the generated types. The default - namespace is Schemas. - + + Specifies the runtime namespace for the generated types. The default + namespace is Schemas. + - - The output directory in which to place generated files. - + + The output directory in which to place generated files. + - - Assembly (.dll or .exe) to generate an XML Schema for. - + + Assembly (.dll or .exe) to generate an XML Schema for. + - - Types in the assembly for which an XML schema is being created. - By default all types in the assembly will be included. - - - TO-DO : turn this into collection of types ! - + + Types in the assembly for which an XML schema is being created. + By default all types in the assembly will be included. + + + TO-DO : turn this into collection of types ! + @@ -16528,60 +16348,60 @@ - - XML document to generate an XML Schema for. - + + XML document to generate an XML Schema for. + - - XDR Schema to generate an XML Schema for. - + + XDR Schema to generate an XML Schema for. + - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Indicates the status of a service. - + + Indicates the status of a service. + - - The service is unbound. - + + The service is unbound. + - - The service is bound. - + + The service is bound. + - - The service is enlisted, but not started. - + + The service is enlisted, but not started. + - - The service is started. - + + The service is started. + @@ -16615,14 +16435,14 @@ - - Report with separate HTML frames. - + + Report with separate HTML frames. + - - Frameless report. - + + Frameless report. + @@ -16639,19 +16459,19 @@ - - Constructs and initializes an instance of Entity. - + + Constructs and initializes an instance of Entity. + - - The path for the entity. - + + The path for the entity. + - - If true then the entity will be included. The default is true. - + + If true then the entity will be included. The default is true. + @@ -16669,19 +16489,19 @@ - - Constructs and initializes an instance of EntitySet. - + + Constructs and initializes an instance of EntitySet. + - - Gets the collection of entity paths assigned to this entity set. - + + Gets the collection of entity paths assigned to this entity set. + - - The entities to include in the project task. - + + The entities to include in the project task. + @@ -16719,35 +16539,35 @@ - - Constructs and initializes an instance of Assembly. - + + Constructs and initializes an instance of Assembly. + - - Converts this Assembly object into it's string representation. - - + + Converts this Assembly object into it's string representation. + + - - The culture for the assembly. - + + The culture for the assembly. + - - If true then the assembly will be included. The default is true. - + + If true then the assembly will be included. The default is true. + - - The name of the assembly. - + + The name of the assembly. + - - The public key token of the assembly. - + + The public key token of the assembly. + @@ -16756,42 +16576,42 @@ - - The version of the assembly. - + + The version of the assembly. + - - Represents a set of assemblies via their identity information. - + + Represents a set of assemblies via their identity information. + - - Constructs and initializes an instance of AssemblySet. - + + Constructs and initializes an instance of AssemblySet. + - - Gets the collection of assemblies added to this assembly set. - + + Gets the collection of assemblies added to this assembly set. + - - The assemblies to include. - + + The assemblies to include. + - - The set of files to work on. - + + The set of files to work on. + - - The label to apply to the results. - + + The label to apply to the results. + @@ -16857,11 +16677,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -16894,10 +16714,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -16918,28 +16738,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -16947,14 +16767,14 @@ - - Holds the token which will be replaced in the filter operation. - + + Holds the token which will be replaced in the filter operation. + - - Holsd the value which will replace the token in the filtering operation. - + + Holsd the value which will replace the token in the filtering operation. + @@ -16970,14 +16790,14 @@ The value which will replace the token when filtering. - - The token which will be replaced when filtering. - + + The token which will be replaced when filtering. + - - The value which will replace the token when filtering. - + + The value which will replace the token when filtering. + @@ -17042,11 +16862,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -17079,10 +16899,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -17103,48 +16923,48 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - A set of filters to be applied to something. - - - - A filter set may have begintoken and endtokens defined. - - + + A set of filters to be applied to something. + + + + A filter set may have begintoken and endtokens defined. + + - - The default token start string. - + + The default token start string. + - - The default token end string. - + + The default token end string. + @@ -17152,30 +16972,30 @@ - - Does replacement on the given string with token matching. - - The line to process the tokens in. - - The line with the tokens replaced. - + + Does replacement on the given string with token matching. + + The line to process the tokens in. + + The line with the tokens replaced. + - - The string used to identity the beginning of a token. The default is - @. - + + The string used to identity the beginning of a token. The default is + @. + - - The string used to identify the end of a token. The default is - @. - + + The string used to identify the end of a token. The default is + @. + - - The filters to apply. - + + The filters to apply. + @@ -17229,11 +17049,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -17266,28 +17086,28 @@ The to remove from the collection. - - Does replacement on the given string with token matching. - - The line to process the tokens in. - - The line with the tokens replaced. - + + Does replacement on the given string with token matching. + + The line to process the tokens in. + + The line with the tokens replaced. + - - Checks to see if there are filters in the collection of filtersets. - - - if there are filters in this collection of - filtersets; otherwise, . - + + Checks to see if there are filters in the collection of filtersets. + + + if there are filters in this collection of + filtersets; otherwise, . + - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -17302,38 +17122,38 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Used to specify reference information when working with the GAC. - - - - The full details of GAC references can be found in the SDK documentation. - - + + Used to specify reference information when working with the GAC. + + + + The full details of GAC references can be found in the SDK documentation. + + @@ -17361,35 +17181,35 @@ - - Constructs and initializes an instance of GacReference. - + + Constructs and initializes an instance of GacReference. + - - If true then the entity will be included. The default is true. - + + If true then the entity will be included. The default is true. + - - The scheme type to use when working with GAC references. The default - is , which means that references will - not be used by the GAC task. - + + The scheme type to use when working with GAC references. The default + is , which means that references will + not be used by the GAC task. + - - The scheme ID to use when working with GAC references. This is only - relevant if a scheme type other than - is specified. - + + The scheme ID to use when working with GAC references. This is only + relevant if a scheme type other than + is specified. + - - The scheme description to use when working with GAC references. This - is only relevant if a scheme type other than - is specified. - + + The scheme description to use when working with GAC references. This + is only relevant if a scheme type other than + is specified. + @@ -17398,27 +17218,27 @@ - - Represents the an element based on a schema definition. - + + Represents the an element based on a schema definition. + - - Represents the schema collection element. - + + Represents the schema collection element. + - - Namespace URI associated with this schema. - If not present, it is assumed that the - schema's targetNamespace value is to be used. - + + Namespace URI associated with this schema. + If not present, it is assumed that the + schema's targetNamespace value is to be used. + - - Location of this schema. Could be a - local file path or an HTTP URL. - + + Location of this schema. Could be a + local file path or an HTTP URL. + @@ -17484,11 +17304,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -17521,10 +17341,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -17545,34 +17365,34 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Helper class to calculate checksums - of files. - + + Helper class to calculate checksums + of files. + @@ -17582,50 +17402,50 @@ The specified hash algorithm does not exist. - - Calculates a checksum for a given file - and returns it in a hex string - - name of the input file - hex checksum string + + Calculates a checksum for a given file + and returns it in a hex string + + name of the input file + hex checksum string - - Converts a checksum value (a byte array) - into a Hex-formatted string. - - Checksum value to convert - Hexified string value + + Converts a checksum value (a byte array) + into a Hex-formatted string. + + Checksum value to convert + Hexified string value - - Recorder interface user with the Record task - + + Recorder interface user with the Record task + - - Starts recording. - + + Starts recording. + - - Stops recording. - + + Stops recording. + - - Closes the recorder. - + + Closes the recorder. + - - Flushes the recorder. - + + Flushes the recorder. + - - Gets the name of this recorder (possibly a file name). - + + Gets the name of this recorder (possibly a file name). + @@ -17633,15 +17453,15 @@ - - Defines whether the underlying writer is automatically flushes or - not. - + + Defines whether the underlying writer is automatically flushes or + not. + - - Keeps track of used recorders - + + Keeps track of used recorders + @@ -17650,9 +17470,9 @@ - - Flushes buffered build events or messages to the underlying storage. - + + Flushes buffered build events or messages to the underlying storage. + @@ -17720,11 +17540,11 @@ - - Empty implementation which allows derived classes to receive the - output that is generated in this logger. - - The message being logged. + + Empty implementation which allows derived classes to receive the + output that is generated in this logger. + + The message being logged. @@ -17754,28 +17574,28 @@ TODO - - Gets or sets the highest level of message this logger should respond - to. - - - The highest level of message this logger should respond to. - - - Only messages with a message level higher than or equal to the given - level should be written to the log. - + + Gets or sets the highest level of message this logger should respond + to. + + + The highest level of message this logger should respond to. + + + Only messages with a message level higher than or equal to the given + level should be written to the log. + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - if output is to be unadorned so that emacs - and other editors can parse files names, etc. The default is - . - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + if output is to be unadorned so that emacs + and other editors can parse files names, etc. The default is + . + @@ -17784,9 +17604,9 @@ - - Groups a set of useful file manipulation methods. - + + Groups a set of useful file manipulation methods. + @@ -17817,161 +17637,161 @@ The collection of filtersets that should be applied to the file. - - Given an absolute directory and an absolute file name, returns a - relative file name. - - An absolute directory. - An absolute file name. - - A relative file name for the given absolute file name. - + + Given an absolute directory and an absolute file name, returns a + relative file name. + + An absolute directory. + An absolute file name. + + A relative file name for the given absolute file name. + - - Returns a string from your INI file - - - - - + + Returns a string from your INI file + + + + + - - ' Writes a string to your INI file - - - - + + ' Writes a string to your INI file + + + + - - Helper class used to execute Sql Statements. - + + Helper class used to execute Sql Statements. + - - Initializes a new instance. - - OleDB Connection string - True if you want to use a transaction + + Initializes a new instance. + + OleDB Connection string + True if you want to use a transaction - - Close the connection and terminate - - true if the transaction should be commited + + Close the connection and terminate + + true if the transaction should be commited - - Executes a SQL statement. - - SQL statement to execute - Command timeout to use - Data reader used to check the result + + Executes a SQL statement. + + SQL statement to execute + Command timeout to use + Data reader used to check the result - - OleDB Connection object - + + OleDB Connection object + - - Helper class to adapt SQL statements from some - input into something OLEDB can consume directly - + + Helper class to adapt SQL statements from some + input into something OLEDB can consume directly + - - Creates a new instance - - + + Creates a new instance + + - - Adapts a set of Sql statements from a string. - - A string containing the original sql statements + + Adapts a set of Sql statements from a string. + + A string containing the original sql statements - - Adapts a set of Sql statements from a string. - - Path of file containing all sql statements - The encoding of the file containing the SQL statements. - The new instance + + Adapts a set of Sql statements from a string. + + Path of file containing all sql statements + The encoding of the file containing the SQL statements. + The new instance - - Determines how the delimiter is interpreted in a SQL string. - + + Determines how the delimiter is interpreted in a SQL string. + - - Delimiter can appear anywhere on a line. - + + Delimiter can appear anywhere on a line. + - - Delimiter always appears by itself on a line. - + + Delimiter always appears by itself on a line. + - - Helper class to maintain a list of SQL Statements. - + + Helper class to maintain a list of SQL Statements. + - - Initializes a new instance. - - String that separates statements from each other - Style of the delimiter + + Initializes a new instance. + + String that separates statements from each other + Style of the delimiter - - Parses the SQL into the internal list using the specified delimiter - and delimiter style - - The SQL string to parse. + + Parses the SQL into the internal list using the specified delimiter + and delimiter style + + The SQL string to parse. - - Parses the contents of the file into the - internal list using the specified delimiter - and delimiter style - - File name - The encoding of the file containing the SQL statements. + + Parses the contents of the file into the + internal list using the specified delimiter + and delimiter style + + File name + The encoding of the file containing the SQL statements. - - Allows foreach(). - - + + Allows foreach(). + + - - Expands project properties in the - sql string - - - + + Expands project properties in the + sql string + + + - - Gets the number of statements in the list. - + + Gets the number of statements in the list. + - - Gets the statement specified by the index. - + + Gets the statement specified by the index. + - - Project's properties for property expansion - + + Project's properties for property expansion + @@ -17979,472 +17799,592 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - - - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -18468,286 +18408,286 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + @@ -18828,130 +18768,148 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + - + - + - + @@ -18966,253 +18924,295 @@ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/contrib/SLiNgshoT.Core.dll b/Tools/nant/contrib/SLiNgshoT.Core.dll new file mode 100644 index 0000000..7a3b91b Binary files /dev/null and b/Tools/nant/contrib/SLiNgshoT.Core.dll differ diff --git a/Tools/nant/contrib/SourceSafe.Interop.dll b/Tools/nant/contrib/SourceSafe.Interop.dll new file mode 100644 index 0000000..85493ae Binary files /dev/null and b/Tools/nant/contrib/SourceSafe.Interop.dll differ diff --git a/Tools/nant/examples/Filters/ReplaceCharacter/ReplaceCharacter.cs b/Tools/nant/examples/Filters/ReplaceCharacter/ReplaceCharacter.cs new file mode 100644 index 0000000..25b5cc3 --- /dev/null +++ b/Tools/nant/examples/Filters/ReplaceCharacter/ReplaceCharacter.cs @@ -0,0 +1,115 @@ +using System; +using System.IO; +using System.Globalization; + +using NAnt.Core.Attributes; +using NAnt.Core.Filters; + +namespace NAnt.Examples.Filters { + /// + /// Replaces a specific character in a file. + /// + /// + /// Replaces the character specified by with the + /// character specified by . + /// + /// + /// Replace all "@" characters with "~". + /// + /// + /// ]]> + /// + /// + [ElementName("replacecharacter")] + public class ReplaceCharacter : Filter { + /// + /// Delegate for Read and Peek. Allows the same implementation + /// to be used for both methods. + /// + delegate int AcquireCharDelegate(); + + #region Private Instance Fields + + private char _from; + private char _to; + + //Methods used for Read and Peek + private AcquireCharDelegate ReadChar = null; + private AcquireCharDelegate PeekChar = null; + + #endregion Private Instance Fields + + #region Public Instance Properties + + /// + /// The character to replace. + /// + [TaskAttribute("from", Required=true)] + public char From { + get { return _from; } + set { _from = value; } + } + + /// + /// The character to replace with. + /// + [TaskAttribute("to", Required=true)] + public char To { + get { return _to; } + set { _to = value; } + } + + #endregion Public Instance Properties + + #region Public Instance Methods + + /// + /// Construct that allows this filter to be chained to the one + /// in the parameter chainedReader. + /// + /// Filter that the filter will be chained to + public override void Chain(ChainableReader chainedReader) { + base.Chain(chainedReader); + ReadChar = new AcquireCharDelegate(base.Read); + PeekChar = new AcquireCharDelegate(base.Peek); + } + + /// + /// Reads the next character applying the filter logic. + /// + /// Char as an int or -1 if at the end of the stream + public override int Read() { + return GetNextCharacter(ReadChar); + } + + /// + /// Reads the next character applying the filter logic without + /// advancing the current position in the stream. + /// + /// Char as an int or -1 if at the end of the stream + public override int Peek() { + return GetNextCharacter(PeekChar); + } + + #endregion Public Instance Methods + + #region Private Instance Methods + + /// + /// Returns the next character in the stream replacing the specified character. Using the + /// allows for the same implementation for Read and Peek + /// + /// Delegate to acquire the next character. (Read/Peek) + /// Char as an int or -1 if at the end of the stream + private int GetNextCharacter(AcquireCharDelegate AcquireChar) { + int nextChar = AcquireChar(); + if (nextChar == From) { + return To; + } + return nextChar; + } + + #endregion Private Instance Methods + } +} diff --git a/Tools/nant/examples/Filters/ReplaceCharacter/default.build b/Tools/nant/examples/Filters/ReplaceCharacter/default.build new file mode 100644 index 0000000..057915d --- /dev/null +++ b/Tools/nant/examples/Filters/ReplaceCharacter/default.build @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/HelloWindowsForms/HelloWindowsForms.build b/Tools/nant/examples/HelloWindowsForms/HelloWindowsForms.build new file mode 100644 index 0000000..f9a3b68 --- /dev/null +++ b/Tools/nant/examples/HelloWindowsForms/HelloWindowsForms.build @@ -0,0 +1,59 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/HelloWindowsForms/HelloWindowsForms.vbproj b/Tools/nant/examples/HelloWindowsForms/HelloWindowsForms.vbproj new file mode 100644 index 0000000..2017993 --- /dev/null +++ b/Tools/nant/examples/HelloWindowsForms/HelloWindowsForms.vbproj @@ -0,0 +1,107 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/HelloWindowsForms/MainForm.resx b/Tools/nant/examples/HelloWindowsForms/MainForm.resx new file mode 100644 index 0000000..de6582f --- /dev/null +++ b/Tools/nant/examples/HelloWindowsForms/MainForm.resx @@ -0,0 +1,105 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 1.3 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + Assembly + + + MainForm + + \ No newline at end of file diff --git a/Tools/nant/examples/HelloWindowsForms/MainForm.vb b/Tools/nant/examples/HelloWindowsForms/MainForm.vb new file mode 100644 index 0000000..4bd4db5 --- /dev/null +++ b/Tools/nant/examples/HelloWindowsForms/MainForm.vb @@ -0,0 +1,60 @@ +Public Class MainForm + Inherits System.Windows.Forms.Form + +#Region " Windows Form Designer generated code " + + Public Sub New() + MyBase.New() + + 'This call is required by the Windows Form Designer. + InitializeComponent() + + 'Add any initialization after the InitializeComponent() call + + End Sub + + 'Form overrides dispose to clean up the component list. + Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean) + If disposing Then + If Not (components Is Nothing) Then + components.Dispose() + End If + End If + MyBase.Dispose(disposing) + End Sub + + 'Required by the Windows Form Designer + Private components As System.ComponentModel.IContainer + + 'NOTE: The following procedure is required by the Windows Form Designer + 'It can be modified using the Windows Form Designer. + 'Do not modify it using the code editor. + Friend WithEvents myLabel As System.Windows.Forms.Label + Private Sub InitializeComponent() + Me.myLabel = New System.Windows.Forms.Label() + Me.SuspendLayout() + ' + 'myLabel + ' + Me.myLabel.Dock = System.Windows.Forms.DockStyle.Fill + Me.myLabel.Font = New System.Drawing.Font("Tahoma", 24.0!, System.Drawing.FontStyle.Regular, System.Drawing.GraphicsUnit.Point, CType(0, Byte)) + Me.myLabel.Name = "myLabel" + Me.myLabel.Size = New System.Drawing.Size(304, 118) + Me.myLabel.TabIndex = 0 + Me.myLabel.Text = "Hello Windows Forms" + Me.myLabel.TextAlign = System.Drawing.ContentAlignment.MiddleCenter + ' + 'MainForm + ' + Me.AutoScaleBaseSize = New System.Drawing.Size(5, 13) + Me.ClientSize = New System.Drawing.Size(304, 118) + Me.Controls.AddRange(New System.Windows.Forms.Control() {Me.myLabel}) + Me.Name = "MainForm" + Me.Text = "Hello Windows Forms" + Me.ResumeLayout(False) + + End Sub + +#End Region + +End Class diff --git a/Tools/nant/examples/HelloWorld/HelloWorld.cs b/Tools/nant/examples/HelloWorld/HelloWorld.cs new file mode 100644 index 0000000..315fd9d --- /dev/null +++ b/Tools/nant/examples/HelloWorld/HelloWorld.cs @@ -0,0 +1,5 @@ +public class ProjectName { + static void Main() { + System.Console.WriteLine("Hello World using C#"); + } +} diff --git a/Tools/nant/examples/HelloWorld/HelloWorld.js b/Tools/nant/examples/HelloWorld/HelloWorld.js new file mode 100644 index 0000000..62627e5 --- /dev/null +++ b/Tools/nant/examples/HelloWorld/HelloWorld.js @@ -0,0 +1 @@ +print("Hello World using JScript.NET"); \ No newline at end of file diff --git a/Tools/nant/examples/HelloWorld/HelloWorld.vb b/Tools/nant/examples/HelloWorld/HelloWorld.vb new file mode 100644 index 0000000..f798354 --- /dev/null +++ b/Tools/nant/examples/HelloWorld/HelloWorld.vb @@ -0,0 +1,8 @@ +Imports System + +Public Class MainApp + Shared Sub Main() + Console.WriteLine("Hello World using VB.NET") + Return + End Sub +End Class diff --git a/Tools/nant/examples/HelloWorld/default.build b/Tools/nant/examples/HelloWorld/default.build new file mode 100644 index 0000000..298d120 --- /dev/null +++ b/Tools/nant/examples/HelloWorld/default.build @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/NUnit2/ReferenceAssemblies/Helper.cs b/Tools/nant/examples/NUnit2/ReferenceAssemblies/Helper.cs new file mode 100644 index 0000000..c9343d8 --- /dev/null +++ b/Tools/nant/examples/NUnit2/ReferenceAssemblies/Helper.cs @@ -0,0 +1,6 @@ +namespace Helpers { + public class Log { + public static void Debug(string msg) { + } + } +} diff --git a/Tools/nant/examples/NUnit2/ReferenceAssemblies/ReferenceTest.cs b/Tools/nant/examples/NUnit2/ReferenceAssemblies/ReferenceTest.cs new file mode 100644 index 0000000..409b15b --- /dev/null +++ b/Tools/nant/examples/NUnit2/ReferenceAssemblies/ReferenceTest.cs @@ -0,0 +1,12 @@ +using NUnit.Framework; +using Helpers; + +namespace NAnt.NUnit2.Tests { + [TestFixture] + public class ReferenceTests { + [Test] + public void LogTest () { + Log.Debug ("whatever"); + } + } +} diff --git a/Tools/nant/examples/NUnit2/ReferenceAssemblies/default.build b/Tools/nant/examples/NUnit2/ReferenceAssemblies/default.build new file mode 100644 index 0000000..2b399b3 --- /dev/null +++ b/Tools/nant/examples/NUnit2/ReferenceAssemblies/default.build @@ -0,0 +1,47 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/ScriptTask/script-sample.build b/Tools/nant/examples/ScriptTask/script-sample.build new file mode 100644 index 0000000..1bcdb4a --- /dev/null +++ b/Tools/nant/examples/ScriptTask/script-sample.build @@ -0,0 +1,25 @@ + + + + + + + + diff --git a/Tools/nant/examples/Simple/Simple.build b/Tools/nant/examples/Simple/Simple.build new file mode 100644 index 0000000..5981212 --- /dev/null +++ b/Tools/nant/examples/Simple/Simple.build @@ -0,0 +1,22 @@ + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/Simple/Simple.cs b/Tools/nant/examples/Simple/Simple.cs new file mode 100644 index 0000000..4484a85 --- /dev/null +++ b/Tools/nant/examples/Simple/Simple.cs @@ -0,0 +1,5 @@ +public class Simple { + static void Main() { + System.Console.WriteLine("Hello, World!"); + } +} diff --git a/Tools/nant/examples/Solution/cpp/WinForms/AssemblyInfo.cpp b/Tools/nant/examples/Solution/cpp/WinForms/AssemblyInfo.cpp new file mode 100644 index 0000000..e550a32 --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/AssemblyInfo.cpp @@ -0,0 +1,58 @@ +#include "stdafx.h" + +using namespace System::Reflection; +using namespace System::Runtime::CompilerServices; + +// +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +// +[assembly:AssemblyTitleAttribute("")]; +[assembly:AssemblyDescriptionAttribute("")]; +[assembly:AssemblyConfigurationAttribute("")]; +[assembly:AssemblyCompanyAttribute("")]; +[assembly:AssemblyProductAttribute("")]; +[assembly:AssemblyCopyrightAttribute("")]; +[assembly:AssemblyTrademarkAttribute("")]; +[assembly:AssemblyCultureAttribute("")]; + +// +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the value or you can default the Revision and Build Numbers +// by using the '*' as shown below: + +[assembly:AssemblyVersionAttribute("1.0.*")]; + +// +// In order to sign your assembly you must specify a key to use. Refer to the +// Microsoft .NET Framework documentation for more information on assembly signing. +// +// Use the attributes below to control which key is used for signing. +// +// Notes: +// (*) If no key is specified, the assembly is not signed. +// (*) KeyName refers to a key that has been installed in the Crypto Service +// Provider (CSP) on your machine. KeyFile refers to a file which contains +// a key. +// (*) If the KeyFile and the KeyName values are both specified, the +// following processing occurs: +// (1) If the KeyName can be found in the CSP, that key is used. +// (2) If the KeyName does not exist and the KeyFile does exist, the key +// in the KeyFile is installed into the CSP and used. +// (*) In order to create a KeyFile, you can use the sn.exe (Strong Name) utility. +// When specifying the KeyFile, the location of the KeyFile should be +// relative to the project directory. +// (*) Delay Signing is an advanced option - see the Microsoft .NET Framework +// documentation for more information on this. +// +[assembly:AssemblyDelaySignAttribute(false)]; +[assembly:AssemblyKeyFileAttribute("")]; +[assembly:AssemblyKeyNameAttribute("")]; + diff --git a/Tools/nant/examples/Solution/cpp/WinForms/Form1.cpp b/Tools/nant/examples/Solution/cpp/WinForms/Form1.cpp new file mode 100644 index 0000000..2d2469b --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/Form1.cpp @@ -0,0 +1,15 @@ +#include "stdafx.h" +#include "Form1.h" +#include + +using namespace WinForms; + +int APIENTRY _tWinMain(HINSTANCE hInstance, + HINSTANCE hPrevInstance, + LPTSTR lpCmdLine, + int nCmdShow) +{ + System::Threading::Thread::CurrentThread->ApartmentState = System::Threading::ApartmentState::STA; + Application::Run(new Form1()); + return 0; +} diff --git a/Tools/nant/examples/Solution/cpp/WinForms/Form1.h b/Tools/nant/examples/Solution/cpp/WinForms/Form1.h new file mode 100644 index 0000000..873c55e --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/Form1.h @@ -0,0 +1,59 @@ +#pragma once + + +namespace WinForms +{ + using namespace System; + using namespace System::ComponentModel; + using namespace System::Collections; + using namespace System::Windows::Forms; + using namespace System::Data; + using namespace System::Drawing; + + /// + /// Summary for Form1 + /// + /// WARNING: If you change the name of this class, you will need to change the + /// 'Resource File Name' property for the managed resource compiler tool + /// associated with all .resx files this class depends on. Otherwise, + /// the designers will not be able to interact properly with localized + /// resources associated with this form. + /// + public __gc class Form1 : public System::Windows::Forms::Form + { + public: + Form1(void) + { + InitializeComponent(); + } + + protected: + void Dispose(Boolean disposing) + { + if (disposing && components) + { + components->Dispose(); + } + __super::Dispose(disposing); + } + + private: + /// + /// Required designer variable. + /// + System::ComponentModel::Container * components; + + /// + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. + /// + void InitializeComponent(void) + { + this->components = new System::ComponentModel::Container(); + this->Size = System::Drawing::Size(300,300); + this->Text = S"Form1"; + } + }; +} + + diff --git a/Tools/nant/examples/Solution/cpp/WinForms/Form1.resX b/Tools/nant/examples/Solution/cpp/WinForms/Form1.resX new file mode 100644 index 0000000..3f337e0 --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/Form1.resX @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 1.0.0.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + diff --git a/Tools/nant/examples/Solution/cpp/WinForms/ReadMe.txt b/Tools/nant/examples/Solution/cpp/WinForms/ReadMe.txt new file mode 100644 index 0000000..4246609 --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/ReadMe.txt @@ -0,0 +1,33 @@ +======================================================================== + APPLICATION : winforms Project Overview +======================================================================== + +AppWizard has created this winforms Application for you. + +This file contains a summary of what you will find in each of the files that +make up your winforms application. + +winforms.vcproj + This is the main project file for VC++ projects generated using an Application Wizard. + It contains information about the version of Visual C++ that generated the file, and + information about the platforms, configurations, and project features selected with the + Application Wizard. + +Form1.cpp + This is the main application source file. + Contains the code to display the form. + +Form1.h + Contains the implementation of your form class and InitializeComponent() function. + +AssemblyInfo.cpp + Contains custom attributes for modifying assembly metadata. + +///////////////////////////////////////////////////////////////////////////// +Other standard files: + +StdAfx.h, StdAfx.cpp + These files are used to build a precompiled header (PCH) file + named Win32.pch and a precompiled types file named StdAfx.obj. + +///////////////////////////////////////////////////////////////////////////// diff --git a/Tools/nant/examples/Solution/cpp/WinForms/WinForms.sln b/Tools/nant/examples/Solution/cpp/WinForms/WinForms.sln new file mode 100644 index 0000000..7690d9f --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/WinForms.sln @@ -0,0 +1,21 @@ +Microsoft Visual Studio Solution File, Format Version 8.00 +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "WinForms", "WinForms.vcproj", "{11211AF9-DD1D-4151-844A-A2430B67DE3D}" + ProjectSection(ProjectDependencies) = postProject + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfiguration) = preSolution + Debug = Debug + Release = Release + EndGlobalSection + GlobalSection(ProjectConfiguration) = postSolution + {11211AF9-DD1D-4151-844A-A2430B67DE3D}.Debug.ActiveCfg = Debug|Win32 + {11211AF9-DD1D-4151-844A-A2430B67DE3D}.Debug.Build.0 = Debug|Win32 + {11211AF9-DD1D-4151-844A-A2430B67DE3D}.Release.ActiveCfg = Release|Win32 + {11211AF9-DD1D-4151-844A-A2430B67DE3D}.Release.Build.0 = Release|Win32 + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + EndGlobalSection + GlobalSection(ExtensibilityAddIns) = postSolution + EndGlobalSection +EndGlobal diff --git a/Tools/nant/examples/Solution/cpp/WinForms/WinForms.vcproj b/Tools/nant/examples/Solution/cpp/WinForms/WinForms.vcproj new file mode 100644 index 0000000..5b1fd27 --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/WinForms.vcproj @@ -0,0 +1,194 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/Solution/cpp/WinForms/app.ico b/Tools/nant/examples/Solution/cpp/WinForms/app.ico new file mode 100644 index 0000000..3a5525f Binary files /dev/null and b/Tools/nant/examples/Solution/cpp/WinForms/app.ico differ diff --git a/Tools/nant/examples/Solution/cpp/WinForms/app.rc b/Tools/nant/examples/Solution/cpp/WinForms/app.rc new file mode 100644 index 0000000..6be44ad --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/app.rc @@ -0,0 +1,52 @@ +// Microsoft Visual C++ generated resource script. +// +#include "resource.h" + +#define APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +#undef APSTUDIO_READONLY_SYMBOLS + +///////////////////////////////////////////////////////////////////////////// +// English (U.S.) resources + + +///////////////////////////////////////////////////////////////////////////// +// +// Icon +// + +// Icon placed first or with lowest ID value becomes application icon + +LANGUAGE 9, 1 +#pragma code_page(1252) +1 ICON "app.ico" + +#ifdef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// TEXTINCLUDE +// + +1 TEXTINCLUDE +BEGIN + "resource.h\0" + "\0" +END + +#endif // APSTUDIO_INVOKED + +///////////////////////////////////////////////////////////////////////////// + + + +#ifndef APSTUDIO_INVOKED +///////////////////////////////////////////////////////////////////////////// +// +// Generated from the TEXTINCLUDE 3 resource. +// + + +///////////////////////////////////////////////////////////////////////////// +#endif // not APSTUDIO_INVOKED + diff --git a/Tools/nant/examples/Solution/cpp/WinForms/cpp.build b/Tools/nant/examples/Solution/cpp/WinForms/cpp.build new file mode 100644 index 0000000..951bc16 --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/cpp.build @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + Output file doesn't exist in ${expected.output} + + + \ No newline at end of file diff --git a/Tools/nant/examples/Solution/cpp/WinForms/resource.h b/Tools/nant/examples/Solution/cpp/WinForms/resource.h new file mode 100644 index 0000000..d5ac7c4 --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/resource.h @@ -0,0 +1,3 @@ +//{{NO_DEPENDENCIES}} +// Microsoft Visual C++ generated include file. +// Used by app.rc diff --git a/Tools/nant/examples/Solution/cpp/WinForms/stdafx.cpp b/Tools/nant/examples/Solution/cpp/WinForms/stdafx.cpp new file mode 100644 index 0000000..14bb7bb --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/stdafx.cpp @@ -0,0 +1,7 @@ +// stdafx.cpp : source file that includes just the standard includes +// winforms.pch will be the pre-compiled header +// stdafx.obj will contain the pre-compiled type information + +#include "stdafx.h" + + diff --git a/Tools/nant/examples/Solution/cpp/WinForms/stdafx.h b/Tools/nant/examples/Solution/cpp/WinForms/stdafx.h new file mode 100644 index 0000000..ae2d8aa --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/WinForms/stdafx.h @@ -0,0 +1,14 @@ +// stdafx.h : include file for standard system include files, +// or project specific include files that are used frequently, but +// are changed infrequently +#pragma once + + +#define WIN32_LEAN_AND_MEAN // Exclude rarely-used stuff from Windows headers +// C RunTime Header Files +#include +#include +#include +#include + +// TODO: reference additional headers your program requires here diff --git a/Tools/nant/examples/Solution/cpp/default.build b/Tools/nant/examples/Solution/cpp/default.build new file mode 100644 index 0000000..a1eb910 --- /dev/null +++ b/Tools/nant/examples/Solution/cpp/default.build @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/Tools/nant/examples/Solution/cs/WinForms/App.ico b/Tools/nant/examples/Solution/cs/WinForms/App.ico new file mode 100644 index 0000000..3a5525f Binary files /dev/null and b/Tools/nant/examples/Solution/cs/WinForms/App.ico differ diff --git a/Tools/nant/examples/Solution/cs/WinForms/AssemblyInfo.cs b/Tools/nant/examples/Solution/cs/WinForms/AssemblyInfo.cs new file mode 100644 index 0000000..9f89a32 --- /dev/null +++ b/Tools/nant/examples/Solution/cs/WinForms/AssemblyInfo.cs @@ -0,0 +1,58 @@ +using System.Reflection; +using System.Runtime.CompilerServices; + +// +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +// +[assembly: AssemblyTitle("")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("")] +[assembly: AssemblyCopyright("")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Revision and Build Numbers +// by using the '*' as shown below: + +[assembly: AssemblyVersion("1.0.*")] + +// +// In order to sign your assembly you must specify a key to use. Refer to the +// Microsoft .NET Framework documentation for more information on assembly signing. +// +// Use the attributes below to control which key is used for signing. +// +// Notes: +// (*) If no key is specified, the assembly is not signed. +// (*) KeyName refers to a key that has been installed in the Crypto Service +// Provider (CSP) on your machine. KeyFile refers to a file which contains +// a key. +// (*) If the KeyFile and the KeyName values are both specified, the +// following processing occurs: +// (1) If the KeyName can be found in the CSP, that key is used. +// (2) If the KeyName does not exist and the KeyFile does exist, the key +// in the KeyFile is installed into the CSP and used. +// (*) In order to create a KeyFile, you can use the sn.exe (Strong Name) utility. +// When specifying the KeyFile, the location of the KeyFile should be +// relative to the project output directory which is +// %Project Directory%\obj\. For example, if your KeyFile is +// located in the project directory, you would specify the AssemblyKeyFile +// attribute as [assembly: AssemblyKeyFile("..\\..\\mykey.snk")] +// (*) Delay Signing is an advanced option - see the Microsoft .NET Framework +// documentation for more information on this. +// +[assembly: AssemblyDelaySign(false)] +[assembly: AssemblyKeyFile("")] +[assembly: AssemblyKeyName("")] diff --git a/Tools/nant/examples/Solution/cs/WinForms/Form1.cs b/Tools/nant/examples/Solution/cs/WinForms/Form1.cs new file mode 100644 index 0000000..f229b0a --- /dev/null +++ b/Tools/nant/examples/Solution/cs/WinForms/Form1.cs @@ -0,0 +1,69 @@ +using System; +using System.Drawing; +using System.Collections; +using System.ComponentModel; +using System.Windows.Forms; +using System.Data; + +namespace WinForms +{ + /// + /// Summary description for Form1. + /// + public class Form1 : System.Windows.Forms.Form + { + /// + /// Required designer variable. + /// + private System.ComponentModel.Container components = null; + + public Form1() + { + // + // Required for Windows Form Designer support + // + InitializeComponent(); + + // + // TODO: Add any constructor code after InitializeComponent call + // + } + + /// + /// Clean up any resources being used. + /// + protected override void Dispose( bool disposing ) + { + if( disposing ) + { + if (components != null) + { + components.Dispose(); + } + } + base.Dispose( disposing ); + } + + #region Windows Form Designer generated code + /// + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. + /// + private void InitializeComponent() + { + this.components = new System.ComponentModel.Container(); + this.Size = new System.Drawing.Size(300,300); + this.Text = "Form1"; + } + #endregion + + /// + /// The main entry point for the application. + /// + [STAThread] + static void Main() + { + Application.Run(new Form1()); + } + } +} diff --git a/Tools/nant/examples/Solution/cs/WinForms/Form1.resx b/Tools/nant/examples/Solution/cs/WinForms/Form1.resx new file mode 100644 index 0000000..3f337e0 --- /dev/null +++ b/Tools/nant/examples/Solution/cs/WinForms/Form1.resx @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 1.0.0.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + diff --git a/Tools/nant/examples/Solution/cs/WinForms/WinForms.csproj b/Tools/nant/examples/Solution/cs/WinForms/WinForms.csproj new file mode 100644 index 0000000..e8fa603 --- /dev/null +++ b/Tools/nant/examples/Solution/cs/WinForms/WinForms.csproj @@ -0,0 +1,119 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/Solution/cs/WinForms/WinForms.sln b/Tools/nant/examples/Solution/cs/WinForms/WinForms.sln new file mode 100644 index 0000000..dd6a452 --- /dev/null +++ b/Tools/nant/examples/Solution/cs/WinForms/WinForms.sln @@ -0,0 +1,21 @@ +Microsoft Visual Studio Solution File, Format Version 8.00 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WinForms", "WinForms.csproj", "{C0E751EE-4590-447A-B236-FF7E71A484DF}" + ProjectSection(ProjectDependencies) = postProject + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfiguration) = preSolution + Debug = Debug + Release = Release + EndGlobalSection + GlobalSection(ProjectConfiguration) = postSolution + {C0E751EE-4590-447A-B236-FF7E71A484DF}.Debug.ActiveCfg = Debug|.NET + {C0E751EE-4590-447A-B236-FF7E71A484DF}.Debug.Build.0 = Debug|.NET + {C0E751EE-4590-447A-B236-FF7E71A484DF}.Release.ActiveCfg = Release|.NET + {C0E751EE-4590-447A-B236-FF7E71A484DF}.Release.Build.0 = Release|.NET + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + EndGlobalSection + GlobalSection(ExtensibilityAddIns) = postSolution + EndGlobalSection +EndGlobal diff --git a/Tools/nant/examples/Solution/cs/WinForms/cs.build b/Tools/nant/examples/Solution/cs/WinForms/cs.build new file mode 100644 index 0000000..b6c14df --- /dev/null +++ b/Tools/nant/examples/Solution/cs/WinForms/cs.build @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Output file doesn't exist in ${expected.output} + + + \ No newline at end of file diff --git a/Tools/nant/examples/Solution/cs/default.build b/Tools/nant/examples/Solution/cs/default.build new file mode 100644 index 0000000..a1eb910 --- /dev/null +++ b/Tools/nant/examples/Solution/cs/default.build @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/Tools/nant/examples/Solution/vb/WinForms/AssemblyInfo.vb b/Tools/nant/examples/Solution/vb/WinForms/AssemblyInfo.vb new file mode 100644 index 0000000..1378b3b --- /dev/null +++ b/Tools/nant/examples/Solution/vb/WinForms/AssemblyInfo.vb @@ -0,0 +1,32 @@ +Imports System +Imports System.Reflection +Imports System.Runtime.InteropServices + +' General Information about an assembly is controlled through the following +' set of attributes. Change these attribute values to modify the information +' associated with an assembly. + +' Review the values of the assembly attributes + + + + + + + + + +'The following GUID is for the ID of the typelib if this project is exposed to COM + + +' Version information for an assembly consists of the following four values: +' +' Major Version +' Minor Version +' Build Number +' Revision +' +' You can specify all the values or you can default the Build and Revision Numbers +' by using the '*' as shown below: + + diff --git a/Tools/nant/examples/Solution/vb/WinForms/Form1.resx b/Tools/nant/examples/Solution/vb/WinForms/Form1.resx new file mode 100644 index 0000000..3f337e0 --- /dev/null +++ b/Tools/nant/examples/Solution/vb/WinForms/Form1.resx @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 1.0.0.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + diff --git a/Tools/nant/examples/Solution/vb/WinForms/Form1.vb b/Tools/nant/examples/Solution/vb/WinForms/Form1.vb new file mode 100644 index 0000000..6a57df6 --- /dev/null +++ b/Tools/nant/examples/Solution/vb/WinForms/Form1.vb @@ -0,0 +1,39 @@ +Public Class Form1 + Inherits System.Windows.Forms.Form + +#Region " Windows Form Designer generated code " + + Public Sub New() + MyBase.New() + + 'This call is required by the Windows Form Designer. + InitializeComponent() + + 'Add any initialization after the InitializeComponent() call + + End Sub + + 'Form overrides dispose to clean up the component list. + Protected Overloads Overrides Sub Dispose(ByVal disposing As Boolean) + If disposing Then + If Not (components Is Nothing) Then + components.Dispose() + End If + End If + MyBase.Dispose(disposing) + End Sub + + 'Required by the Windows Form Designer + Private components As System.ComponentModel.IContainer + + 'NOTE: The following procedure is required by the Windows Form Designer + 'It can be modified using the Windows Form Designer. + 'Do not modify it using the code editor. + Private Sub InitializeComponent() + components = New System.ComponentModel.Container() + Me.Text = "Form1" + End Sub + +#End Region + +End Class diff --git a/Tools/nant/examples/Solution/vb/WinForms/WinForms.sln b/Tools/nant/examples/Solution/vb/WinForms/WinForms.sln new file mode 100644 index 0000000..36fe9dd --- /dev/null +++ b/Tools/nant/examples/Solution/vb/WinForms/WinForms.sln @@ -0,0 +1,21 @@ +Microsoft Visual Studio Solution File, Format Version 8.00 +Project("{F184B08F-C81C-45F6-A57F-5ABD9991F28F}") = "WinForms", "WinForms.vbproj", "{B01CBC5B-0F63-4623-8B41-806E063D4F0C}" + ProjectSection(ProjectDependencies) = postProject + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfiguration) = preSolution + Debug = Debug + Release = Release + EndGlobalSection + GlobalSection(ProjectConfiguration) = postSolution + {B01CBC5B-0F63-4623-8B41-806E063D4F0C}.Debug.ActiveCfg = Debug|.NET + {B01CBC5B-0F63-4623-8B41-806E063D4F0C}.Debug.Build.0 = Debug|.NET + {B01CBC5B-0F63-4623-8B41-806E063D4F0C}.Release.ActiveCfg = Release|.NET + {B01CBC5B-0F63-4623-8B41-806E063D4F0C}.Release.Build.0 = Release|.NET + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + EndGlobalSection + GlobalSection(ExtensibilityAddIns) = postSolution + EndGlobalSection +EndGlobal diff --git a/Tools/nant/examples/Solution/vb/WinForms/WinForms.vbproj b/Tools/nant/examples/Solution/vb/WinForms/WinForms.vbproj new file mode 100644 index 0000000..3aac73c --- /dev/null +++ b/Tools/nant/examples/Solution/vb/WinForms/WinForms.vbproj @@ -0,0 +1,112 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/Solution/vb/WinForms/vb.build b/Tools/nant/examples/Solution/vb/WinForms/vb.build new file mode 100644 index 0000000..b6c14df --- /dev/null +++ b/Tools/nant/examples/Solution/vb/WinForms/vb.build @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Output file doesn't exist in ${expected.output} + + + \ No newline at end of file diff --git a/Tools/nant/examples/Solution/vb/default.build b/Tools/nant/examples/Solution/vb/default.build new file mode 100644 index 0000000..a1eb910 --- /dev/null +++ b/Tools/nant/examples/Solution/vb/default.build @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/Tools/nant/examples/Solution/vjs/WinForms/AssemblyInfo.jsl b/Tools/nant/examples/Solution/vjs/WinForms/AssemblyInfo.jsl new file mode 100644 index 0000000..d17c68a --- /dev/null +++ b/Tools/nant/examples/Solution/vjs/WinForms/AssemblyInfo.jsl @@ -0,0 +1,58 @@ +import System.Reflection.*; +import System.Runtime.CompilerServices.*; + +// +// General Information about an assembly is controlled through the following +// set of attributes. Change these attribute values to modify the information +// associated with an assembly. +// +/** @assembly AssemblyTitle("") */ +/** @assembly AssemblyDescription("") */ +/** @assembly AssemblyConfiguration("") */ +/** @assembly AssemblyCompany("") */ +/** @assembly AssemblyProduct("") */ +/** @assembly AssemblyCopyright("") */ +/** @assembly AssemblyTrademark("") */ +/** @assembly AssemblyCulture("") */ + +// +// Version information for an assembly consists of the following four values: +// +// Major Version +// Minor Version +// Build Number +// Revision +// +// You can specify all the values or you can default the Revision and Build +// Numbers by using the '*' as shown below: + +/** @assembly AssemblyVersion("1.0.*") */ + +// +// In order to sign your assembly you must specify a key to use. Refer to the +// Microsoft .NET Framework documentation for more information on assembly signing. +// +// Use the attributes below to control which key is used for signing. +// +// Notes: +// (*) If no key is specified, the assembly is not signed. +// (*) KeyName refers to a key that has been installed in the Crypto Service +// Provider (CSP) on your machine. KeyFile refers to a file which contains +// a key. +// (*) If the KeyFile and the KeyName values are both specified, the +// following processing occurs: +// (1) If the KeyName can be found in the CSP, that key is used. +// (2) If the KeyName does not exist and the KeyFile does exist, the key +// in the KeyFile is installed into the CSP and used. +// (*) In order to create a KeyFile, you can use the sn.exe (Strong Name) utility. +// When specifying the KeyFile, the location of the KeyFile should be +// relative to the project directory. For example, if your KeyFile is +// located in the project directory itself, you would specify the +// AssemblyKeyFile attribute as @assembly AssemblyKeyFile("mykey.snk") +// (*) Delay Signing is an advanced option - see the Microsoft .NET Framework +// documentation for more information on this. +// + +/** @assembly AssemblyDelaySign(false) */ +/** @assembly AssemblyKeyFile("") */ +/** @assembly AssemblyKeyName("") */ diff --git a/Tools/nant/examples/Solution/vjs/WinForms/Form1.jsl b/Tools/nant/examples/Solution/vjs/WinForms/Form1.jsl new file mode 100644 index 0000000..544bdef --- /dev/null +++ b/Tools/nant/examples/Solution/vjs/WinForms/Form1.jsl @@ -0,0 +1,67 @@ +package WinForms; + +import System.Drawing.*; +import System.Collections.*; +import System.ComponentModel.*; +import System.Windows.Forms.*; +import System.Data.*; + +/** + * Summary description for Form1. + */ +public class Form1 extends System.Windows.Forms.Form +{ + /** + * Required designer variable. + */ + private System.ComponentModel.Container components = null; + + public Form1() + { + // + // Required for Windows Form Designer support + // + InitializeComponent(); + + // + // TODO: Add any constructor code after InitializeComponent call + // + } + + /** + * Clean up any resources being used. + */ + protected void Dispose(boolean disposing) + { + if (disposing) + { + if (components != null) + { + components.Dispose(); + } + } + super.Dispose(disposing); + } + + #region Windows Form Designer generated code + /** + * Required method for Designer support - do not modify + * the contents of this method with the code editor. + */ + private void InitializeComponent() + { + this.components = new System.ComponentModel.Container(); + this.set_Size(new System.Drawing.Size(300,300)); + this.set_Text("Form1"); + } + #endregion + + /** + * The main entry point for the application. + */ + /** @attribute System.STAThread() */ + public static void main(String[] args) + { + Application.Run(new Form1()); + } +} diff --git a/Tools/nant/examples/Solution/vjs/WinForms/Form1.resx b/Tools/nant/examples/Solution/vjs/WinForms/Form1.resx new file mode 100644 index 0000000..3f337e0 --- /dev/null +++ b/Tools/nant/examples/Solution/vjs/WinForms/Form1.resx @@ -0,0 +1,42 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 1.0.0.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=1.0.5000.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + diff --git a/Tools/nant/examples/Solution/vjs/WinForms/WinForms.sln b/Tools/nant/examples/Solution/vjs/WinForms/WinForms.sln new file mode 100644 index 0000000..7e82385 --- /dev/null +++ b/Tools/nant/examples/Solution/vjs/WinForms/WinForms.sln @@ -0,0 +1,21 @@ +Microsoft Visual Studio Solution File, Format Version 8.00 +Project("{E6FDF86B-F3D1-11D4-8576-0002A516ECE8}") = "WinForms", "WinForms.vjsproj", "{84A7C512-CE63-4884-B9FB-DF863EEC3800}" + ProjectSection(ProjectDependencies) = postProject + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfiguration) = preSolution + Debug = Debug + Release = Release + EndGlobalSection + GlobalSection(ProjectConfiguration) = postSolution + {84A7C512-CE63-4884-B9FB-DF863EEC3800}.Debug.ActiveCfg = Debug|.NET + {84A7C512-CE63-4884-B9FB-DF863EEC3800}.Debug.Build.0 = Debug|.NET + {84A7C512-CE63-4884-B9FB-DF863EEC3800}.Release.ActiveCfg = Release|.NET + {84A7C512-CE63-4884-B9FB-DF863EEC3800}.Release.Build.0 = Release|.NET + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + EndGlobalSection + GlobalSection(ExtensibilityAddIns) = postSolution + EndGlobalSection +EndGlobal diff --git a/Tools/nant/examples/Solution/vjs/WinForms/WinForms.vjsproj b/Tools/nant/examples/Solution/vjs/WinForms/WinForms.vjsproj new file mode 100644 index 0000000..a312489 --- /dev/null +++ b/Tools/nant/examples/Solution/vjs/WinForms/WinForms.vjsproj @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/Solution/vjs/WinForms/vjs.build b/Tools/nant/examples/Solution/vjs/WinForms/vjs.build new file mode 100644 index 0000000..951bc16 --- /dev/null +++ b/Tools/nant/examples/Solution/vjs/WinForms/vjs.build @@ -0,0 +1,27 @@ + + + + + + + + + + + + + + + + + + + + + + + + Output file doesn't exist in ${expected.output} + + + \ No newline at end of file diff --git a/Tools/nant/examples/Solution/vjs/default.build b/Tools/nant/examples/Solution/vjs/default.build new file mode 100644 index 0000000..a1eb910 --- /dev/null +++ b/Tools/nant/examples/Solution/vjs/default.build @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.build b/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.build new file mode 100644 index 0000000..6281ce7 --- /dev/null +++ b/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.build @@ -0,0 +1,25 @@ + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.cs b/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.cs new file mode 100644 index 0000000..9baa13c --- /dev/null +++ b/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.cs @@ -0,0 +1,12 @@ +using System; + +//Calculates the circumference of a circle given the radius. +public class Calculate { + + private double circ = 0; + + public double Circumference(double radius){ + circ = Math.PI*2*radius; + return circ; + } +} \ No newline at end of file diff --git a/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.dll b/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.dll new file mode 100644 index 0000000..ad0d4d4 Binary files /dev/null and b/Tools/nant/examples/StyleTask/SimpleExtensionObject/SimpleExtension.dll differ diff --git a/Tools/nant/examples/StyleTask/SimpleExtensionObject/circle.xsl b/Tools/nant/examples/StyleTask/SimpleExtensionObject/circle.xsl new file mode 100644 index 0000000..a7639cb --- /dev/null +++ b/Tools/nant/examples/StyleTask/SimpleExtensionObject/circle.xsl @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Tools/nant/examples/StyleTask/SimpleExtensionObject/circles.xml b/Tools/nant/examples/StyleTask/SimpleExtensionObject/circles.xml new file mode 100644 index 0000000..b3f3584 --- /dev/null +++ b/Tools/nant/examples/StyleTask/SimpleExtensionObject/circles.xml @@ -0,0 +1,10 @@ + + +12 +75.398223686155 + + +37.5 +235.61944901923448 + + \ No newline at end of file diff --git a/Tools/nant/examples/UserTask/UserTask.cs b/Tools/nant/examples/UserTask/UserTask.cs new file mode 100644 index 0000000..339a99b --- /dev/null +++ b/Tools/nant/examples/UserTask/UserTask.cs @@ -0,0 +1,31 @@ +using NAnt.Core; +using NAnt.Core.Attributes; + +namespace NAnt.Examples.Tasks { + [TaskName("usertask")] + public class TestTask : Task { + #region Private Instance Fields + + private string _message; + + #endregion Private Instance Fields + + #region Public Instance Properties + + [TaskAttribute("message", Required=true)] + public string FileName { + get { return _message; } + set { _message = value; } + } + + #endregion Public Instance Properties + + #region Override implementation of Task + + protected override void ExecuteTask() { + Log(Level.Info, _message.ToUpper()); + } + + #endregion Override implementation of Task + } +} diff --git a/Tools/nant/examples/UserTask/default.build b/Tools/nant/examples/UserTask/default.build new file mode 100644 index 0000000..5214fc6 --- /dev/null +++ b/Tools/nant/examples/UserTask/default.build @@ -0,0 +1,28 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/Tools/nant/examples/examples.build b/Tools/nant/examples/examples.build new file mode 100644 index 0000000..6f50bea --- /dev/null +++ b/Tools/nant/examples/examples.build @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/Tools/nant/schema/nant.xsd b/Tools/nant/schema/nant.xsd index 96dac1c..6855e24 100755 --- a/Tools/nant/schema/nant.xsd +++ b/Tools/nant/schema/nant.xsd @@ -1,7 +1,7 @@ - + - NAnt schema generated at 10/22/2011 18:49:35 + NAnt schema generated at 06/09/2012 07:28:04 @@ -54,6 +54,7 @@ + @@ -79,6 +80,7 @@ + @@ -431,6 +433,7 @@ + @@ -469,6 +472,7 @@ + @@ -954,6 +958,7 @@ + @@ -1584,6 +1589,24 @@ + + + + + + + + + + + + + + + + + + @@ -1757,6 +1780,7 @@ + @@ -1782,6 +1806,7 @@ + @@ -1856,6 +1881,7 @@ + @@ -1881,6 +1907,7 @@ + @@ -1994,6 +2021,7 @@ + @@ -2019,6 +2047,7 @@ + @@ -2046,11 +2075,17 @@ + + + + + + @@ -2219,6 +2254,22 @@ + + + + + + + + + + + + + + + + @@ -2387,6 +2438,7 @@ + @@ -2412,6 +2464,7 @@ + @@ -2493,6 +2546,7 @@ + @@ -2518,6 +2572,7 @@ + diff --git a/default.ps1 b/default.ps1 index 7747d1e..788453e 100644 --- a/default.ps1 +++ b/default.ps1 @@ -1 +1 @@ -$framework = '4.0' Properties { $root_dir = Split-Path $psake.build_script_file $build_artifacts_dir = "$root_dir\build\" $package_dir = "$root_dir\package" $code_dir = "source" $solution = "src\dbdeploy.net.sln" $api_key_file = "bintray.api.key" $configuration = "Debug" $scripts_dir = "$root_dir\scripts" } Task Build { Exec { msbuild $solution } } Task Clean { Exec { msbuild "$solution" /t:Clean /p:Configuration=$configuration /v:quiet "/p:OutDir=$build_artifacts_dir\" } if (Test-Path $build_artifacts_dir){ Remove-Item $build_artifacts_dir -recurse } if (Test-Path $package_dir){ Remove-Item $package_dir -recurse } } Task BuildPackage -depends Clean -description "Builds a package on 'build'. git needs to be on the path " { if (-not (Test-Path $build_artifacts_dir)){ mkdir $build_artifacts_dir } if (-not (Test-Path $package_dir)){ mkdir $package_dir } $version, $commits, $hash = $(git describe --tags --long) -split "-" $version = $version -replace "v","" # remove the v because the correct format for assemblies does not include include $hash = $hash.Substring(1) # the hash starts with g, for git, remove it $date_tag = $(get-date -Uformat "%Y%m%d_%H%M") $version_cs_content = @" // Do not commit the changes to this file. using System.Reflection; [assembly: AssemblyVersionAttribute("$version")] [assembly: AssemblyInformationalVersionAttribute("$version-$commits-$hash-$date_tag")] [assembly: AssemblyFileVersionAttribute("$version")] "@ $version_cs_content | set-content .\src\SolutionVersionAssemblyInfo.cs Write-Host "Building" -ForegroundColor Green Exec { msbuild "$solution" /t:Build /p:Configuration=$configuration /v:quiet "/p:OutDir=$build_artifacts_dir" } foreach($filename in @('Net.Sf.Dbdeploy.ilmerge.dll', 'dbdeploy.ilmerge.exe', 'dbdeploy.NAnt.ilmerge.dll','dbdeploy.Powershell.ilmerge.dll','msbuild.dbdeploy.task.ilmerge.dll')){ $original = $filename.Replace(".ilmerge.",".") Move-Item $build_artifacts_dir\$original $build_artifacts_dir\$filename } tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:library /out:$build_artifacts_dir\Net.Sf.Dbdeploy.dll Net.Sf.Dbdeploy.ilmerge.dll nvelocity.dll /internalize:internalize_exclusions.txt tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:exe /out:$build_artifacts_dir\dbdeploy.exe dbdeploy.ilmerge.exe Net.Sf.Dbdeploy.dll NDesk.Options.dll /internalize:internalize_exclusions.txt tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:library /out:$build_artifacts_dir\dbdeploy.NAnt.dll dbdeploy.NAnt.ilmerge.dll NAnt.Core.dll Net.Sf.Dbdeploy.dll /internalize:internalize_exclusions.txt tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:library /out:$build_artifacts_dir\dbdeploy.Powershell.dll dbdeploy.Powershell.ilmerge.dll Net.Sf.Dbdeploy.dll /internalize:internalize_exclusions.txt tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:library /out:$build_artifacts_dir\msbuild.dbdeploy.task.dll msbuild.dbdeploy.task.ilmerge.dll Net.Sf.Dbdeploy.dll /internalize:internalize_exclusions.txt mkdir $build_artifacts_dir\console mkdir $build_artifacts_dir\powershell mkdir $build_artifacts_dir\nant mkdir $build_artifacts_dir\msbuild mkdir $build_artifacts_dir\lib mkdir $build_artifacts_dir\scripts Copy-Item -Path $build_artifacts_dir\dbdeploy.exe -Destination $build_artifacts_dir\console Copy-Item -Path $build_artifacts_dir\dbdeploy.Powershell.dll -Destination $build_artifacts_dir\powershell Copy-Item -Path $build_artifacts_dir\dbdeploy.NAnt.dll -Destination $build_artifacts_dir\nant Copy-Item -Path $build_artifacts_dir\msbuild.dbdeploy.task.dll -Destination $build_artifacts_dir\msbuild Copy-Item -Path $build_artifacts_dir\Net.Sf.Dbdeploy.dll -Destination $build_artifacts_dir\lib Copy-Item -Path $scripts_dir\*.sql -Destination $build_artifacts_dir\scripts Get-ChildItem build -Exclude console,msbuild,nant,powershell,scripts,lib |Remove-Item -recurse Write-Host "Creating packages" -ForegroundColor Green Get-ChildItem $build_artifacts_dir\ -recurse | Write-Zip -IncludeEmptyDirectories -EntryPathRoot "build" -OutputPath $package_dir\dbdeploy.net-$version.zip git checkout .\src\SolutionVersionAssemblyInfo.cs Write-Host "Package created at $package_dir\dbdeploy.net-$version.zip" -ForegroundColor Green } Task PublishPackage -description "Publish last packaged version " { if (-not (Test-Path $api_key_file)){ throw "Missing api username and key for bintray at '$api_key_file'. Needs to a file containing just . Grab it at https://bintray.com/profile/edit" } $latest_package = (Get-ChildItem $package_dir)[0] $version = $latest_package.BaseName.Split("-")[1] $root_api_url = "https://api.bintray.com" $api_key_contents = (Get-Content $api_key_file).Trim() $api_username = $api_key_contents.split(" ")[0] $api_key = $api_key_contents.split(" ")[1] $web_client = new-object System.Net.WebClient # force the basic auth header to avoid two trips (one for the 401 and another with the header) $basic_auth_header= [Convert]::ToBase64String([System.Text.Encoding]::Utf8.GetBytes($api_username+":"+$api_key)) $web_client.Headers["Authorization"] = "Basic "+$basic_auth_header $web_client.Uploadfile("$root_api_url/content/brunomlopes/generic/dbdeploy.NET/$version/$($latest_package.Name)", "PUT", $latest_package.FullName) $web_client.UploadData("$root_api_url/content/brunomlopes/generic/dbdeploy.NET/$version/publish", "POST", [System.Text.Encoding]::Utf8.GetBytes("{'discard':false}")) } Task Help { Write-Documentation } Task default -depends Help \ No newline at end of file +$framework = '4.0' Properties { $root_dir = Split-Path $psake.build_script_file $build_artifacts_dir = "$root_dir\build\" $package_dir = "$root_dir\package" $code_dir = "source" $solution = "src\dbdeploy.net.sln" $api_key_file = "bintray.api.key" $configuration = "Debug" $scripts_dir = "$root_dir\scripts" } Task Build { Exec { msbuild $solution } } Task Clean { Exec { msbuild "$solution" /t:Clean /p:Configuration=$configuration /v:quiet "/p:OutDir=$build_artifacts_dir\" } if (Test-Path $build_artifacts_dir){ Remove-Item $build_artifacts_dir -recurse } if (Test-Path $package_dir){ Remove-Item $package_dir -recurse } } Task BuildPackage -depends Clean -description "Builds a package on 'build'. git needs to be on the path " { if (-not (Test-Path $build_artifacts_dir)){ mkdir $build_artifacts_dir } if (-not (Test-Path $package_dir)){ mkdir $package_dir } $version, $commits, $hash = $(git describe --tags --long) -split "-" $version = $version -replace "v","" # remove the v because the correct format for assemblies does not include include $hash = $hash.Substring(1) # the hash starts with g, for git, remove it $date_tag = $(get-date -Uformat "%Y%m%d_%H%M") $version_cs_content = @" // Do not commit the changes to this file. using System.Reflection; [assembly: AssemblyVersionAttribute("$version")] [assembly: AssemblyInformationalVersionAttribute("$version-$commits-$hash-$date_tag")] [assembly: AssemblyFileVersionAttribute("$version")] "@ $version_cs_content | set-content .\src\SolutionVersionAssemblyInfo.cs Write-Host "Building" -ForegroundColor Green Exec { msbuild "$solution" /t:Build /p:Configuration=$configuration /v:quiet "/p:OutDir=$build_artifacts_dir" } foreach($filename in @('Net.Sf.Dbdeploy.ilmerge.dll', 'dbdeploy.ilmerge.exe', 'dbdeploy.NAnt.ilmerge.dll','dbdeploy.Powershell.ilmerge.dll','msbuild.dbdeploy.task.ilmerge.dll')){ $original = $filename.Replace(".ilmerge.",".") Move-Item $build_artifacts_dir\$original $build_artifacts_dir\$filename } tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:library /out:$build_artifacts_dir\Net.Sf.Dbdeploy.dll Net.Sf.Dbdeploy.ilmerge.dll nvelocity.dll /internalize:internalize_exclusions.txt tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:exe /out:$build_artifacts_dir\dbdeploy.exe dbdeploy.ilmerge.exe Net.Sf.Dbdeploy.dll NDesk.Options.dll /internalize:internalize_exclusions.txt tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:library /out:$build_artifacts_dir\dbdeploy.NAnt.dll dbdeploy.NAnt.ilmerge.dll NAnt.Core.dll Net.Sf.Dbdeploy.dll /internalize:internalize_exclusions.txt tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:library /out:$build_artifacts_dir\dbdeploy.Powershell.dll dbdeploy.Powershell.ilmerge.dll Net.Sf.Dbdeploy.dll /internalize:internalize_exclusions.txt tools\ilmerge.exe /v4 /lib:$build_artifacts_dir /target:library /out:$build_artifacts_dir\msbuild.dbdeploy.task.dll msbuild.dbdeploy.task.ilmerge.dll Net.Sf.Dbdeploy.dll /internalize:internalize_exclusions.txt mkdir $build_artifacts_dir\console mkdir $build_artifacts_dir\powershell mkdir $build_artifacts_dir\nant mkdir $build_artifacts_dir\msbuild mkdir $build_artifacts_dir\lib mkdir $build_artifacts_dir\scripts Copy-Item -Path $build_artifacts_dir\dbdeploy.exe -Destination $build_artifacts_dir\console Copy-Item -Path $build_artifacts_dir\dbdeploy.Powershell.dll -Destination $build_artifacts_dir\powershell Copy-Item -Path $build_artifacts_dir\dbdeploy.NAnt.dll -Destination $build_artifacts_dir\nant Copy-Item -Path $build_artifacts_dir\msbuild.dbdeploy.task.dll -Destination $build_artifacts_dir\msbuild Copy-Item -Path $build_artifacts_dir\Net.Sf.Dbdeploy.dll -Destination $build_artifacts_dir\lib Copy-Item -Path $scripts_dir\*.sql -Destination $build_artifacts_dir\scripts Get-ChildItem build -Exclude console,msbuild,nant,powershell,scripts,lib |Remove-Item -recurse Write-Host "Creating packages" -ForegroundColor Green Get-ChildItem $build_artifacts_dir\ -recurse | Write-Zip -IncludeEmptyDirectories -EntryPathRoot "build" -OutputPath $package_dir\dbdeploy.net-$version.zip nuget pack dbdeploy.net.nuspec -version $version -OutputDirectory $package_dir -Verbosity quiet git checkout .\src\SolutionVersionAssemblyInfo.cs Write-Host "Package created at $package_dir\dbdeploy.net-$version.zip" -ForegroundColor Green Write-Host "Nuget package created at $package_dir\dbdeploy.net-$version.nuget" -ForegroundColor Green } Task PublishPackage -description "Publish last packaged version " { if (-not (Test-Path $api_key_file)){ throw "Missing api username and key for bintray at '$api_key_file'. Needs to a file containing just . Grab it at https://bintray.com/profile/edit" } $latest_package = (Get-ChildItem $package_dir)[0] $version = $latest_package.BaseName.Split("-")[1] $root_api_url = "https://api.bintray.com" $api_key_contents = (Get-Content $api_key_file).Trim() $api_username = $api_key_contents.split(" ")[0] $api_key = $api_key_contents.split(" ")[1] $web_client = new-object System.Net.WebClient # force the basic auth header to avoid two trips (one for the 401 and another with the header) $basic_auth_header= [Convert]::ToBase64String([System.Text.Encoding]::Utf8.GetBytes($api_username+":"+$api_key)) $web_client.Headers["Authorization"] = "Basic "+$basic_auth_header $web_client.Uploadfile("$root_api_url/content/brunomlopes/generic/dbdeploy.NET/$version/$($latest_package.Name)", "PUT", $latest_package.FullName) $web_client.UploadData("$root_api_url/content/brunomlopes/generic/dbdeploy.NET/$version/publish", "POST", [System.Text.Encoding]::Utf8.GetBytes("{'discard':false}")) } Task Help { Write-Documentation } Task default -depends Help \ No newline at end of file diff --git a/example_scripts/Tools/nant/bin/NAnt.CompressionTasks.xml b/example_scripts/Tools/nant/bin/NAnt.CompressionTasks.xml index 9d90cb8..50c698a 100644 --- a/example_scripts/Tools/nant/bin/NAnt.CompressionTasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.CompressionTasks.xml @@ -5,9 +5,9 @@ - - Summary description for ExpandTask. - + + Summary description for ExpandTask. + @@ -42,85 +42,85 @@ - - Overwrite files, even if they are newer than the corresponding - entries in the archive. The default is . - + + Overwrite files, even if they are newer than the corresponding + entries in the archive. The default is . + - - Expands a file packed using GZip compression. - - - Expands "test.tar.gz" to "test2.tar". - - - ]]> - - + + Expands a file packed using GZip compression. + + + Expands "test.tar.gz" to "test2.tar". + + + ]]> + + - - Extracts the file from the gzip archive. - + + Extracts the file from the gzip archive. + - - The file to expand. - + + The file to expand. + - - The destination file. - + + The destination file. + - - Creates a tar file from the specified filesets. - - - Uses #ziplib (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#. - - - - Tar all files in ${build.dir} and ${doc.dir} into a file - called "backup.tar.gz", and apply gzip compression to it. - - - - - - - - - - - ]]> - - + + Creates a tar file from the specified filesets. + + + Uses #ziplib (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#. + + + + Tar all files in ${build.dir} and ${doc.dir} into a file + called "backup.tar.gz", and apply gzip compression to it. + + + + + + + + + + + ]]> + + - - Creates the tar file. - + + Creates the tar file. + - - The tar file to create. - + + The tar file to create. + - - Include empty directories in the generated tar file. The default is - . - + + Include empty directories in the generated tar file. The default is + . + - - The set of files to be included in the archive. - + + The set of files to be included in the archive. + @@ -128,39 +128,39 @@ - - Extracts files from a tar archive. - - - - Uses #ziplib - (SharpZipLib), an open source Zip/GZip library written entirely in C#. - - - - Extracts all files from a gzipped tar, preserving the directory structure. - - - ]]> - - + + Extracts files from a tar archive. + + + + Uses #ziplib + (SharpZipLib), an open source Zip/GZip library written entirely in C#. + + + + Extracts all files from a gzipped tar, preserving the directory structure. + + + ]]> + + - - Extracts the files from the archive. - + + Extracts the files from the archive. + - - The archive file to expand. - + + The archive file to expand. + - - The directory where to store the expanded file(s). The default is - the project base directory. - + + The directory where to store the expanded file(s). The default is + the project base directory. + @@ -168,143 +168,143 @@ - - Extracts files from a zip archive. - - - - Uses #ziplib - (SharpZipLib), an open source Zip/GZip library written entirely in C#. - - - - Extracts all the file from the zip, preserving the directory structure. - - - ]]> - - + + Extracts files from a zip archive. + + + + Uses #ziplib + (SharpZipLib), an open source Zip/GZip library written entirely in C#. + + + + Extracts all the file from the zip, preserving the directory structure. + + + ]]> + + - - Extracts the files from the zip file. - + + Extracts the files from the zip file. + - - The archive file to expand. - + + The archive file to expand. + - - The directory where the expanded files should be stored. The - default is the project base directory. - + + The directory where the expanded files should be stored. The + default is the project base directory. + - - The character encoding that has been used for filenames inside the - zip file. The default is the system's OEM code page. - + + The character encoding that has been used for filenames inside the + zip file. The default is the system's OEM code page. + - - Creates a zip file from the specified filesets. - - - - Uses #ziplib - (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#. - - - - - Zip all files in ${build.dir} and ${doc.dir} into a file - called "backup.zip". - - - - - - - - - - - ]]> - - + + Creates a zip file from the specified filesets. + + + + Uses #ziplib + (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#. + + + + + Zip all files in ${build.dir} and ${doc.dir} into a file + called "backup.zip". + + + + + + + + + + + ]]> + + - - Creates the zip file. - + + Creates the zip file. + - - The zip file to create. - + + The zip file to create. + - - The comment for the file. - + + The comment for the file. + - - Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS. - + + Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS. + - - Desired level of compression. Possible values are 0 (STORE only) - to 9 (highest). The default is 6. - + + Desired level of compression. Possible values are 0 (STORE only) + to 9 (highest). The default is 6. + - - Include empty directories in the generated zip file. The default is - . - + + Include empty directories in the generated zip file. The default is + . + - - The set of files to be included in the archive. - + + The set of files to be included in the archive. + - - Specifies the behaviour when a duplicate file is found. The default - is . - + + Specifies the behaviour when a duplicate file is found. The default + is . + - - The character encoding to use for filenames and comment inside the - zip file. The default is the system's OEM code page. - + + The character encoding to use for filenames and comment inside the + zip file. The default is the system's OEM code page. + - - Specifies how entries with the same name should be processed. - + + Specifies how entries with the same name should be processed. + - - Overwrite existing entry with same name. - + + Overwrite existing entry with same name. + - - Preserve existing entry with the same name. - + + Preserve existing entry with the same name. + - - Report failure when two entries have the same name. - + + Report failure when two entries have the same name. + @@ -337,19 +337,19 @@ - - No compression. - + + No compression. + - - GZIP compression. - + + GZIP compression. + - - BZIP2 compression. - + + BZIP2 compression. + @@ -382,45 +382,45 @@ - - A 3 digit octal string, specify the user, group and other modes - in the standard Unix fashion. Only applies to plain files. The - default is 644. - + + A 3 digit octal string, specify the user, group and other modes + in the standard Unix fashion. Only applies to plain files. The + default is 644. + - - A 3 digit octal string, specify the user, group and other modes - in the standard Unix fashion. Only applies to directories. The - default is 755. - + + A 3 digit octal string, specify the user, group and other modes + in the standard Unix fashion. Only applies to directories. The + default is 755. + - - The username for the tar entry. - + + The username for the tar entry. + - - The user identifier (UID) for the tar entry. - + + The user identifier (UID) for the tar entry. + - - The groupname for the tar entry. - + + The groupname for the tar entry. + - - The group identifier (GID) for the tar entry. - + + The group identifier (GID) for the tar entry. + - - The top level directory prefix. If set, all file and directory paths - in the fileset will have this value prepended. Can either be a single - directory name or a "/" separated path. - + + The top level directory prefix. If set, all file and directory paths + in the fileset will have this value prepended. Can either be a single + directory name or a "/" separated path. + @@ -474,11 +474,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -511,16 +511,16 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. - - Get the total number of files that are represented by the - filesets in this collection. - + + Get the total number of files that are represented by the + filesets in this collection. + @@ -535,28 +535,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -565,11 +565,11 @@ - - The top level directory prefix. If set, all file and directory paths - in the fileset will have this value prepended. Can either be a single - directory name or a "/" separated path. - + + The top level directory prefix. If set, all file and directory paths + in the fileset will have this value prepended. Can either be a single + directory name or a "/" separated path. + @@ -623,11 +623,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -660,16 +660,16 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. - - Get the total number of files that are represented by the - filesets in this collection. - + + Get the total number of files that are represented by the + filesets in this collection. + @@ -684,28 +684,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + diff --git a/example_scripts/Tools/nant/bin/NAnt.Core.xml b/example_scripts/Tools/nant/bin/NAnt.Core.xml index b203ddf..07efaeb 100644 --- a/example_scripts/Tools/nant/bin/NAnt.Core.xml +++ b/example_scripts/Tools/nant/bin/NAnt.Core.xml @@ -11,9 +11,9 @@ - - Base class for all validator attributes. - + + Base class for all validator attributes. + @@ -36,50 +36,50 @@ cannot be converted to a . - - Indicates that property should be treated as a XML attribute for the - task. - - - Examples of how to specify task attributes - - #region Public Instance Properties - - [BuildAttribute("out", Required=true)] - public string Output { - get { return _out; } - set { _out = value; } - } - [BuildAttribute("optimize")] - [BooleanValidator()] - public bool Optimize { - get { return _optimize; } - set { _optimize = value; } - } - [BuildAttribute("warnlevel")] - [Int32Validator(0,4)] // limit values to 0-4 - public int WarnLevel { - get { return _warnLevel; } - set { _warnLevel = value; } - } - [BuildElement("sources")] - public FileSet Sources { - get { return _sources; } - set { _sources = value; } - } - - #endregion Public Instance Properties - - #region Private Instance Fields - - private string _out = null; - private bool _optimize = false; - private int _warnLevel = 4; - private FileSet _sources = new FileSet(); - - #endregion Private Instance Fields - - + + Indicates that property should be treated as a XML attribute for the + task. + + + Examples of how to specify task attributes + + #region Public Instance Properties + + [BuildAttribute("out", Required=true)] + public string Output { + get { return _out; } + set { _out = value; } + } + [BuildAttribute("optimize")] + [BooleanValidator()] + public bool Optimize { + get { return _optimize; } + set { _optimize = value; } + } + [BuildAttribute("warnlevel")] + [Int32Validator(0,4)] // limit values to 0-4 + public int WarnLevel { + get { return _warnLevel; } + set { _warnLevel = value; } + } + [BuildElement("sources")] + public FileSet Sources { + get { return _sources; } + set { _sources = value; } + } + + #endregion Public Instance Properties + + #region Private Instance Fields + + private string _out = null; + private bool _optimize = false; + private int _warnLevel = 4; + private FileSet _sources = new FileSet(); + + #endregion Private Instance Fields + + @@ -91,85 +91,85 @@ is a zero-length . - - Gets or sets the name of the XML attribute. - - - The name of the XML attribute. - + + Gets or sets the name of the XML attribute. + + + The name of the XML attribute. + - - Gets or sets a value indicating whether the attribute is required. - - - if the attribute is required; otherwise, - . The default is . - + + Gets or sets a value indicating whether the attribute is required. + + + if the attribute is required; otherwise, + . The default is . + - - Gets or sets a value indicating whether property references should - be expanded. - - - if properties should be expanded; otherwise - . The default is . - + + Gets or sets a value indicating whether property references should + be expanded. + + + if properties should be expanded; otherwise + . The default is . + - - Used to specify how this attribute will be handled as the XML is - parsed and given to the element. - - - if XML should be processed; otherwise - . The default is . - + + Used to specify how this attribute will be handled as the XML is + parsed and given to the element. + + + if XML should be processed; otherwise + . The default is . + - - Indicates that property should be treated as a XML arrayList - - - - Should only be applied to properties exposing strongly typed arrays or - strongly typed collections. - - - The XML format is like this: - - - - - - - - ]]> - - - + + Indicates that property should be treated as a XML arrayList + + + + Should only be applied to properties exposing strongly typed arrays or + strongly typed collections. + + + The XML format is like this: + + + + + + + + ]]> + + + - - Indicates that the property should be treated as an XML element and - further processing should be done. - - - - The XML format is like this: - - - - - - - ]]> - - - + + Indicates that the property should be treated as an XML element and + further processing should be done. + + + + The XML format is like this: + + + + + + + ]]> + + + @@ -181,31 +181,31 @@ is a zero-length . - - Gets or sets the name of the attribute. - - - The name of the attribute. - + + Gets or sets the name of the attribute. + + + The name of the attribute. + - - Gets or sets a value indicating whether the attribute is required. - - - if the attribute is required; otherwise, - . The default is . - + + Gets or sets a value indicating whether the attribute is required. + + + if the attribute is required; otherwise, + . The default is . + - - Used to specify how this element will be handled as the XML is parsed - and given to the element. - - - if XML should be processed; otherwise - . The default is . - + + Used to specify how this element will be handled as the XML is parsed + and given to the element. + + + if XML should be processed; otherwise + . The default is . + @@ -235,31 +235,31 @@ is . - - Indicates that the property should be treated as a container for a - collection of build elements. - - - - Should only be applied to properties exposing strongly typed arrays or - strongly typed collections. - - - The XML format is like this: - - - - - - - - - - ]]> - - - + + Indicates that the property should be treated as a container for a + collection of build elements. + + + + Should only be applied to properties exposing strongly typed arrays or + strongly typed collections. + + + The XML format is like this: + + + + + + + + + + ]]> + + + @@ -272,15 +272,15 @@ is a zero-length . - - The name of the child element within the collection. - - - The name to check for in the XML of the elements in the collection. - - - This can be used for validation and schema generation. - + + The name of the child element within the collection. + + + The name to check for in the XML of the elements in the collection. + + + This can be used for validation and schema generation. + @@ -302,14 +302,14 @@ cannot be converted to a . - - Indicates that class should be treated as a NAnt element. - - - Attach this attribute to a subclass of Element to have NAnt be able - to recognize it. The name should be short but must not confict - with any other element already in use. - + + Indicates that class should be treated as a NAnt element. + + + Attach this attribute to a subclass of Element to have NAnt be able + to recognize it. The name should be short but must not confict + with any other element already in use. + @@ -321,18 +321,18 @@ is a zero-length . - - Gets or sets the name of the element. - - - The name of the element. - + + Gets or sets the name of the element. + + + The name of the element. + - - Indicates that a property should be treated as a XML file set for the - task. - + + Indicates that a property should be treated as a XML file set for the + task. + @@ -344,24 +344,24 @@ is a zero-length . - - Indicates that the value of the property to which the attribute is - assigned, can be configured on the framework-level in the NAnt application - configuration file. - - - - The following example shows a property of which the value can be - configured for a specific framework in the NAnt configuration file. - - - [FrameworkConfigurable("exename", Required=true)] - public virtual string ExeName { - get { return _exeName; } - set { _exeName = value; } - } - - + + Indicates that the value of the property to which the attribute is + assigned, can be configured on the framework-level in the NAnt application + configuration file. + + + + The following example shows a property of which the value can be + configured for a specific framework in the NAnt configuration file. + + + [FrameworkConfigurable("exename", Required=true)] + public virtual string ExeName { + get { return _exeName; } + set { _exeName = value; } + } + + @@ -373,30 +373,30 @@ is a zero-length . - - Gets or sets the name of the framework configuration attribute. - - The name of the framework configuration attribute. + + Gets or sets the name of the framework configuration attribute. + + The name of the framework configuration attribute. - - Gets or sets a value indicating whether the configuration attribute - is required. - - - if the configuration attribute is required; - otherwise, . The default is . - + + Gets or sets a value indicating whether the configuration attribute + is required. + + + if the configuration attribute is required; + otherwise, . The default is . + - - Gets or sets a value indicating whether property references should - be expanded. - - - if properties should be expanded; otherwise - . The default is . - + + Gets or sets a value indicating whether property references should + be expanded. + + + if properties should be expanded; otherwise + . The default is . + @@ -418,12 +418,12 @@ is a zero-length . - - Gets or sets the name of the function. - - - The name of the function. - + + Gets or sets the name of the function. + + + The name of the function. + @@ -453,23 +453,23 @@ - - Gets or sets the category of the function set. - - - The name of the category of the function set. - - - This will be displayed in the user docs. - + + Gets or sets the category of the function set. + + + The name of the category of the function set. + + + This will be displayed in the user docs. + - - Gets or sets the prefix of all functions in this function set. - - - The prefix of the functions in this function set. - + + Gets or sets the prefix of all functions in this function set. + + + The prefix of the functions in this function set. + @@ -526,30 +526,30 @@ - - The base of the number to validate, which must be 2, 8, 10, or 16. - - - The base of the number to validate. - - - The default is 10. - + + The base of the number to validate, which must be 2, 8, 10, or 16. + + + The base of the number to validate. + + + The default is 10. + - - Defines possible locations in which a task executable can be located. - + + Defines possible locations in which a task executable can be located. + - - Locates the task executable in the current Framework directory. - + + Locates the task executable in the current Framework directory. + - - Locates the task executable in the current Framework SDK directory. - + + Locates the task executable in the current Framework SDK directory. + @@ -605,15 +605,15 @@ is an empty string value and is set to . - - Gets or sets a value indicating whether an empty string or - should be a considered a valid value. - - - if an empty string or - should be considered a valid value; otherwise, . - The default is . - + + Gets or sets a value indicating whether an empty string or + should be a considered a valid value. + + + if an empty string or + should be considered a valid value; otherwise, . + The default is . + @@ -625,38 +625,38 @@ - - An optional error message that can be used to better describe the - regular expression error. - + + An optional error message that can be used to better describe the + regular expression error. + - - Indicates that property should be treated as a XML attribute for the - task. - - - Examples of how to specify task attributes - - // task XmlType default is string - [TaskAttribute("out", Required=true)] - string _out = null; // assign default value here - [TaskAttribute("optimize")] - [BooleanValidator()] - // during ExecuteTask you can safely use Convert.ToBoolean(_optimize) - string _optimize = Boolean.FalseString; - [TaskAttribute("warnlevel")] - [Int32Validator(0,4)] // limit values to 0-4 - // during ExecuteTask you can safely use Convert.ToInt32(_optimize) - string _warnlevel = "0"; - [BuildElement("sources")] - FileSet _sources = new FileSet(); - - NOTE: Attribute values must be of type of string if you want - to be able to have macros. The field stores the exact value during - Initialize. Just before ExecuteTask is called NAnt will expand - all the macros with the current values. - + + Indicates that property should be treated as a XML attribute for the + task. + + + Examples of how to specify task attributes + + // task XmlType default is string + [TaskAttribute("out", Required=true)] + string _out = null; // assign default value here + [TaskAttribute("optimize")] + [BooleanValidator()] + // during ExecuteTask you can safely use Convert.ToBoolean(_optimize) + string _optimize = Boolean.FalseString; + [TaskAttribute("warnlevel")] + [Int32Validator(0,4)] // limit values to 0-4 + // during ExecuteTask you can safely use Convert.ToInt32(_optimize) + string _warnlevel = "0"; + [BuildElement("sources")] + FileSet _sources = new FileSet(); + + NOTE: Attribute values must be of type of string if you want + to be able to have macros. The field stores the exact value during + Initialize. Just before ExecuteTask is called NAnt will expand + all the macros with the current values. + @@ -668,14 +668,14 @@ is a zero-length . - - Indicates that class should be treated as a task. - - - Attach this attribute to a subclass of Task to have NAnt be able - to recognize it. The name should be short but must not confict - with any other task already in use. - + + Indicates that class should be treated as a task. + + + Attach this attribute to a subclass of Task to have NAnt be able + to recognize it. The name should be short but must not confict + with any other task already in use. + @@ -687,15 +687,15 @@ is a zero-length . - - Models a NAnt XML element in the build file. - - - - Automatically validates attributes in the element based on attributes - applied to members in derived classes. - - + + Models a NAnt XML element in the build file. + + + + Automatically validates attributes in the element based on attributes + applied to members in derived classes. + + @@ -710,30 +710,30 @@ The element that should be used to create a new instance of the class. - - Performs default initialization. - - - Derived classes that wish to add custom initialization should override - the method. - + + Performs default initialization. + + + Derived classes that wish to add custom initialization should override + the method. + - - Retrieves the location in the build file where the element is - defined. - - The element's build file location + + Retrieves the location in the build file where the element is + defined. + + The element's build file location - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the project. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the project. + @@ -747,11 +747,11 @@ - - Derived classes should override to this method to provide extra - initialization and validation not covered by the base class. - - The XML node of the element to use for initialization. + + Derived classes should override to this method to provide extra + initialization and validation not covered by the base class. + + The XML node of the element to use for initialization. @@ -770,33 +770,33 @@ - - Performs initialization using the given set of properties. - + + Performs initialization using the given set of properties. + - - Initializes all build attributes and child elements. - + + Initializes all build attributes and child elements. + - - Locates the XML node for the specified attribute in the project - configuration node. - - The name of attribute for which the XML configuration node should be located. - The framework to use to obtain framework specific information, or if no framework specific information should be used. - - The XML configuration node for the specified attribute, or - if no corresponding XML node could be - located. - - - If there's a valid current framework, the configuration section for - that framework will first be searched. If no corresponding - configuration node can be located in that section, the framework-neutral - section of the project configuration node will be searched. - + + Locates the XML node for the specified attribute in the project + configuration node. + + The name of attribute for which the XML configuration node should be located. + The framework to use to obtain framework specific information, or if no framework specific information should be used. + + The XML configuration node for the specified attribute, or + if no corresponding XML node could be + located. + + + If there's a valid current framework, the configuration section for + that framework will first be searched. If no corresponding + configuration node can be located in that section, the framework-neutral + section of the project configuration node will be searched. + @@ -824,12 +824,12 @@ - - Gets the name of the XML element used to initialize this element. - - - The name of the XML element used to initialize this element. - + + Gets the name of the XML element used to initialize this element. + + + The name of the XML element used to initialize this element. + @@ -861,21 +861,21 @@ - - Gets or sets the XML node of the element. - - - The XML node of the element. - + + Gets or sets the XML node of the element. + + + The XML node of the element. + - - Gets or sets the location in the build file where the element is - defined. - - - The location in the build file where the element is defined. - + + Gets or sets the location in the build file where the element is + defined. + + + The location in the build file where the element is defined. + @@ -955,10 +955,10 @@ - - Holds the dictionary that should be used for property - expansion. - + + Holds the dictionary that should be used for property + expansion. + @@ -969,21 +969,21 @@ - - Holds the names of the attributes that still need to be - processed. - + + Holds the names of the attributes that still need to be + processed. + - - Holds the names of the child nodes that still need to be - processed. - + + Holds the names of the child nodes that still need to be + processed. + - - Holds the logger for the current class. - + + Holds the logger for the current class. + @@ -1003,9 +1003,9 @@ - - Internal interface used for setting element attributes. - + + Internal interface used for setting element attributes. + @@ -1017,27 +1017,27 @@ - - The base of the directory of this dirlist. The default is the project - base directory. - + + The base of the directory of this dirlist. The default is the project + base directory. + - - Gets the collection of environment variables that should be passed - to external programs that are launched. - - - - The collection of environment variables that should be passed - to external programs that are launched. - - + + Gets the collection of environment variables that should be passed + to external programs that are launched. + + + + The collection of environment variables that should be passed + to external programs that are launched. + + - - The command-line arguments for the runtime engine. - + + The command-line arguments for the runtime engine. + @@ -1140,81 +1140,81 @@ is . - - Functions as a chainable TextReader - - - Implements a abstraction over a TextReader that allows the class to represent - either a TextReader or another ChainableReader to which it is chained. - By passing a ChainableReader as a constructor paramater it is possiable to - chain many ChainableReaders together. The last ChainableReader in the chain must - be based on a TextReader. - + + Functions as a chainable TextReader + + + Implements a abstraction over a TextReader that allows the class to represent + either a TextReader or another ChainableReader to which it is chained. + By passing a ChainableReader as a constructor paramater it is possiable to + chain many ChainableReaders together. The last ChainableReader in the chain must + be based on a TextReader. + - - Makes it so all calls to Read and Peek are passed the ChainableReader - passed as a parameter. - - ChainableReader to forward calls to + + Makes it so all calls to Read and Peek are passed the ChainableReader + passed as a parameter. + + ChainableReader to forward calls to - - Makes it so all calls to Read and Peek are passed the TextReader - passed as a parameter. - - TextReader to forward calls to + + Makes it so all calls to Read and Peek are passed the TextReader + passed as a parameter. + + TextReader to forward calls to - - Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor. - - Character or -1 if end of stream + + Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor. + + Character or -1 if end of stream - - Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor. - - - Character or -1 if end of stream. - + + Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor. + + + Character or -1 if end of stream. + - - Closes the reader. - + + Closes the reader. + - - Calls close and supresses the finalizer for the object. - + + Calls close and supresses the finalizer for the object. + - - Gets a value indicating if the reader is backed by a stream in the - chain. - - - if the reader is backed by a stream; - otherwise, . - + + Gets a value indicating if the reader is backed by a stream in the + chain. + + + if the reader is backed by a stream; + otherwise, . + - - Allows a file's content to be modified while performing an operation. - + + Allows a file's content to be modified while performing an operation. + - - Called after construction and after properties are set. Allows - for filter initialization. - + + Called after construction and after properties are set. Allows + for filter initialization. + - - If then the filter will be used; otherwise, - skipped. The default is . - + + If then the filter will be used; otherwise, + skipped. The default is . + @@ -1329,11 +1329,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -1366,10 +1366,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -1390,28 +1390,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -1470,15 +1470,15 @@ - - Provides the abstract base class for types. - + + Provides the abstract base class for types. + - - Should be overridden by derived classes. clones the referenced types - data into the current instance. - + + Should be overridden by derived classes. clones the referenced types + data into the current instance. + @@ -1487,14 +1487,14 @@ - - The ID used to be referenced later. - + + The ID used to be referenced later. + - - The ID to use as the reference. - + + The ID to use as the reference. + @@ -1507,12 +1507,12 @@ - - Gets the name of the datatype. - - - The name of the datatype. - + + Gets the name of the datatype. + + + The name of the datatype. + @@ -1537,21 +1537,21 @@ - - The filters to apply. - + + The filters to apply. + - - The encoding to assume when filter-copying files. The default is - system's current ANSI code page. - + + The encoding to assume when filter-copying files. The default is + system's current ANSI code page. + - - Configurator that initializes filters in the order in which they've - been specified in the build file. - + + Configurator that initializes filters in the order in which they've + been specified in the build file. + @@ -1605,11 +1605,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -1642,10 +1642,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -1660,28 +1660,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -1718,43 +1718,43 @@ - - Holds data for expression expansion between input and output. - + + Holds data for expression expansion between input and output. + - - Called after construction and after properties are set. Allows - for filter initialization. - + + Called after construction and after properties are set. Allows + for filter initialization. + - - Reads the next character applying the filter logic. - - Char as an int or -1 if at the end of the stream + + Reads the next character applying the filter logic. + + Char as an int or -1 if at the end of the stream - - Reads the next character applying the filter logic without advancing the current position in the stream. - - Char as an int or -1 if at the end of the stream + + Reads the next character applying the filter logic without advancing the current position in the stream. + + Char as an int or -1 if at the end of the stream - - Moves to the next character. - + + Moves to the next character. + - - Refills the buffer, running our input through - .) - + + Refills the buffer, running our input through + .) + - - Determines whether we've passed the end of our data. - + + Determines whether we've passed the end of our data. + @@ -1799,46 +1799,46 @@ - - Construct that allows this filter to be chained to the one - in the parameter chainedReader. - - Filter that the filter will be chained to + + Construct that allows this filter to be chained to the one + in the parameter chainedReader. + + Filter that the filter will be chained to - - Reads the next character applying the filter logic. - - Char as an int or -1 if at the end of the stream + + Reads the next character applying the filter logic. + + Char as an int or -1 if at the end of the stream - - Reads the next character applying the filter logic without - advancing the current position in the stream. - Peek currently is not supported. - - - Char as an int or -1 if at the end of the stream. - + + Reads the next character applying the filter logic without + advancing the current position in the stream. + Peek currently is not supported. + + + Char as an int or -1 if at the end of the stream. + - - - Helper function used to search for the filter's traget string. If the string - is found the result is true. If the string was not found false is returned and - nonMatchingChars contains the characters that were read to determine if the - string is present. - - - - It is assumed the stream is positioned at the character after the first character - in the target string. - - - First character in target string - Ture if the stream ended while search for the string. - Characters that were read while searching for the string. - + + + Helper function used to search for the filter's traget string. If the string + is found the result is true. If the string was not found false is returned and + nonMatchingChars contains the characters that were read to determine if the + string is present. + + + + It is assumed the stream is positioned at the character after the first character + in the target string. + + + First character in target string + Ture if the stream ended while search for the string. + Characters that were read while searching for the string. + @@ -1849,35 +1849,35 @@ Char as an int or -1 if at the end of the stream - - Compares to characters taking into account the _ignoreCase flag. - - - - + + Compares to characters taking into account the _ignoreCase flag. + + + + - - The string to be replaced. - + + The string to be replaced. + - - The new value for the replaced string. - Am empty string is permissible. - + + The new value for the replaced string. + Am empty string is permissible. + - - Determines if case will be ignored. - The default is . - + + Determines if case will be ignored. + The default is . + - - Delegate for Read and Peek. Allows the same implementation - to be used for both methods. - + + Delegate for Read and Peek. Allows the same implementation + to be used for both methods. + @@ -1929,42 +1929,42 @@ - - Construct that allows this filter to be chained to the one - in the parameter chainedReader. - - Filter that the filter will be chained to + + Construct that allows this filter to be chained to the one + in the parameter chainedReader. + + Filter that the filter will be chained to - - Reads the next character applying the filter logic. - - Char as an int or -1 if at the end of the stream + + Reads the next character applying the filter logic. + + Char as an int or -1 if at the end of the stream - - Reads the next character applying the filter logic without - advancing the current position in the stream. - Peek currently is not supported. - - - Char as an int or -1 if at the end of the stream. - + + Reads the next character applying the filter logic without + advancing the current position in the stream. + Peek currently is not supported. + + + Char as an int or -1 if at the end of the stream. + - - Initialize the filter by setting its parameters. - + + Initialize the filter by setting its parameters. + - - Finds a token give that we are positioned at a beginning token character. Either a - token replacement is returned or the characters that were read looking for the token. - - A token was not found - A token was found by there is no replacement - The stream ended while looking for the token - Either the replacement token or the characters that were read looking for the token + + Finds a token give that we are positioned at a beginning token character. Either a + token replacement is returned or the characters that were read looking for the token. + + A token was not found + A token was found by there is no replacement + The stream ended while looking for the token + Either the replacement token or the characters that were read looking for the token @@ -1984,31 +1984,31 @@ - - Marks the beginning of a token. The default is "@". - + + Marks the beginning of a token. The default is "@". + - - Marks the end of a token. The default is "@". - + + Marks the end of a token. The default is "@". + - - Tokens and replacement values. - + + Tokens and replacement values. + - - Determines if case will be ignored. - The default is . - + + Determines if case will be ignored. + The default is . + - - Delegate for Read and Peek. Allows the same implementation - to be used for both methods. - + + Delegate for Read and Peek. Allows the same implementation + to be used for both methods. + @@ -2033,24 +2033,24 @@ - - Construct that allows this filter to be chained to the one - in the parameter chainedReader. - - Filter that the filter will be chained to + + Construct that allows this filter to be chained to the one + in the parameter chainedReader. + + Filter that the filter will be chained to - - Retrieves the next character with moving the position in the stream. - This method is not implemented - - -1 if end of stream otherwise a character + + Retrieves the next character with moving the position in the stream. + This method is not implemented + + -1 if end of stream otherwise a character - - Retrieves the next character in the stream. - - -1 if end of stream otherwise a character + + Retrieves the next character in the stream. + + -1 if end of stream otherwise a character @@ -2061,21 +2061,21 @@ Char as an int or -1 if at the end of the stream - - The number of spaces used when converting a tab. The default is - "8". - + + The number of spaces used when converting a tab. The default is + "8". + - - Delegate for Read and Peek. Allows the same implementation - to be used for both methods. - + + Delegate for Read and Peek. Allows the same implementation + to be used for both methods. + - - Functions to return information for a given assembly. - + + Functions to return information for a given assembly. + @@ -2124,13 +2124,13 @@ - - Gets the full name of the assembly, also known as the display name. - - The assembly to get the full name for. - - The full name of the assembly, also known as the display name. - + + Gets the full name of the assembly, also known as the display name. + + The assembly to get the full name for. + + The full name of the assembly, also known as the display name. + @@ -2143,19 +2143,19 @@ - - Gets the physical location, in codebase format, of the loaded file - that contains the manifest. - - The assembly to get the location for. - - The location of the specified assembly. - + + Gets the physical location, in codebase format, of the loaded file + that contains the manifest. + + The assembly to get the location for. + + The location of the specified assembly. + - - Functions that return information about an assembly's identity. - + + Functions that return information about an assembly's identity. + @@ -2291,49 +2291,49 @@ - - Converts the argument to an integer. - - value to be converted - converted to integer. The function fails with an exception when the conversion is not possible. + + Converts the argument to an integer. + + value to be converted + converted to integer. The function fails with an exception when the conversion is not possible. - - Converts the argument to double - - The value to be converted. - converted to double. The function fails with an exception when the conversion is not possible. + + Converts the argument to double + + The value to be converted. + converted to double. The function fails with an exception when the conversion is not possible. - - Converts the argument to a string. - - The value to be converted. - - converted to string. The function fails - with an exception when the conversion is not possible. - - - Named method ConvertToString as a static ToString method would break - CLS compliance. - + + Converts the argument to a string. + + The value to be converted. + + converted to string. The function fails + with an exception when the conversion is not possible. + + + Named method ConvertToString as a static ToString method would break + CLS compliance. + - - Converts the argument to a datetime. - - value to be converted - converted to datetime. The function fails with an exception when the conversion is not possible. + + Converts the argument to a datetime. + + value to be converted + converted to datetime. The function fails with an exception when the conversion is not possible. - - Converts the argument to a boolean - - The string value to be converted to boolean. Must be 'true' or 'false'. - - converted to boolean. The function fails - with an exception when the conversion is not possible. - + + Converts the argument to a boolean + + The string value to be converted to boolean. Must be 'true' or 'false'. + + converted to boolean. The function fails + with an exception when the conversion is not possible. + @@ -2345,96 +2345,96 @@ - - Gets the year component of the specified date. - - The date of which to get the year component. - - The year, between 1 and 9999. - + + Gets the year component of the specified date. + + The date of which to get the year component. + + The year, between 1 and 9999. + - - Gets the month component of the specified date. - - The date of which to get the month component. - - The month, between 1 and 12. - + + Gets the month component of the specified date. + + The date of which to get the month component. + + The month, between 1 and 12. + - - Gets the day of the month represented by the specified date. - - The date of which to get the day of the month. - - The day value, between 1 and 31. - + + Gets the day of the month represented by the specified date. + + The date of which to get the day of the month. + + The day value, between 1 and 31. + - - Gets the hour component of the specified date. - - The date of which to get the hour component. - - The hour, between 0 and 23. - + + Gets the hour component of the specified date. + + The date of which to get the hour component. + + The hour, between 0 and 23. + - - Gets the minute component of the specified date. - - The date of which to get the minute component. - - The minute, between 0 and 59. - + + Gets the minute component of the specified date. + + The date of which to get the minute component. + + The minute, between 0 and 59. + - - Gets the seconds component of the specified date. - - The date of which to get the seconds component. - - The seconds, between 0 and 59. - + + Gets the seconds component of the specified date. + + The date of which to get the seconds component. + + The seconds, between 0 and 59. + - - Gets the milliseconds component of the specified date. - - The date of which to get the milliseconds component. - - The millisecond, between 0 and 999. - + + Gets the milliseconds component of the specified date. + + The date of which to get the milliseconds component. + + The millisecond, between 0 and 999. + - - Gets the number of ticks that represent the specified date. - - The date of which to get the number of ticks. - - The number of ticks that represent the date and time of the - specified date. - + + Gets the number of ticks that represent the specified date. + + The date of which to get the number of ticks. + + The number of ticks that represent the date and time of the + specified date. + - - Gets the day of the week represented by the specified date. - - The date of which to get the day of the week. - - The day of the week, ranging from zero, indicating Sunday, to six, - indicating Saturday. - + + Gets the day of the week represented by the specified date. + + The date of which to get the day of the week. + + The day of the week, ranging from zero, indicating Sunday, to six, + indicating Saturday. + - - Gets the day of the year represented by the specified date. - - The date of which to get the day of the year. - - The day of the year, between 1 and 366. - + + Gets the day of the year represented by the specified date. + + The date of which to get the day of the year. + + The day of the year, between 1 and 366. + @@ -2450,14 +2450,14 @@ is less than 1 or greater than 12. - - Returns an indication whether the specified year is a leap year. - - A 4-digit year. - - if is a leap year; - otherwise, . - + + Returns an indication whether the specified year is a leap year. + + A 4-digit year. + + if is a leap year; + otherwise, . + @@ -2491,9 +2491,9 @@ - - Groups a set of functions for dealing with directories. - + + Groups a set of functions for dealing with directories. + @@ -2583,28 +2583,28 @@ The specified path, file name, or both exceed the system-defined maximum length. - - Determines whether the given path refers to an existing directory - on disk. - - The path to test. - - if refers to an - existing directory; otherwise, . - - - Remove directory "test", if it exists. - - - ]]> - - + + Determines whether the given path refers to an existing directory + on disk. + + The path to test. + + if refers to an + existing directory; otherwise, . + + + Remove directory "test", if it exists. + + + ]]> + + - - Functions for requesting information from DNS. - + + Functions for requesting information from DNS. + @@ -2648,9 +2648,9 @@ - - Provide information about the current environment and platform. - + + Provide information about the current environment and platform. + @@ -2710,27 +2710,27 @@ - - Gets the user name of the person who started the current thread. - - - The name of the person logged on to the system who started the - current thread. - - - - Modify the home directory of the current user on unix-based systems. - - - - - - - - ]]> - - + + Gets the user name of the person who started the current thread. + + + The name of the person logged on to the system who started the + current thread. + + + + Modify the home directory of the current user on unix-based systems. + + + + + + + + ]]> + + @@ -2743,28 +2743,28 @@ Environment variable does not exist. - - Gets a value indicating whether the specified environment variable - exists. - - The environment variable that should be checked. - - if the environment variable exists; otherwise, - . - - - - Execute a set of tasks only if the "BUILD_DEBUG" environment - variable is set. - - - - ... - - ]]> - - + + Gets a value indicating whether the specified environment variable + exists. + + The environment variable that should be checked. + + if the environment variable exists; otherwise, + . + + + + Execute a set of tasks only if the "BUILD_DEBUG" environment + variable is set. + + + + ... + + ]]> + + @@ -2784,26 +2784,26 @@ - - Gets the newline string defined for this environment. - - - A string containing CRLF for non-Unix platforms, or LF for Unix - platforms. - - - Output two lines in a log file. - - - ]]> - - + + Gets the newline string defined for this environment. + + + A string containing CRLF for non-Unix platforms, or LF for Unix + platforms. + + + Output two lines in a log file. + + + ]]> + + - - Groups a set of functions for dealing with files. - + + Groups a set of functions for dealing with files. + @@ -2844,24 +2844,24 @@ The parameter is in an invalid format. - - Determines whether the specified file exists. - - The file to check. - - if refers to an - existing file; otherwise, . - - - Execute a set of tasks, if file "output.xml" does not exist. - - - ... - - ]]> - - + + Determines whether the specified file exists. + + The file to check. + + if refers to an + existing file; otherwise, . + + + Execute a set of tasks, if file "output.xml" does not exist. + + + ... + + ]]> + + @@ -2900,9 +2900,9 @@ The caller does not have path discovery permission. - - Functions that provide version information for a physical file on disk. - + + Functions that provide version information for a physical file on disk. + @@ -2954,14 +2954,14 @@ - - Checks whether the specified framework exists, and is valid. - - The framework to test. - - if the specified framework exists ; otherwise, - . - + + Checks whether the specified framework exists, and is valid. + + The framework to test. + + if the specified framework exists ; otherwise, + . + @@ -2976,20 +2976,20 @@ - - Gets the identifier of the current target framework. - - - The identifier of the current target framework. - + + Gets the identifier of the current target framework. + + + The identifier of the current target framework. + - - Gets the identifier of the runtime framework. - - - The identifier of the runtime framework. - + + Gets the identifier of the runtime framework. + + + The identifier of the runtime framework. + @@ -3257,58 +3257,58 @@ - - Rounds the value to the nearest whole number - - Number to be rounded, can be anything convertible to a double. - - Rounded value. - + + Rounds the value to the nearest whole number + + Number to be rounded, can be anything convertible to a double. + + Rounded value. + - - Returns the largest whole number less than or equal to the specified - number. - - value to be , can be anything convertible to a double - - The largest whole number less than or equal to the specified number. - + + Returns the largest whole number less than or equal to the specified + number. + + value to be , can be anything convertible to a double + + The largest whole number less than or equal to the specified number. + - - Returns the smallest whole number greater than or equal to the specified number - - value - - The smallest whole number greater than or equal to the specified number. - + + Returns the smallest whole number greater than or equal to the specified number + + value + + The smallest whole number greater than or equal to the specified number. + - - Returns the absolute value of the specified number - - value to take the absolute value from - - when is greater - than or equal to zero; otherwise, -. - + + Returns the absolute value of the specified number + + value to take the absolute value from + + when is greater + than or equal to zero; otherwise, -. + - - Gets the base directory of the appdomain in which NAnt is running. - - - The base directory of the appdomain in which NAnt is running. - + + Gets the base directory of the appdomain in which NAnt is running. + + + The base directory of the appdomain in which NAnt is running. + - - Gets the NAnt assembly. - - - The NAnt assembly. - + + Gets the NAnt assembly. + + + The NAnt assembly. + @@ -3440,34 +3440,34 @@ - - Gets the base directory of the current project. - - - The base directory of the current project. - + + Gets the base directory of the current project. + + + The base directory of the current project. + - - Checks whether the specified target exists. - - The target to test. - - if the specified target exists; otherwise, - . - - - - Execute target "clean", if it exists. - - - - - - ]]> - - + + Checks whether the specified target exists. + + The target to test. + + if the specified target exists; otherwise, + . + + + + Execute target "clean", if it exists. + + + + + + ]]> + + @@ -3491,14 +3491,14 @@ Target does not exist. - - Checks whether the specified task exists. - - The task to test. - - if the specified task exists; otherwise, - . - + + Checks whether the specified task exists. + + The task to test. + + if the specified task exists; otherwise, + . + @@ -3512,29 +3512,29 @@ Task is not available. - - Checks whether the specified property exists. - - The property to test. - - if the specified property exists; otherwise, - . - - - - Execute a set of tasks if the "build.debug" property - exists. - - - - - - - - ]]> - - + + Checks whether the specified property exists. + + The property to test. + + if the specified property exists; otherwise, + . + + + + Execute a set of tasks if the "build.debug" property + exists. + + + + + + + + ]]> + + @@ -3569,45 +3569,45 @@ - - Gets the name of the platform on which NAnt is running. - - - The name of the platform on which NAnt is running. - + + Gets the name of the platform on which NAnt is running. + + + The name of the platform on which NAnt is running. + - - Checks whether NAnt is running on Windows (and not just 32-bit Windows - as the name may lead you to believe). - - - if NAnt is running on Windows; - otherwise, . - + + Checks whether NAnt is running on Windows (and not just 32-bit Windows + as the name may lead you to believe). + + + if NAnt is running on Windows; + otherwise, . + - - Checks whether NAnt is running on Windows. - - - if NAnt is running on Windows; - otherwise, . - + + Checks whether NAnt is running on Windows. + + + if NAnt is running on Windows; + otherwise, . + - - Checks whether NAnt is running on Unix. - - - if NAnt is running on Unix; - otherwise, . - + + Checks whether NAnt is running on Unix. + + + if NAnt is running on Unix; + otherwise, . + - - Functions that return information about an operating system. - + + Functions that return information about an operating system. + @@ -3952,26 +3952,26 @@ - - Factory method to return a new instance of ExecTask - - - + + Factory method to return a new instance of ExecTask + + + - - Returns the length of the specified string. - - input string - - The string's length. - - - string::get-length('foo') ==> 3 - - - string::get-length('') ==> 0 - + + Returns the length of the specified string. + + input string + + The string's length. + + + string::get-length('foo') ==> 3 + + + string::get-length('') ==> 0 + @@ -4015,108 +4015,108 @@ - - Tests whether the specified string starts with the specified prefix - string. - - test string - prefix string - - when is a prefix for - the string . Meaning, the characters at the - beginning of are identical to - ; otherwise, . - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::starts-with('testing string', 'test') ==> true - - - string::starts-with('testing string', 'testing') ==> true - - - string::starts-with('testing string', 'string') ==> false - - - string::starts-with('test', 'testing string') ==> false - + + Tests whether the specified string starts with the specified prefix + string. + + test string + prefix string + + when is a prefix for + the string . Meaning, the characters at the + beginning of are identical to + ; otherwise, . + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::starts-with('testing string', 'test') ==> true + + + string::starts-with('testing string', 'testing') ==> true + + + string::starts-with('testing string', 'string') ==> false + + + string::starts-with('test', 'testing string') ==> false + - - Tests whether the specified string ends with the specified suffix - string. - - test string - suffix string - - when is a suffix for - the string . Meaning, the characters at the - end of are identical to - ; otherwise, . - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::ends-with('testing string', 'string') ==> true - - - string::ends-with('testing string', '') ==> true - - - string::ends-with('testing string', 'bring') ==> false - - - string::ends-with('string', 'testing string') ==> false - + + Tests whether the specified string ends with the specified suffix + string. + + test string + suffix string + + when is a suffix for + the string . Meaning, the characters at the + end of are identical to + ; otherwise, . + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::ends-with('testing string', 'string') ==> true + + + string::ends-with('testing string', '') ==> true + + + string::ends-with('testing string', 'bring') ==> false + + + string::ends-with('string', 'testing string') ==> false + - - Returns the specified string converted to lowercase. - - input string - - The string in lowercase. - - - The casing rules of the invariant culture are used to convert the - to lowercase. - - - string::to-lower('testing string') ==> 'testing string' - - - string::to-lower('Testing String') ==> 'testing string' - - - string::to-lower('Test 123') ==> 'test 123' - + + Returns the specified string converted to lowercase. + + input string + + The string in lowercase. + + + The casing rules of the invariant culture are used to convert the + to lowercase. + + + string::to-lower('testing string') ==> 'testing string' + + + string::to-lower('Testing String') ==> 'testing string' + + + string::to-lower('Test 123') ==> 'test 123' + - - Returns the specified string converted to uppercase. - - input string - - The string in uppercase. - - - The casing rules of the invariant culture are used to convert the - to uppercase. - - - string::to-upper('testing string') ==> 'TESTING STRING' - - - string::to-upper('Testing String') ==> 'TESTING STRING' - - - string::to-upper('Test 123') ==> 'TEST 123' - + + Returns the specified string converted to uppercase. + + input string + + The string in uppercase. + + + The casing rules of the invariant culture are used to convert the + to uppercase. + + + string::to-upper('testing string') ==> 'TESTING STRING' + + + string::to-upper('Testing String') ==> 'TESTING STRING' + + + string::to-upper('Test 123') ==> 'TEST 123' + @@ -4150,101 +4150,101 @@ - - Tests whether the specified string contains the given search string. - - The string to search. - The string to locate within . - - if is found in - ; otherwise, . - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::contains('testing string', 'test') ==> true - - - string::contains('testing string', '') ==> true - - - string::contains('testing string', 'Test') ==> false - - - string::contains('testing string', 'foo') ==> false - + + Tests whether the specified string contains the given search string. + + The string to search. + The string to locate within . + + if is found in + ; otherwise, . + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::contains('testing string', 'test') ==> true + + + string::contains('testing string', '') ==> true + + + string::contains('testing string', 'Test') ==> false + + + string::contains('testing string', 'foo') ==> false + - - Returns the position of the first occurrence in the specified string - of the given search string. - - The string to search. - The string to locate within . - - - The lowest-index position of in - if it is found, or -1 if - does not contain . - - - If is an empty string, the return value - will always be 0. - - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::index-of('testing string', 'test') ==> 0 - - - string::index-of('testing string', '') ==> 0 - - - string::index-of('testing string', 'Test') ==> -1 - - - string::index-of('testing string', 'ing') ==> 4 - + + Returns the position of the first occurrence in the specified string + of the given search string. + + The string to search. + The string to locate within . + + + The lowest-index position of in + if it is found, or -1 if + does not contain . + + + If is an empty string, the return value + will always be 0. + + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::index-of('testing string', 'test') ==> 0 + + + string::index-of('testing string', '') ==> 0 + + + string::index-of('testing string', 'Test') ==> -1 + + + string::index-of('testing string', 'ing') ==> 4 + - - Returns the position of the last occurrence in the specified string - of the given search string. - - The string to search. - The string to locate within . - - - The highest-index position of in - if it is found, or -1 if - does not contain . - - - If is an empty string, the return value - is the last index position in . - - - - This function performs a case-sensitive word search using the - invariant culture. - - - string::last-index-of('testing string', 'test') ==> 0 - - - string::last-index-of('testing string', '') ==> 13 - - - string::last-index-of('testing string', 'Test') ==> -1 - - - string::last-index-of('testing string', 'ing') ==> 11 - + + Returns the position of the last occurrence in the specified string + of the given search string. + + The string to search. + The string to locate within . + + + The highest-index position of in + if it is found, or -1 if + does not contain . + + + If is an empty string, the return value + is the last index position in . + + + + This function performs a case-sensitive word search using the + invariant culture. + + + string::last-index-of('testing string', 'test') ==> 0 + + + string::last-index-of('testing string', '') ==> 13 + + + string::last-index-of('testing string', 'Test') ==> -1 + + + string::last-index-of('testing string', 'ing') ==> 11 + @@ -4311,52 +4311,52 @@ - - Returns the given string trimmed of whitespace. - - input string - - The string with any leading or trailing - white space characters removed. - - - string::trim(' test ') ==> 'test' - - - string::trim('\t\tfoo \r\n') ==> 'foo' - + + Returns the given string trimmed of whitespace. + + input string + + The string with any leading or trailing + white space characters removed. + + + string::trim(' test ') ==> 'test' + + + string::trim('\t\tfoo \r\n') ==> 'foo' + - - Returns the given string trimmed of leading whitespace. - - input string - - The string with any leading - whites pace characters removed. - - - string::trim-start(' test ') ==> 'test ' - - - string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n' - + + Returns the given string trimmed of leading whitespace. + + input string + + The string with any leading + whites pace characters removed. + + + string::trim-start(' test ') ==> 'test ' + + + string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n' + - - Returns the given string trimmed of trailing whitespace. - - input string - - The string with any trailing - white space characters removed. - - - string::trim-end(' test ') ==> ' test' - - - string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo' - + + Returns the given string trimmed of trailing whitespace. + + input string + + The string with any trailing + white space characters removed. + + + string::trim-end(' test ') ==> ' test' + + + string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo' + @@ -4703,17 +4703,17 @@ - - Provides the abstract base class for tasks. - - - A task is a piece of code that can be executed. - + + Provides the abstract base class for tasks. + + + A task is a piece of code that can be executed. + - - Executes the task unless it is skipped. - + + Executes the task unless it is skipped. + @@ -4785,61 +4785,61 @@ - - Initializes the configuration of the task using configuration - settings retrieved from the NAnt configuration file. - - - TO-DO : Remove this temporary hack when a permanent solution is - available for loading the default values from the configuration - file if a build element is constructed from code. - + + Initializes the configuration of the task using configuration + settings retrieved from the NAnt configuration file. + + + TO-DO : Remove this temporary hack when a permanent solution is + available for loading the default values from the configuration + file if a build element is constructed from code. + - Initializes the task. + Initializes the task. - Initializes the task. + Initializes the task. - Executes the task. + Executes the task. - - Locates the XML node for the specified attribute in either the - configuration section of the extension assembly or the.project. - - The name of attribute for which the XML configuration node should be located. - The framework to use to obtain framework specific information, or if no framework specific information should be used. - - The XML configuration node for the specified attribute, or - if no corresponding XML node could be - located. - - - If there's a valid current framework, the configuration section for - that framework will first be searched. If no corresponding - configuration node can be located in that section, the framework-neutral - section of the project configuration node will be searched. - + + Locates the XML node for the specified attribute in either the + configuration section of the extension assembly or the.project. + + The name of attribute for which the XML configuration node should be located. + The framework to use to obtain framework specific information, or if no framework specific information should be used. + + The XML configuration node for the specified attribute, or + if no corresponding XML node could be + located. + + + If there's a valid current framework, the configuration section for + that framework will first be searched. If no corresponding + configuration node can be located in that section, the framework-neutral + section of the project configuration node will be searched. + - - Determines if task failure stops the build, or is just reported. - The default is . - + + Determines if task failure stops the build, or is just reported. + The default is . + - - Determines whether the task should report detailed build log messages. - The default is . - + + Determines whether the task should report detailed build log messages. + The default is . + - - If then the task will be executed; otherwise, - skipped. The default is . - + + If then the task will be executed; otherwise, + skipped. The default is . + @@ -4849,14 +4849,14 @@ - - The name of the task. - + + The name of the task. + - - The prefix used when sending messages to the log. - + + The prefix used when sending messages to the log. + @@ -4880,42 +4880,42 @@ - - The name of the file which will have its attributes set. This is - provided as an alternate to using the task's fileset. - + + The name of the file which will have its attributes set. This is + provided as an alternate to using the task's fileset. + - - All the matching files and directories in this fileset will have - their attributes set. - + + All the matching files and directories in this fileset will have + their attributes set. + - - Set the archive attribute. The default is . - + + Set the archive attribute. The default is . + - - Set the hidden attribute. The default is . - - + + Set the hidden attribute. The default is . + + - - Set the normal file attributes. This attribute is only valid if used - alone. The default is . - + + Set the normal file attributes. This attribute is only valid if used + alone. The default is . + - - Set the read-only attribute. The default is . - + + Set the read-only attribute. The default is . + - - Set the system attribute. The default is . - + + Set the system attribute. The default is . + @@ -5064,44 +5064,44 @@ - - The resource which must be available. - + + The resource which must be available. + - - The type of resource which must be present. - + + The type of resource which must be present. + - - The property that must be set if the resource is available. - + + The property that must be set if the resource is available. + - - Defines the possible resource checks. - + + Defines the possible resource checks. + - - Determines whether a given file exists. - + + Determines whether a given file exists. + - - Determines whether a given directory exists. - + + Determines whether a given directory exists. + - - Determines whether a given framework is available. - + + Determines whether a given framework is available. + - - Determines whether a given SDK is available. - + + Determines whether a given SDK is available. + @@ -5221,9 +5221,9 @@ - - Executes the specified target. - + + Executes the specified target. + @@ -5232,21 +5232,21 @@ - - NAnt target to call. - + + NAnt target to call. + - - Force an execute even if the target has already been executed. The - default is . - + + Force an execute even if the target has already been executed. The + default is . + - - Execute the specified targets dependencies -- even if they have been - previously executed. The default is . - + + Execute the specified targets dependencies -- even if they have been + previously executed. The default is . + @@ -5354,9 +5354,9 @@ - - Checks whether the task is initialized with valid attributes. - + + Checks whether the task is initialized with valid attributes. + @@ -5365,30 +5365,30 @@ A file that has to be copied does not exist or could not be copied. - - Actually does the file copies. - + + Actually does the file copies. + - - The file to copy. - + + The file to copy. + - - The file to copy to. - + + The file to copy to. + - - The directory to copy to. - + + The directory to copy to. + - - Overwrite existing files even if the destination files are newer. - The default is . - + + Overwrite existing files even if the destination files are newer. + The default is . + @@ -5410,21 +5410,21 @@ - - Chain of filters used to alter the file's content as it is copied. - + + Chain of filters used to alter the file's content as it is copied. + - - The encoding to use when reading files. The default is the system's - current ANSI code page. - + + The encoding to use when reading files. The default is the system's + current ANSI code page. + - - The encoding to use when writing the files. The default is - the encoding of the input file. - + + The encoding to use when writing the files. The default is + the encoding of the input file. + @@ -5444,9 +5444,9 @@ - - Holds the absolute paths and last write time of a given file. - + + Holds the absolute paths and last write time of a given file. + @@ -5457,20 +5457,20 @@ The last write time of the file. - - Gets the absolute path of the current file. - - - The absolute path of the current file. - + + Gets the absolute path of the current file. + + + The absolute path of the current file. + - - Gets the time when the current file was last written to. - - - The time when the current file was last written to. - + + Gets the time when the current file was last written to. + + + The time when the current file was last written to. + @@ -5532,19 +5532,19 @@ - - Ensures the supplied attributes are valid. - + + Ensures the supplied attributes are valid. + - - The file to delete. - + + The file to delete. + - - The directory to delete. - + + The directory to delete. + @@ -5553,28 +5553,28 @@ - - All the files in the file set will be deleted. - + + All the files in the file set will be deleted. + - - Controls whether to show the name of each deleted file or directory. - The default is . - + + Controls whether to show the name of each deleted file or directory. + The default is . + - - An empty task that allows a build file to contain a description. - - - Set a description. - - This is a description. - ]]> - - + + An empty task that allows a build file to contain a description. + + + Set a description. + + This is a description. + ]]> + + @@ -5663,33 +5663,33 @@ - - Outputs the message to the build log or the specified file. - + + Outputs the message to the build log or the specified file. + - - The encoding to use when writing message to a file. The default is - UTF-8 encoding without a Byte Order Mark (BOM). - + + The encoding to use when writing message to a file. The default is + UTF-8 encoding without a Byte Order Mark (BOM). + - - The message to output. - + + The message to output. + - - Gets or sets the inline content that should be output. - - - The inline content that should be output. - + + Gets or sets the inline content that should be output. + + + The inline content that should be output. + - - The file to write the message to. - + + The file to write the message to. + @@ -5791,9 +5791,9 @@ - - Will be used to ensure thread-safe operations. - + + Will be used to ensure thread-safe operations. + @@ -5819,14 +5819,14 @@ The that was started. - - Reads from the stream until the external program is ended. - + + Reads from the stream until the external program is ended. + - - Reads from the stream until the external program is ended. - + + Reads from the stream until the external program is ended. + @@ -5838,53 +5838,53 @@ The task is not available or not configured for the current framework. - - The name of the executable that should be used to launch the - external program. - - - The name of the executable that should be used to launch the external - program, or if no name is specified. - - - If available, the configured value in the NAnt configuration - file will be used if no name is specified. - + + The name of the executable that should be used to launch the + external program. + + + The name of the executable that should be used to launch the external + program, or if no name is specified. + + + If available, the configured value in the NAnt configuration + file will be used if no name is specified. + - - Gets the filename of the external program to start. - - - The filename of the external program. - - - Override in derived classes to explicitly set the location of the - external tool. - + + Gets the filename of the external program to start. + + + The filename of the external program. + + + Override in derived classes to explicitly set the location of the + external tool. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Gets the file to which the standard output should be redirected. - - - The file to which the standard output should be redirected, or - if the standard output should not be - redirected. - - - The default implementation will never allow the standard output - to be redirected to a file. Deriving classes should override this - property to change this behaviour. - + + Gets the file to which the standard output should be redirected. + + + The file to which the standard output should be redirected, or + if the standard output should not be + redirected. + + + The default implementation will never allow the standard output + to be redirected to a file. Deriving classes should override this + property to change this behaviour. + @@ -5897,23 +5897,23 @@ - - Gets the working directory for the application. - - - The working directory for the application. - + + Gets the working directory for the application. + + + The working directory for the application. + - - The maximum amount of time the application is allowed to execute, - expressed in milliseconds. Defaults to no time-out. - + + The maximum amount of time the application is allowed to execute, + expressed in milliseconds. Defaults to no time-out. + - - The command-line arguments for the external program. - + + The command-line arguments for the external program. + @@ -5992,31 +5992,31 @@ - - Gets the value that the process specified when it terminated. - - - The code that the associated process specified when it terminated, - or -1000 if the process could not be started or did not - exit (in time). - + + Gets the value that the process specified when it terminated. + + + The code that the associated process specified when it terminated, + or -1000 if the process could not be started or did not + exit (in time). + - - Gets the unique identifier for the spawned application. - + + Gets the unique identifier for the spawned application. + - - Gets or sets a value indicating whether the application should be - spawned. If you spawn an application, its output will not be logged - by NAnt. The default is . - + + Gets or sets a value indicating whether the application should be + spawned. If you spawn an application, its output will not be logged + by NAnt. The default is . + - - Gets the command-line arguments, separated by spaces. - + + Gets the command-line arguments, separated by spaces. + @@ -6025,18 +6025,18 @@ does not hold a valid file name. - - Executes the external program. - + + Executes the external program. + - - The program to execute without command arguments. - - - The path will not be evaluated to a full path using the project - base directory. - + + The program to execute without command arguments. + + + The path will not be evaluated to a full path using the project + base directory. + @@ -6047,24 +6047,24 @@ - - Environment variables to pass to the program. - + + Environment variables to pass to the program. + - - The directory in which the command will be executed. - - - The directory in which the command will be executed. The default - is the project's base directory. - - - - The working directory will be evaluated relative to the project's - base directory if it is relative. - - + + The directory in which the command will be executed. + + + The directory in which the command will be executed. The default + is the project's base directory. + + + + The working directory will be evaluated relative to the project's + base directory if it is relative. + + @@ -6080,64 +6080,64 @@ - - Specifies whether the external program should be executed using a - runtime engine, if configured. The default is . - - - if the external program should be executed - using a runtime engine; otherwise, . - + + Specifies whether the external program should be executed using a + runtime engine, if configured. The default is . + + + if the external program should be executed + using a runtime engine; otherwise, . + - - Specifies whether the external program is a managed application - which should be executed using a runtime engine, if configured. - The default is . - - - if the external program should be executed - using a runtime engine; otherwise, . - + + Specifies whether the external program is a managed application + which should be executed using a runtime engine, if configured. + The default is . + + + if the external program should be executed + using a runtime engine; otherwise, . + - - Gets the filename of the external program to start. - - - The filename of the external program. - + + Gets the filename of the external program to start. + + + The filename of the external program. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - The directory the program is in. - - - - The directory the program is in. The default is the project's base - directory. - - - The basedir will be evaluated relative to the project's base - directory if it is relative. - - + + The directory the program is in. + + + + The directory the program is in. The default is the project's base + directory. + + + The basedir will be evaluated relative to the project's base + directory if it is relative. + + - - The file to which the standard output will be redirected. - - - By default, the standard output is redirected to the console. - + + The file to which the standard output will be redirected. + + + By default, the standard output is redirected to the console. + @@ -6150,11 +6150,11 @@ - - Gets or sets a value indicating whether the application should be - spawned. If you spawn an application, its output will not be logged - by NAnt. The default is . - + + Gets or sets a value indicating whether the application should be + spawned. If you spawn an application, its output will not be logged + by NAnt. The default is . + @@ -6275,69 +6275,69 @@ - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Sets the timestamp of a given file to a specified time. - + + Sets the timestamp of a given file to a specified time. + - - The URL from which to retrieve a file. - + + The URL from which to retrieve a file. + - - The file where to store the retrieved file. - + + The file where to store the retrieved file. + - - If inside a firewall, proxy server/port information - Format: {proxy server name}:{port number} - Example: proxy.mycompany.com:8080 - + + If inside a firewall, proxy server/port information + Format: {proxy server name}:{port number} + Example: proxy.mycompany.com:8080 + - - The network proxy to use to access the Internet resource. - + + The network proxy to use to access the Internet resource. + - - The network credentials used for authenticating the request with - the Internet resource. - + + The network credentials used for authenticating the request with + the Internet resource. + - - Log errors but don't treat as fatal. The default is . - + + Log errors but don't treat as fatal. The default is . + - - Conditionally download a file based on the timestamp of the local - copy. HTTP only. The default is . - + + Conditionally download a file based on the timestamp of the local + copy. HTTP only. The default is . + - - The length of time, in milliseconds, until the request times out. - The default is 100000 milliseconds. - + + The length of time, in milliseconds, until the request times out. + The default is 100000 milliseconds. + - - The security certificates to associate with the request. - + + The security certificates to associate with the request. + @@ -6491,16 +6491,16 @@ - - Executes embedded tasks in the order in which they are defined. - + + Executes embedded tasks in the order in which they are defined. + - - Automatically exclude build elements that are defined on the task - from things that get executed, as they are evaluated normally during - XML task initialization. - + + Automatically exclude build elements that are defined on the task + from things that get executed, as they are evaluated normally during + XML task initialization. + @@ -6523,14 +6523,14 @@ - - The file to compare if uptodate. - + + The file to compare if uptodate. + - - The file to check against for the uptodate file. - + + The file to check against for the uptodate file. + @@ -6545,188 +6545,188 @@ - - Used to test whether a property is true. - + + Used to test whether a property is true. + - - Used to test whether a property exists. - + + Used to test whether a property exists. + - - Used to test whether a target exists. - + + Used to test whether a target exists. + - - Used to test arbitrary boolean expression. - + + Used to test arbitrary boolean expression. + - - The opposite of the if task. - - - Check that a property does not exist. - - - - - ]]> - - Check that a property value is not true. - - - - - ]]> - - - - Check that a target does not exist. - - - - - ]]> - - + + The opposite of the if task. + + + Check that a property does not exist. + + + + + ]]> + + Check that a property value is not true. + + + + + ]]> + + + + Check that a target does not exist. + + + + + ]]> + + - - Includes an external build file. - - - - This task is used to break your build file into smaller chunks. You - can load a partial build file and have it included into the build file. - - - Any global (project level) tasks in the included build file are executed - when this task is executed. Tasks in target elements are only executed - if that target is executed. - - - The project element attributes are ignored. - - - This task can only be in the global (project level) section of the - build file. - - - This task can only include files from the file system. - - - - - Include a task that fetches the project version from the - GetProjectVersion.include build file. - - - - ]]> - - - - - - Used to check for recursived includes. - - - - - Verifies parameters. - - - - - Build file to include. - - - - - Load a text file into a single property. - - - - Unless an encoding is specified, the encoding associated with the - system's current ANSI code page is used. - - - An UTF-8, little-endian Unicode, and big-endian Unicode encoded text - file is automatically recognized, if the file starts with the appropriate - byte order marks. - - - - - Load file message.txt into property "message". - - - - ]]> - - - - - Load a file using the "latin-1" encoding. - - - - ]]> - - - - - Load a file, replacing all @NOW@ tokens with the current - date/time. - - - - - - - - - - ]]> - - - - - - The file to load. - + + Includes an external build file. + + + + This task is used to break your build file into smaller chunks. You + can load a partial build file and have it included into the build file. + + + Any global (project level) tasks in the included build file are executed + when this task is executed. Tasks in target elements are only executed + if that target is executed. + + + The project element attributes are ignored. + + + This task can only be in the global (project level) section of the + build file. + + + This task can only include files from the file system. + + + + + Include a task that fetches the project version from the + GetProjectVersion.include build file. + + + + ]]> + + + + + + Used to check for recursived includes. + + + + + Verifies parameters. + + + + + Build file to include. + + + + + Load a text file into a single property. + + + + Unless an encoding is specified, the encoding associated with the + system's current ANSI code page is used. + + + An UTF-8, little-endian Unicode, and big-endian Unicode encoded text + file is automatically recognized, if the file starts with the appropriate + byte order marks. + + + + + Load file message.txt into property "message". + + + + ]]> + + + + + Load a file using the "latin-1" encoding. + + + + ]]> + + + + + Load a file, replacing all @NOW@ tokens with the current + date/time. + + + + + + + + + + ]]> + + + + + + The file to load. + - - The name of the property to save the content to. - + + The name of the property to save the content to. + - - The encoding to use when loading the file. The default is the encoding - associated with the system's current ANSI code page. - + + The encoding to use when loading the file. The default is the encoding + associated with the system's current ANSI code page. + - - The filterchain definition to use. - + + The filterchain definition to use. + @@ -6783,128 +6783,128 @@ Both and are set. - - An assembly to load tasks from. - + + An assembly to load tasks from. + - - A directory to scan for task assemblies. - + + A directory to scan for task assemblies. + - - Used to select which directories or individual assemblies to scan. - + + Used to select which directories or individual assemblies to scan. + - - Loops over a set of items. - - - - Can loop over files in directory, lines in a file, etc. - - - The property value is stored before the loop is done, and restored - when the loop is finished. - - - The property is returned to its normal value once it is used. Read-only - parameters cannot be overridden in this loop. - - - - Loops over the files in c:\. - - - - - ]]> - - - - Loops over all files in the project directory. - - - - - - - - - - - - ]]> - - - - Loops over the folders in c:\. - - - - - ]]> - - - - Loops over all folders in the project directory. - - - - - - - - - - - - ]]> - - - - Loops over a list. - - - - - ]]> - - - - - Loops over lines in the file properties.csv, where each line - is of the format name,value. - - - - - - ]]> - - + + Loops over a set of items. + + + + Can loop over files in directory, lines in a file, etc. + + + The property value is stored before the loop is done, and restored + when the loop is finished. + + + The property is returned to its normal value once it is used. Read-only + parameters cannot be overridden in this loop. + + + + Loops over the files in c:\. + + + + + ]]> + + + + Loops over all files in the project directory. + + + + + + + + + + + + ]]> + + + + Loops over the folders in c:\. + + + + + ]]> + + + + Loops over all folders in the project directory. + + + + + + + + + + + + ]]> + + + + Loops over a list. + + + + + ]]> + + + + + Loops over lines in the file properties.csv, where each line + is of the format name,value. + + + + + + ]]> + + - - The NAnt property name(s) that should be used for the current - iterated item. - - - If specifying multiple properties, separate them with a comma. - + + The NAnt property name(s) that should be used for the current + iterated item. + + + If specifying multiple properties, separate them with a comma. + - - The type of iteration that should be done. - + + The type of iteration that should be done. + @@ -6913,14 +6913,14 @@ - - The source of the iteration. - + + The source of the iteration. + - - The deliminator char. - + + The deliminator char. + @@ -6934,126 +6934,126 @@ - - Tasks to execute for each matching item. - + + Tasks to execute for each matching item. + - - Do not remove any white space characters. - + + Do not remove any white space characters. + - - Remove all white space characters from the end of the current - item. - + + Remove all white space characters from the end of the current + item. + - - Remove all white space characters from the beginning of the - current item. - + + Remove all white space characters from the beginning of the + current item. + - - Remove all white space characters from the beginning and end of - the current item. - + + Remove all white space characters from the beginning and end of + the current item. + - - Sends an SMTP message. - - - - Text and text files to include in the message body may be specified as - well as binary attachments. - - - - - Sends an email from nant@sourceforge.net to three recipients - with a subject about the attachments. The body of the message will be - the combined contents of all .txt files in the base directory. - All zip files in the base directory will be included as attachments. - The message will be sent using the smtpserver.anywhere.com SMTP - server. - - - - - - - - - - - ]]> - - + + Sends an SMTP message. + + + + Text and text files to include in the message body may be specified as + well as binary attachments. + + + + + Sends an email from nant@sourceforge.net to three recipients + with a subject about the attachments. The body of the message will be + the combined contents of all .txt files in the base directory. + All zip files in the base directory will be included as attachments. + The message will be sent using the smtpserver.anywhere.com SMTP + server. + + + + + + + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done. - + + This is where the work is done. + - - Reads a text file and returns the content - in a string. - - The file to read content of. - - The content of the specified file. - + + Reads a text file and returns the content + in a string. + + The file to read content of. + + The content of the specified file. + - - Email address of sender. - + + Email address of sender. + - - Semicolon-separated list of recipient email addresses. - + + Semicolon-separated list of recipient email addresses. + - - Semicolon-separated list of CC: recipient email addresses. - + + Semicolon-separated list of CC: recipient email addresses. + - - Semicolon-separated list of BCC: recipient email addresses. - + + Semicolon-separated list of BCC: recipient email addresses. + - - Host name of mail server. The default is localhost. - + + Host name of mail server. The default is localhost. + - - Text to send in body of email message. - + + Text to send in body of email message. + - - Text to send in subject line of email message. - + + Text to send in subject line of email message. + @@ -7061,35 +7061,35 @@ - - Files that are transmitted as part of the body of the email message. - + + Files that are transmitted as part of the body of the email message. + - - Attachments that are transmitted with the message. - + + Attachments that are transmitted with the message. + - - Creates a directory and any non-existent parent directory if necessary. - - - Create the directory build. - - - ]]> - - - - Create the directory tree one/two/three. - - - ]]> - - + + Creates a directory and any non-existent parent directory if necessary. + + + Create the directory build. + + + ]]> + + + + Create the directory tree one/two/three. + + + ]]> + + @@ -7098,9 +7098,9 @@ The directory could not be created. - - The directory to create. - + + The directory to create. + @@ -7195,24 +7195,24 @@ - - Actually does the file moves. - + + Actually does the file moves. + - - The file to move. - + + The file to move. + - - The file to move to. - + + The file to move to. + - - The directory to move to. - + + The directory to move to. + @@ -7228,38 +7228,38 @@ - - Chain of filters used to alter the file's content as it is moved. - + + Chain of filters used to alter the file's content as it is moved. + - - Creates an XSD File for all available tasks. - - - - This can be used in conjuntion with the command-line option to do XSD - Schema validation on the build file. - - - - Creates a NAnt.xsd file in the current project directory. - - - ]]> - - + + Creates an XSD File for all available tasks. + + + + This can be used in conjuntion with the command-line option to do XSD + Schema validation on the build file. + + + + Creates a NAnt.xsd file in the current project directory. + + + ]]> + + - - Creates a NAnt Schema for given types - - The output stream to save the schema to. If , writing is ignored, no exception generated. - The list of tasks to generate XML Schema for. - The list of datatypes to generate XML Schema for. - The target namespace to output. - The new NAnt Schema. + + Creates a NAnt Schema for given types + + The output stream to save the schema to. If , writing is ignored, no exception generated. + The list of tasks to generate XML Schema for. + The list of datatypes to generate XML Schema for. + The target namespace to output. + The new NAnt Schema. @@ -7278,14 +7278,14 @@ The new instance. - - The name of the output file to which the XSD should be written. - + + The name of the output file to which the XSD should be written. + - - The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd" - + + The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd" + @@ -7378,133 +7378,133 @@ - - The build file to build. - + + The build file to build. + - - The target to execute. To specify more than one target seperate - targets with a space. Targets are executed in order if possible. - The default is to use target specified in the project's default - attribute. - + + The target to execute. To specify more than one target seperate + targets with a space. Targets are executed in order if possible. + The default is to use target specified in the project's default + attribute. + - - Used to specify a set of build files to process. - + + Used to specify a set of build files to process. + - - Specifies whether current property values should be inherited by - the executed project. The default is . - + + Specifies whether current property values should be inherited by + the executed project. The default is . + - - Specifies whether all references will be copied to the new project. - The default is . - + + Specifies whether all references will be copied to the new project. + The default is . + - - Specifies a collection of properties that should be created in the - executed project. Note, existing properties with identical names - that are not read-only will be overwritten. - + + Specifies a collection of properties that should be created in the + executed project. Note, existing properties with identical names + that are not read-only will be overwritten. + - - Sets a property in the current project. - - - NAnt uses a number of predefined properties. - - - - Define a debug property with value . - - - - ]]> - - - - - Use the user-defined debug property. - - - - ]]> - - - - - Define a read-only property. This is just like passing in the param - on the command line. - - - - ]]> - - - - - Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line). - - - - - - - ]]> - - - Executing this build file with the command line option -D:debug=false, - would cause the value specified on the command line to remain unaltered. - - - - - + + Sets a property in the current project. + + + NAnt uses a number of predefined properties. + + + + Define a debug property with value . + + + + ]]> + + + + + Use the user-defined debug property. + + + + ]]> + + + + + Define a read-only property. This is just like passing in the param + on the command line. + + + + ]]> + + + + + Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line). + + + + + + + ]]> + + + Executing this build file with the command line option -D:debug=false, + would cause the value specified on the command line to remain unaltered. + + + + + - - The name of the NAnt property to set. - + + The name of the NAnt property to set. + - - The value to assign to the NAnt property. - + + The value to assign to the NAnt property. + - - Specifies whether the property is read-only or not. - The default is . - + + Specifies whether the property is read-only or not. + The default is . + - - Specifies whether references to other properties should not be - expanded when the value of the property is set, but expanded when - the property is actually used. By default, properties will be - expanded when set. - + + Specifies whether references to other properties should not be + expanded when the value of the property is set, but expanded when + the property is actually used. By default, properties will be + expanded when set. + - - Specifies whether the value of a property should be overwritten if - the property already exists (unless the property is read-only). - The default is . - + + Specifies whether the value of a property should be overwritten if + the property already exists (unless the property is read-only). + The default is . + @@ -7565,21 +7565,21 @@ - - Executes the task. - + + Executes the task. + - - Represents the regular expression to be evalued. - - - The regular expression to be evalued. - - - The pattern must contain one or more named constructs, which may - not contain any punctuation and cannot begin with a number. - + + Represents the regular expression to be evalued. + + + The regular expression to be evalued. + + + The pattern must contain one or more named constructs, which may + not contain any punctuation and cannot begin with a number. + @@ -7588,12 +7588,12 @@ - - Represents the input for the regular expression. - - - The input for the regular expression. - + + Represents the input for the regular expression. + + + The input for the regular expression. + @@ -7659,218 +7659,218 @@ - - Win32 DllImport for the SetEnvironmentVariable function. - - - - + + Win32 DllImport for the SetEnvironmentVariable function. + + + + - - *nix dllimport for the setenv function. - - - - - - 0 if the execution is successful; otherwise, -1. - + + *nix dllimport for the setenv function. + + + + + + 0 if the execution is successful; otherwise, -1. + - - Deletes all instances of the variable name. - - The variable to unset. - - 0 if the execution is successful; otherwise, -1. - + + Deletes all instances of the variable name. + + The variable to unset. + + 0 if the execution is successful; otherwise, -1. + - - Checks whether the task is initialized with valid attributes. - + + Checks whether the task is initialized with valid attributes. + - - Set the environment variables - + + Set the environment variables + - - Do the actual work here. - - The name of the environment variable. - The value of the environment variable. + + Do the actual work here. + + The name of the environment variable. + The value of the environment variable. - - The name of a single Environment variable to set - + + The name of a single Environment variable to set + - - The literal value for the environment variable. - + + The literal value for the environment variable. + - - The value for a file-based environment variable. NAnt will convert - it to an absolute filename. - + + The value for a file-based environment variable. NAnt will convert + it to an absolute filename. + - - The value for a directory-based environment variable. NAnt will - convert it to an absolute path. - + + The value for a directory-based environment variable. NAnt will + convert it to an absolute path. + - - The value for a PATH like environment variable. You can use - : or ; as path separators and NAnt will convert it to - the platform's local conventions. - + + The value for a PATH like environment variable. You can use + : or ; as path separators and NAnt will convert it to + the platform's local conventions. + - - A task for sleeping a specified period of time, useful when a build or deployment process - requires an interval between tasks. - - - Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds. - - - ]]> - - - - Sleep 123 milliseconds. - - - ]]> - - + + A task for sleeping a specified period of time, useful when a build or deployment process + requires an interval between tasks. + + + Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds. + + + ]]> + + + + Sleep 123 milliseconds. + + + ]]> + + - - Verify parameters. - + + Verify parameters. + - - Return time to sleep. - + + Return time to sleep. + - - Sleeps for the specified number of milliseconds. - - Number of milliseconds to sleep. + + Sleeps for the specified number of milliseconds. + + Number of milliseconds to sleep. - - Hours to add to the sleep time. - + + Hours to add to the sleep time. + - - Minutes to add to the sleep time. - + + Minutes to add to the sleep time. + - - Seconds to add to the sleep time. - + + Seconds to add to the sleep time. + - - Milliseconds to add to the sleep time. - + + Milliseconds to add to the sleep time. + - - Processes a document via XSLT. - - - Create a report in HTML. - - - ]]> - - - - Create a report in HTML, with a param. - - - - - - - ]]> - - - - Create a report in HTML, with a expanded param. - - - - - - - ]]> - - - - Create some code based on a directory of templates. - - - - - - - - - - ]]> - - + + Processes a document via XSLT. + + + Create a report in HTML. + + + ]]> + + + + Create a report in HTML, with a param. + + + + + + + ]]> + + + + Create a report in HTML, with a expanded param. + + + + + + + ]]> + + + + Create some code based on a directory of templates. + + + + + + + + + + ]]> + + - - Directory in which to store the results. The default is the project - base directory. - + + Directory in which to store the results. The default is the project + base directory. + - - Desired file extension to be used for the targets. The default is - html. - + + Desired file extension to be used for the targets. The default is + html. + - - URI or path that points to the stylesheet to use. If given as path, it can - be relative to the project's basedir or absolute. - + + URI or path that points to the stylesheet to use. If given as path, it can + be relative to the project's basedir or absolute. + @@ -7885,24 +7885,24 @@ - - Specifies a group of input files to which to apply the stylesheet. - + + Specifies a group of input files to which to apply the stylesheet. + - - XSLT parameters to be passed to the XSLT transformation. - + + XSLT parameters to be passed to the XSLT transformation. + - - XSLT extension objects to be passed to the XSLT transformation. - + + XSLT extension objects to be passed to the XSLT transformation. + - - The network proxy to use to access the Internet resource. - + + The network proxy to use to access the Internet resource. + @@ -8026,70 +8026,70 @@ - - The string to prefix the property names with. The default is "sys.". - + + The string to prefix the property names with. The default is "sys.". + - - Touches a file or set of files -- corresponds to the Unix touch command. - - - - If the file specified does not exist, the task will create it. - - - - Touch the Main.cs file. The current time is used. - - - ]]> - - - - - Touch all executable files in the project base directory and its - subdirectories. - - - - - - - - - ]]> - - + + Touches a file or set of files -- corresponds to the Unix touch command. + + + + If the file specified does not exist, the task will create it. + + + + Touch the Main.cs file. The current time is used. + + + ]]> + + + + + Touch all executable files in the project base directory and its + subdirectories. + + + + + + + + + ]]> + + - - Ensures the supplied attributes are valid. - + + Ensures the supplied attributes are valid. + - - The file to touch. - + + The file to touch. + - - Specifies the new modification time of the file(s) in milliseconds - since midnight Jan 1 1970. - + + Specifies the new modification time of the file(s) in milliseconds + since midnight Jan 1 1970. + - - Specifies the new modification time of the file in the format - MM/DD/YYYY HH:MM:SS. - + + Specifies the new modification time of the file in the format + MM/DD/YYYY HH:MM:SS. + - - Used to select files that should be touched. - + + Used to select files that should be touched. + @@ -8141,77 +8141,77 @@ - - The property to receive the date/time string in the given pattern. - + + The property to receive the date/time string in the given pattern. + - The date/time pattern to be used. - - The following table lists the standard format characters for each standard pattern. The format characters are case-sensitive; for example, 'g' and 'G' represent slightly different patterns. - - - Format Character - Description Example Format Pattern (en-US) - - dMM/dd/yyyy - Ddddd, dd MMMM yyyy - fdddd, dd MMMM yyyy HH:mm - Fdddd, dd MMMM yyyy HH:mm:ss - gMM/dd/yyyy HH:mm - GMM/dd/yyyy HH:mm:ss - m, MMMMM dd - r, Rddd, dd MMM yyyy HH':'mm':'ss 'GMT' - syyyy'-'MM'-'dd'T'HH':'mm':'ss - tHH:mm - THH:mm:ss - uyyyy'-'MM'-'dd HH':'mm':'ss'Z' - Udddd, dd MMMM yyyy HH:mm:ss - y, Yyyyy MMMM - - The following table lists the patterns that can be combined to construct custom patterns. The patterns are case-sensitive; for example, "MM" is recognized, but "mm" is not. If the custom pattern contains white-space characters or characters enclosed in single quotation marks, the output string will also contain those characters. Characters not defined as part of a format pattern or as format characters are reproduced literally. - - - Format - Pattern Description - - dThe day of the month. Single-digit days will not have a leading zero. - ddThe day of the month. Single-digit days will have a leading zero. - dddThe abbreviated name of the day of the week. - ddddThe full name of the day of the week. - MThe numeric month. Single-digit months will not have a leading zero. - MMThe numeric month. Single-digit months will have a leading zero. - MMMThe abbreviated name of the month. - MMMMThe full name of the month. - yThe year without the century. If the year without the century is less than 10, the year is displayed with no leading zero. - yyThe year without the century. If the year without the century is less than 10, the year is displayed with a leading zero. - yyyyThe year in four digits, including the century. - ggThe period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string. - hThe hour in a 12-hour clock. Single-digit hours will not have a leading zero. - hhThe hour in a 12-hour clock. Single-digit hours will have a leading zero. - HThe hour in a 24-hour clock. Single-digit hours will not have a leading zero. - HHThe hour in a 24-hour clock. Single-digit hours will have a leading zero. - mThe minute. Single-digit minutes will not have a leading zero. - mmThe minute. Single-digit minutes will have a leading zero. - sThe second. Single-digit seconds will not have a leading zero. - ssThe second. Single-digit seconds will have a leading zero. - fThe fraction of a second in single-digit precision. The remaining digits are truncated. - ffThe fraction of a second in double-digit precision. The remaining digits are truncated. - fffThe fraction of a second in three-digit precision. The remaining digits are truncated. - ffffThe fraction of a second in four-digit precision. The remaining digits are truncated. - fffffThe fraction of a second in five-digit precision. The remaining digits are truncated. - ffffffThe fraction of a second in six-digit precision. The remaining digits are truncated. - fffffffThe fraction of a second in seven-digit precision. The remaining digits are truncated. - tThe first character in the AM/PM designator. - ttThe AM/PM designator. - zThe time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8". - zzThe time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08". - zzzThe full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00". - :The default time separator. - /The default date separator. - \ cPattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". - - + The date/time pattern to be used. + + The following table lists the standard format characters for each standard pattern. The format characters are case-sensitive; for example, 'g' and 'G' represent slightly different patterns. + + + Format Character + Description Example Format Pattern (en-US) + + dMM/dd/yyyy + Ddddd, dd MMMM yyyy + fdddd, dd MMMM yyyy HH:mm + Fdddd, dd MMMM yyyy HH:mm:ss + gMM/dd/yyyy HH:mm + GMM/dd/yyyy HH:mm:ss + m, MMMMM dd + r, Rddd, dd MMM yyyy HH':'mm':'ss 'GMT' + syyyy'-'MM'-'dd'T'HH':'mm':'ss + tHH:mm + THH:mm:ss + uyyyy'-'MM'-'dd HH':'mm':'ss'Z' + Udddd, dd MMMM yyyy HH:mm:ss + y, Yyyyy MMMM + + The following table lists the patterns that can be combined to construct custom patterns. The patterns are case-sensitive; for example, "MM" is recognized, but "mm" is not. If the custom pattern contains white-space characters or characters enclosed in single quotation marks, the output string will also contain those characters. Characters not defined as part of a format pattern or as format characters are reproduced literally. + + + Format + Pattern Description + + dThe day of the month. Single-digit days will not have a leading zero. + ddThe day of the month. Single-digit days will have a leading zero. + dddThe abbreviated name of the day of the week. + ddddThe full name of the day of the week. + MThe numeric month. Single-digit months will not have a leading zero. + MMThe numeric month. Single-digit months will have a leading zero. + MMMThe abbreviated name of the month. + MMMMThe full name of the month. + yThe year without the century. If the year without the century is less than 10, the year is displayed with no leading zero. + yyThe year without the century. If the year without the century is less than 10, the year is displayed with a leading zero. + yyyyThe year in four digits, including the century. + ggThe period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string. + hThe hour in a 12-hour clock. Single-digit hours will not have a leading zero. + hhThe hour in a 12-hour clock. Single-digit hours will have a leading zero. + HThe hour in a 24-hour clock. Single-digit hours will not have a leading zero. + HHThe hour in a 24-hour clock. Single-digit hours will have a leading zero. + mThe minute. Single-digit minutes will not have a leading zero. + mmThe minute. Single-digit minutes will have a leading zero. + sThe second. Single-digit seconds will not have a leading zero. + ssThe second. Single-digit seconds will have a leading zero. + fThe fraction of a second in single-digit precision. The remaining digits are truncated. + ffThe fraction of a second in double-digit precision. The remaining digits are truncated. + fffThe fraction of a second in three-digit precision. The remaining digits are truncated. + ffffThe fraction of a second in four-digit precision. The remaining digits are truncated. + fffffThe fraction of a second in five-digit precision. The remaining digits are truncated. + ffffffThe fraction of a second in six-digit precision. The remaining digits are truncated. + fffffffThe fraction of a second in seven-digit precision. The remaining digits are truncated. + tThe first character in the AM/PM designator. + ttThe AM/PM designator. + zThe time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8". + zzThe time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08". + zzzThe full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00". + :The default time separator. + /The default date separator. + \ cPattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". + + @@ -8241,10 +8241,10 @@ - - Property that will be set to or depending on the - result of the date check. - + + Property that will be set to or depending on the + result of the date check. + @@ -8257,55 +8257,55 @@ - - Extracts text from an XML file at the location specified by an XPath - expression. - - - - If the XPath expression specifies multiple nodes the node index is used - to determine which of the nodes' text is returned. - - - - - The example provided assumes that the following XML file (App.config) - exists in the current build directory. - - - - - - - - - ]]> - - - - - The example will read the server value from the above - configuration file. - - - - - - - - ]]> - - + + Extracts text from an XML file at the location specified by an XPath + expression. + + + + If the XPath expression specifies multiple nodes the node index is used + to determine which of the nodes' text is returned. + + + + + The example provided assumes that the following XML file (App.config) + exists in the current build directory. + + + + + + + + + ]]> + + + + + The example will read the server value from the above + configuration file. + + + + + + + + ]]> + + - - Executes the XML peek task. - + + Executes the XML peek task. + @@ -8318,126 +8318,126 @@ - - Gets the contents of the node specified by the XPath expression. - - The XPath expression used to determine which nodes to choose from. - The XML document to select the nodes from. - The node index in the case where multiple nodes satisfy the expression. - - The contents of the node specified by the XPath expression. - + + Gets the contents of the node specified by the XPath expression. + + The XPath expression used to determine which nodes to choose from. + The XML document to select the nodes from. + The node index in the case where multiple nodes satisfy the expression. + + The contents of the node specified by the XPath expression. + - - The name of the file that contains the XML document - that is going to be peeked at. - + + The name of the file that contains the XML document + that is going to be peeked at. + - - The index of the node that gets its text returned when the query - returns multiple nodes. - + + The index of the node that gets its text returned when the query + returns multiple nodes. + - - The property that receives the text representation of the XML inside - the node returned from the XPath expression. - + + The property that receives the text representation of the XML inside + the node returned from the XPath expression. + - - The XPath expression used to select which node to read. - + + The XPath expression used to select which node to read. + - - Namespace definitions to resolve prefixes in the XPath expression. - + + Namespace definitions to resolve prefixes in the XPath expression. + - - Replaces text in an XML file at the location specified by an XPath - expression. - - - - The location specified by the XPath expression must exist, it will - not create the parent elements for you. However, provided you have - a root element you could use a series of the tasks to build the - XML file up if necessary. - - - - - Change the server setting in the configuration from testhost.somecompany.com - to productionhost.somecompany.com. - - XML file: - - - - - - - - ]]> - - Build fragment: - - - ]]> - - - - - Modify the noNamespaceSchemaLocation in an XML file. - - XML file: - - - - - ]]> - - Build fragment: - - - - - - - ]]> - - + + Replaces text in an XML file at the location specified by an XPath + expression. + + + + The location specified by the XPath expression must exist, it will + not create the parent elements for you. However, provided you have + a root element you could use a series of the tasks to build the + XML file up if necessary. + + + + + Change the server setting in the configuration from testhost.somecompany.com + to productionhost.somecompany.com. + + XML file: + + + + + + + + ]]> + + Build fragment: + + + ]]> + + + + + Modify the noNamespaceSchemaLocation in an XML file. + + XML file: + + + + + ]]> + + Build fragment: + + + + + + + ]]> + + - - Executes the XML poke task. - + + Executes the XML poke task. + - - Loads an XML document from a file on disk. - - - The file name of the file to load the XML document from. - - - Value for XmlDocument.PreserveWhitespace that is set before the xml is loaded. - - - An containing - the document object model representing the file. - + + Loads an XML document from a file on disk. + + + The file name of the file to load the XML document from. + + + Value for XmlDocument.PreserveWhitespace that is set before the xml is loaded. + + + An containing + the document object model representing the file. + @@ -8460,48 +8460,48 @@ - - Given a node list, replaces the XML within those nodes. - - - The list of nodes to replace the contents of. - - - The text to replace the contents with. - + + Given a node list, replaces the XML within those nodes. + + + The list of nodes to replace the contents of. + + + The text to replace the contents with. + - - Saves the XML document to a file. - - The XML document to be saved. - The file name to save the XML document under. + + Saves the XML document to a file. + + The XML document to be saved. + The file name to save the XML document under. - - The name of the file that contains the XML document that is going - to be poked. - + + The name of the file that contains the XML document that is going + to be poked. + - - The XPath expression used to select which nodes are to be modified. - + + The XPath expression used to select which nodes are to be modified. + - - The value that replaces the contents of the selected nodes. - + + The value that replaces the contents of the selected nodes. + - - Namespace definitions to resolve prefixes in the XPath expression. - + + Namespace definitions to resolve prefixes in the XPath expression. + - - Namespace definitions to resolve prefixes in the XPath expression. - + + Namespace definitions to resolve prefixes in the XPath expression. + @@ -8581,76 +8581,76 @@ - - Quotes a command line argument if it contains a single quote or a - space. - - The command line argument. - - A quoted command line argument if - contains a single quote or a space; otherwise, - . - + + Quotes a command line argument if it contains a single quote or a + space. + + The command line argument. + + A quoted command line argument if + contains a single quote or a space; otherwise, + . + - - A single command-line argument; can contain space characters. - + + A single command-line argument; can contain space characters. + - - The name of a file as a single command-line argument; will be - replaced with the absolute filename of the file. - + + The name of a file as a single command-line argument; will be + replaced with the absolute filename of the file. + - - The value for a directory-based command-line argument; will be - replaced with the absolute path of the directory. - + + The value for a directory-based command-line argument; will be + replaced with the absolute path of the directory. + - - The value for a PATH-like command-line argument; you can use - : or ; as path separators and NAnt will convert it - to the platform's local conventions, while resolving references to - environment variables. - - - Individual parts will be replaced with the absolute path, resolved - relative to the project base directory. - + + The value for a PATH-like command-line argument; you can use + : or ; as path separators and NAnt will convert it + to the platform's local conventions, while resolving references to + environment variables. + + + Individual parts will be replaced with the absolute path, resolved + relative to the project base directory. + - - Sets a single command-line argument and treats it like a PATH - ensures - the right separator for the local platform is used. - + + Sets a single command-line argument and treats it like a PATH - ensures + the right separator for the local platform is used. + - - List of command-line arguments; will be passed to the executable - as is. - + + List of command-line arguments; will be passed to the executable + as is. + - - Indicates if the argument should be passed to the external program. - If then the argument will be passed; - otherwise, skipped. The default is . - + + Indicates if the argument should be passed to the external program. + If then the argument will be passed; + otherwise, skipped. The default is . + - - Indicates if the argument should not be passed to the external - program. If then the argument will be - passed; otherwise, skipped. The default is . - + + Indicates if the argument should not be passed to the external + program. If then the argument will be + passed; otherwise, skipped. The default is . + - - Gets string value corresponding with the argument. - + + Gets string value corresponding with the argument. + @@ -8716,11 +8716,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -8753,10 +8753,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -8777,33 +8777,33 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Provides credentials for password-based authentication schemes. - + + Provides credentials for password-based authentication schemes. + @@ -8823,35 +8823,35 @@ - - The domain or computer name that verifies the credentials. - + + The domain or computer name that verifies the credentials. + - - The password for the user name associated with the credentials. - + + The password for the user name associated with the credentials. + - - The user name associated with the credentials. - + + The user name associated with the credentials. + - - Indicates if the credentials should be used to provide authentication - information to the external resource. If then - the credentials will be passed; otherwise, not. The default is - . - + + Indicates if the credentials should be used to provide authentication + information to the external resource. If then + the credentials will be passed; otherwise, not. The default is + . + - - Indicates if the credentials should not be used to provide authentication - information to the external resource. If then the - credentials will be passed; otherwise, not. The default is - . - + + Indicates if the credentials should not be used to provide authentication + information to the external resource. If then the + credentials will be passed; otherwise, not. The default is + . + @@ -9065,10 +9065,10 @@ - - copy constructor - - + + copy constructor + + @@ -9079,9 +9079,9 @@ - - Adds a nested set of patterns, or references a standalone patternset. - + + Adds a nested set of patterns, or references a standalone patternset. + @@ -9090,37 +9090,37 @@ - - Determines if a file has a more recent last write time than the - given time, or no longer exists. - - A file to check the last write time against. - The datetime to compare against. - - The name of the file that has a last write time greater than - or that no longer exists; - otherwise, . - + + Determines if a file has a more recent last write time than the + given time, or no longer exists. + + A file to check the last write time against. + The datetime to compare against. + + The name of the file that has a last write time greater than + or that no longer exists; + otherwise, . + - - Determines if one of the given files has a more recent last write - time than the given time. If one of the given files no longer exists, - the target will be considered out-of-date. - - A collection of filenames to check the last write time against. - The datetime to compare against. - - The name of the first file that has a last write time greater than - ; otherwise, null. - + + Determines if one of the given files has a more recent last write + time than the given time. If one of the given files no longer exists, + the target will be considered out-of-date. + + A collection of filenames to check the last write time against. + The datetime to compare against. + + The name of the first file that has a last write time greater than + ; otherwise, null. + - - Indicates whether include and exclude patterns must be treated in a - case-sensitive way. The default is on Unix; - otherwise, . - + + Indicates whether include and exclude patterns must be treated in a + case-sensitive way. The default is on Unix; + otherwise, . + @@ -9130,26 +9130,26 @@ - - Indicates whether default excludes should be used or not. - The default is . - + + Indicates whether default excludes should be used or not. + The default is . + - - The base of the directory of this fileset. The default is the project - base directory. - + + The base of the directory of this fileset. The default is the project + base directory. + - - Gets the collection of include patterns. - + + Gets the collection of include patterns. + - - Gets the collection of exclude patterns. - + + Gets the collection of exclude patterns. + @@ -9177,51 +9177,51 @@ - - Gets the collection of directory names that were scanned for files. - - - A collection that contains the directory names that were scanned for - files. - + + Gets the collection of directory names that were scanned for files. + + + A collection that contains the directory names that were scanned for + files. + - - The items to include in the fileset. - + + The items to include in the fileset. + - - The items to include in the fileset. - + + The items to include in the fileset. + - - The items to exclude from the fileset. - + + The items to exclude from the fileset. + - - The items to exclude from the fileset. - + + The items to exclude from the fileset. + - - The files from which a list of patterns or files to include should - be obtained. - + + The files from which a list of patterns or files to include should + be obtained. + - - The files from which a list of patterns or files to include should - be obtained. - + + The files from which a list of patterns or files to include should + be obtained. + - - The files from which a list of patterns or files to exclude should - be obtained. - + + The files from which a list of patterns or files to exclude should + be obtained. + @@ -9232,15 +9232,15 @@ - - The pattern or file name to exclude. - + + The pattern or file name to exclude. + - - If then the pattern will be excluded; - otherwise, skipped. The default is . - + + If then the pattern will be excluded; + otherwise, skipped. The default is . + @@ -9257,21 +9257,21 @@ - - If then the file will be searched for - on the path. The default is . - + + If then the file will be searched for + on the path. The default is . + - - The pattern or file name to include. - + + The pattern or file name to include. + - - If then the pattern will be included; - otherwise, skipped. The default is . - + + If then the pattern will be included; + otherwise, skipped. The default is . + @@ -9286,10 +9286,10 @@ - - If then the patterns will be excluded; - otherwise, skipped. The default is . - + + If then the patterns will be excluded; + otherwise, skipped. The default is . + @@ -9299,10 +9299,10 @@ - - The name of a file; each line of this file is taken to be a - pattern. - + + The name of a file; each line of this file is taken to be a + pattern. + @@ -9313,16 +9313,16 @@ - - If then the patterns in the include file - will be searched for on the path. The default is . - + + If then the patterns in the include file + will be searched for on the path. The default is . + - - If then the patterns will be included; - otherwise, skipped. The default is . - + + If then the patterns will be included; + otherwise, skipped. The default is . + @@ -9345,9 +9345,9 @@ A instance to create a from. - - Represents an environment variable. - + + Represents an environment variable. + @@ -9363,75 +9363,75 @@ - - The name of the environment variable. - + + The name of the environment variable. + - - The literal value for the environment variable. - + + The literal value for the environment variable. + - - The value for a file-based environment variable. NAnt will convert - it to an absolute filename. - + + The value for a file-based environment variable. NAnt will convert + it to an absolute filename. + - - The value for a directory-based environment variable. NAnt will - convert it to an absolute path. - + + The value for a directory-based environment variable. NAnt will + convert it to an absolute path. + - - The value for a PATH like environment variable. You can use - : or ; as path separators and NAnt will convert it to - the platform's local conventions. - + + The value for a PATH like environment variable. You can use + : or ; as path separators and NAnt will convert it to + the platform's local conventions. + - - Sets a single environment variable and treats it like a PATH - - ensures the right separator for the local platform is used. - + + Sets a single environment variable and treats it like a PATH - + ensures the right separator for the local platform is used. + - - Gets the value of the environment variable. - + + Gets the value of the environment variable. + - - Indicates if the environment variable should be passed to the - external program. If then the environment - variable will be passed; otherwise, skipped. The default is - . - + + Indicates if the environment variable should be passed to the + external program. If then the environment + variable will be passed; otherwise, skipped. The default is + . + - - Indicates if the environment variable should not be passed to the - external program. If then the environment - variable will be passed; otherwise, skipped. The default is - . - + + Indicates if the environment variable should not be passed to the + external program. If then the environment + variable will be passed; otherwise, skipped. The default is + . + - - A set of environment variables. - + + A set of environment variables. + - - Environment variable to pass to a program. - + + Environment variable to pass to a program. + - - Environment variable to pass to a program. - + + Environment variable to pass to a program. + @@ -9497,11 +9497,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -9534,10 +9534,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -9558,52 +9558,52 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - The name of the NAnt property to set. - + + The name of the NAnt property to set. + - - The string pattern to use to format the property. - + + The string pattern to use to format the property. + - - Indicates if the formatter should be used to format the timestamp. - If then the formatter will be used; - otherwise, skipped. The default is . - + + Indicates if the formatter should be used to format the timestamp. + If then the formatter will be used; + otherwise, skipped. The default is . + - - Indicates if the formatter should be not used to format the - timestamp. If then the formatter will be - used; otherwise, skipped. The default is . - + + Indicates if the formatter should be not used to format the + timestamp. If then the formatter will be + used; otherwise, skipped. The default is . + @@ -9657,11 +9657,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -9694,10 +9694,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -9712,28 +9712,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -9769,21 +9769,21 @@ - - Do not threat the program as a managed application. - + + Do not threat the program as a managed application. + - - Leave it up to the CLR to determine which specific version of - the CLR will be used to run the application. - + + Leave it up to the CLR to determine which specific version of + the CLR will be used to run the application. + - - Forces an application to run against the currently targeted - version of a given CLR. - + + Forces an application to run against the currently targeted + version of a given CLR. + @@ -9812,45 +9812,45 @@ - - Represents an option. - + + Represents an option. + - - name, value constructor - - - + + name, value constructor + + + - - Default constructor - + + Default constructor + - - Name of the option. - + + Name of the option. + - - Value of the option. The default is . - + + Value of the option. The default is . + - - Indicates if the option should be passed to the task. - If then the option will be passed; - otherwise, skipped. The default is . - + + Indicates if the option should be passed to the task. + If then the option will be passed; + otherwise, skipped. The default is . + - - Indicates if the option should not be passed to the task. - If then the option will be passed; - otherwise, skipped. The default is . - + + Indicates if the option should not be passed to the task. + If then the option will be passed; + otherwise, skipped. The default is . + @@ -9915,11 +9915,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -9952,10 +9952,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -9976,59 +9976,59 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Represents a nested path element. - + + Represents a nested path element. + - - The name of a file to add to the path. Will be replaced with - the absolute path of the file. - + + The name of a file to add to the path. Will be replaced with + the absolute path of the file. + - - The name of a directory to add to the path. Will be replaced with - the absolute path of the directory. - + + The name of a directory to add to the path. Will be replaced with + the absolute path of the directory. + - - A string that will be treated as a path-like string. You can use - : or ; as path separators and NAnt will convert it - to the platform's local conventions, while resolving references - to environment variables. - + + A string that will be treated as a path-like string. You can use + : or ; as path separators and NAnt will convert it + to the platform's local conventions, while resolving references + to environment variables. + - - If then the entry will be added to the - path; otherwise, skipped. The default is . - + + If then the entry will be added to the + path; otherwise, skipped. The default is . + @@ -10047,27 +10047,27 @@ - - - Paths are groups of files and/or directories that need to be passed as a single - unit. The order in which parts of the path are specified in the build file is - retained, and duplicate parts are automatically suppressed. - - - - - Define a global <path> that can be referenced by other - tasks or types. - - - - - - - ]]> - - + + + Paths are groups of files and/or directories that need to be passed as a single + unit. The order in which parts of the path are specified in the build file is + retained, and duplicate parts are automatically suppressed. + + + + + Define a global <path> that can be referenced by other + tasks or types. + + + + + + + ]]> + + @@ -10083,13 +10083,13 @@ The string representing a path. - - Returns a textual representation of the path, which can be used as - PATH environment variable definition. - - - A textual representation of the path. - + + Returns a textual representation of the path, which can be used as + PATH environment variable definition. + + + A textual representation of the path. + @@ -10104,12 +10104,12 @@ The to add. - - Returns all path elements defined by this path object. - - - A list of path elements. - + + Returns all path elements defined by this path object. + + + A list of path elements. + @@ -10129,21 +10129,21 @@ - - The name pattern to include/exclude. - + + The name pattern to include/exclude. + - - If then the pattern will be used; - otherwise, skipped. The default is . - + + If then the pattern will be used; + otherwise, skipped. The default is . + - - If then the pattern will be used; - otherwise, skipped. The default is . - + + If then the pattern will be used; + otherwise, skipped. The default is . + @@ -10190,12 +10190,12 @@ - - Copies the entire collection to a compatible one-dimensional array, - starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, + starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -10228,10 +10228,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -10246,36 +10246,36 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -10472,9 +10472,9 @@ The to add. - - Defines a single pattern for files to include. - + + Defines a single pattern for files to include. + @@ -10483,9 +10483,9 @@ - - Defines a single pattern for files to exclude. - + + Defines a single pattern for files to exclude. + @@ -10494,10 +10494,10 @@ - - Contains HTTP proxy settings used to process requests to Internet - resources. - + + Contains HTTP proxy settings used to process requests to Internet + resources. + @@ -10516,9 +10516,9 @@ - - The name of the proxy host. - + + The name of the proxy host. + @@ -10526,40 +10526,40 @@ - - Specifies whether to bypass the proxy server for local addresses. - The default is . - + + Specifies whether to bypass the proxy server for local addresses. + The default is . + - - The credentials to submit to the proxy server for authentication. - + + The credentials to submit to the proxy server for authentication. + - - Indicates if the proxy should be used to connect to the external - resource. If then the proxy will be used; - otherwise, not. The default is . - + + Indicates if the proxy should be used to connect to the external + resource. If then the proxy will be used; + otherwise, not. The default is . + - - Indicates if the proxy should not be used to connect to the external - resource. If then the proxy will be used; - otherwise, not. The default is . - + + Indicates if the proxy should not be used to connect to the external + resource. If then the proxy will be used; + otherwise, not. The default is . + - - Represents an element of which the XML is processed by its parent task - or type. - + + Represents an element of which the XML is processed by its parent task + or type. + - - Gets the XML that this element represents. - + + Gets the XML that this element represents. + @@ -10573,48 +10573,48 @@ - - ReplaceTokens filter token. - + + ReplaceTokens filter token. + - - Token to be replaced. - + + Token to be replaced. + - - New value of token. - + + New value of token. + - - Indicates if the token should be used to replace values. - If then the token will be used; - otherwise, not. The default is . - + + Indicates if the token should be used to replace values. + If then the token will be used; + otherwise, not. The default is . + - - Indicates if the token should not be used to replace values. - If then the token will be used; - otherwise, not. The default is . - + + Indicates if the token should not be used to replace values. + If then the token will be used; + otherwise, not. The default is . + - - Represents an XML namespace. - + + Represents an XML namespace. + - - The prefix to associate with the namespace. - + + The prefix to associate with the namespace. + - - The associated XML namespace URI. - + + The associated XML namespace URI. + @@ -10694,11 +10694,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -10731,10 +10731,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -10755,35 +10755,35 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Represents an XSLT extension object. The object should have a default - parameterless constructor and the return value should be one of the - four basic XPath data types of number, string, Boolean or node set. - + + Represents an XSLT extension object. The object should have a default + parameterless constructor and the return value should be one of the + four basic XPath data types of number, string, Boolean or node set. + @@ -10801,28 +10801,28 @@ - - The full type name of the XSLT extension object. - + + The full type name of the XSLT extension object. + - - The assembly which contains the XSLT extension object. - + + The assembly which contains the XSLT extension object. + - - Indicates if the extension object should be added to the XSLT argument - list. If then the extension object will be - added; otherwise, skipped. The default is . - + + Indicates if the extension object should be added to the XSLT argument + list. If then the extension object will be + added; otherwise, skipped. The default is . + - - Indicates if the extension object should not be added to the XSLT argument - list. If then the extension object will be - added; otherwise, skipped. The default is . - + + Indicates if the extension object should not be added to the XSLT argument + list. If then the extension object will be + added; otherwise, skipped. The default is . + @@ -10899,15 +10899,15 @@ - - Copies the entire collection to a compatible one-dimensional array, - starting at the specified index of the target array. - - The one-dimensional array that is the - destination of the elements copied from the collection. The array - must have zero-based indexing. - The zero-based index in - at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, + starting at the specified index of the target array. + + The one-dimensional array that is the + destination of the elements copied from the collection. The array + must have zero-based indexing. + The zero-based index in + at which copying begins. @@ -10949,11 +10949,11 @@ from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get - or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get + or set. @@ -10978,33 +10978,33 @@ enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Represents an XSLT parameter. - + + Represents an XSLT parameter. + @@ -11040,18 +11040,18 @@ - - Indicates if the parameter should be added to the XSLT argument list. - If then the parameter will be added; - otherwise, skipped. The default is . - + + Indicates if the parameter should be added to the XSLT argument list. + If then the parameter will be added; + otherwise, skipped. The default is . + - - Indicates if the parameter should not be added to the XSLT argument - list. If then the parameter will be - added; otherwise, skipped. The default is . - + + Indicates if the parameter should not be added to the XSLT argument + list. If then the parameter will be + added; otherwise, skipped. The default is . + @@ -11117,11 +11117,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -11154,10 +11154,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -11178,33 +11178,33 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Resolves assemblies by caching assemblies that were loaded. - + + Resolves assemblies by caching assemblies that were loaded. + @@ -11225,9 +11225,9 @@ - - Uninstalls the assembly resolver. - + + Uninstalls the assembly resolver. + @@ -11261,9 +11261,9 @@ - - Holds the loaded assemblies. - + + Holds the loaded assemblies. + @@ -11277,9 +11277,9 @@ - - Represents a valid command-line argument. - + + Represents a valid command-line argument. + @@ -11346,12 +11346,12 @@ - - Gets the property that backs the argument. - - - The property that backs the arguments. - + + Gets the property that backs the argument. + + + The property that backs the arguments. + @@ -11366,61 +11366,61 @@ - - Gets the long name of the argument. - - The long name of the argument. + + Gets the long name of the argument. + + The long name of the argument. - - Gets the short name of the argument. - - The short name of the argument. + + Gets the short name of the argument. + + The short name of the argument. - - Gets the description of the argument. - - The description of the argument. + + Gets the description of the argument. + + The description of the argument. - - Gets a value indicating whether the argument is required. - - - if the argument is required; otherwise, - . - + + Gets a value indicating whether the argument is required. + + + if the argument is required; otherwise, + . + - - Gets a value indicating whether a mathing command-line argument - was already found. - - - if a matching command-line argument was - already found; otherwise, . - + + Gets a value indicating whether a mathing command-line argument + was already found. + + + if a matching command-line argument was + already found; otherwise, . + - - Gets a value indicating whether the argument can be specified multiple - times. - - - if the argument may be specified multiple - times; otherwise, . - + + Gets a value indicating whether the argument can be specified multiple + times. + + + if the argument may be specified multiple + times; otherwise, . + - - Gets a value indicating whether the argument can only be specified once - with a certain value. - - - if the argument should always have a unique - value; otherwise, . - + + Gets a value indicating whether the argument can only be specified once + with a certain value. + + + if the argument should always have a unique + value; otherwise, . + @@ -11455,37 +11455,37 @@ - - Gets a value indicating whether the argument is array-based. - - - if the argument is backed by an array; - otherwise, . - + + Gets a value indicating whether the argument is array-based. + + + if the argument is backed by an array; + otherwise, . + - - Gets a value indicating whether the argument is the default argument. - - - if the argument is the default argument; - otherwise, . - + + Gets a value indicating whether the argument is the default argument. + + + if the argument is the default argument; + otherwise, . + - - Gets a value indicating whether the argument cannot be combined with - other arguments. - - - if the argument cannot be combined with other - arguments; otherwise, . - + + Gets a value indicating whether the argument cannot be combined with + other arguments. + + + if the argument cannot be combined with other + arguments; otherwise, . + - - Allows control of command line parsing. - + + Allows control of command line parsing. + @@ -11495,28 +11495,28 @@ Specifies the checking to be done on the argument. - - Gets or sets the checking to be done on the argument. - - The checking that should be done on the argument. + + Gets or sets the checking to be done on the argument. + + The checking that should be done on the argument. - - Gets or sets the long name of the argument. - - The long name of the argument. + + Gets or sets the long name of the argument. + + The long name of the argument. - - Gets or sets the short name of the argument. - - The short name of the argument. + + Gets or sets the short name of the argument. + + The short name of the argument. - - Gets or sets the description of the argument. - - The description of the argument. + + Gets or sets the description of the argument. + + The description of the argument. @@ -11570,11 +11570,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -11607,10 +11607,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -11631,34 +11631,34 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - The exception that is thrown when one of the command-line arguments provided - is not valid. - + + The exception that is thrown when one of the command-line arguments provided + is not valid. + @@ -11689,50 +11689,50 @@ The that contains contextual information about the source or destination. - - Used to control parsing of command-line arguments. - + + Used to control parsing of command-line arguments. + - - Indicates that this field is required. An error will be displayed - if it is not present when parsing arguments. - + + Indicates that this field is required. An error will be displayed + if it is not present when parsing arguments. + - - Only valid in conjunction with Multiple. - Duplicate values will result in an error. - + + Only valid in conjunction with Multiple. + Duplicate values will result in an error. + - - Inidicates that the argument may be specified more than once. - Only valid if the argument is a collection - + + Inidicates that the argument may be specified more than once. + Only valid if the argument is a collection + - - Inidicates that if this argument is specified, no other arguments may be specified. - + + Inidicates that if this argument is specified, no other arguments may be specified. + - - The default type for non-collection arguments. - The argument is not required, but an error will be reported if it is specified more than once. - + + The default type for non-collection arguments. + The argument is not required, but an error will be reported if it is specified more than once. + - - The default type for collection arguments. - The argument is permitted to occur multiple times, but duplicate - values will cause an error to be reported. - + + The default type for collection arguments. + The argument is permitted to occur multiple times, but duplicate + values will cause an error to be reported. + - - Commandline parser. - + + Commandline parser. + @@ -11753,27 +11753,27 @@ The of does not match the argument specification that was used to initialize the parser. - - Splits a string and removes any empty strings from the - result. Same functionality as the - public string[] Split(char[] separator, StringSplitOptions options) - method in .Net 2.0. Replace with that call when 2.0 is standard. - - - - the array of strings + + Splits a string and removes any empty strings from the + result. Same functionality as the + public string[] Split(char[] separator, StringSplitOptions options) + method in .Net 2.0. Replace with that call when 2.0 is standard. + + + + the array of strings - - Read a response file and parse the arguments as usual. - - The response file to load arguments + + Read a response file and parse the arguments as usual. + + The response file to load arguments - - Parse the argument list using the - - + + Parse the argument list using the + + @@ -11797,22 +11797,22 @@ - - Gets the usage instructions. - - The usage instructions. + + Gets the usage instructions. + + The usage instructions. - - Gets a value indicating whether no arguments were specified on the - command line. - + + Gets a value indicating whether no arguments were specified on the + command line. + - - Marks a command-line option as being the default option. When the name of - a command-line argument is not specified, this option will be assumed. - + + Marks a command-line option as being the default option. When the name of + a command-line argument is not specified, this option will be assumed. + @@ -11822,42 +11822,42 @@ Specifies the checking to be done on the argument. - - Provides modified version for Copy and Move from the File class that - allow for filter chain processing. - + + Provides modified version for Copy and Move from the File class that + allow for filter chain processing. + - - Copies a file filtering its content through the filter chain. - - The file to copy - The file to copy to - Chain of filters to apply when copying, or is no filters should be applied. - The encoding used to read the soure file. - The encoding used to write the destination file. + + Copies a file filtering its content through the filter chain. + + The file to copy + The file to copy to + Chain of filters to apply when copying, or is no filters should be applied. + The encoding used to read the soure file. + The encoding used to write the destination file. - - Moves a file filtering its content through the filter chain. - - The file to move. - The file to move move to. - Chain of filters to apply when moving, or is no filters should be applied. - The encoding used to read the soure file. - The encoding used to write the destination file. + + Moves a file filtering its content through the filter chain. + + The file to move. + The file to move move to. + Chain of filters to apply when moving, or is no filters should be applied. + The encoding used to read the soure file. + The encoding used to write the destination file. - - Reads a file filtering its content through the filter chain. - - The file to read. - Chain of filters to apply when reading, or is no filters should be applied. - The encoding used to read the file. - - If is , - then the system's ANSI code page will be used to read the file. - + + Reads a file filtering its content through the filter chain. + + The file to read. + Chain of filters to apply when reading, or is no filters should be applied. + The encoding used to read the file. + + If is , + then the system's ANSI code page will be used to read the file. + @@ -11899,33 +11899,33 @@ is . - - Returns the home directory of the current user. - - - The home directory of the current user. - + + Returns the home directory of the current user. + + + The home directory of the current user. + - - Scans a list of directories for the specified filename. - - The list of directories to search. - The name of the file to look for. - Specifies whether the directory should be searched recursively. - - The directories are scanned in the order in which they are defined. - - - The absolute path to the specified file, or null if the file was - not found. - + + Scans a list of directories for the specified filename. + + The list of directories to search. + The name of the file to look for. + Specifies whether the directory should be searched recursively. + + The directories are scanned in the order in which they are defined. + + + The absolute path to the specified file, or null if the file was + not found. + - - Helper class for determining whether assemblies are located in the - Global Assembly Cache. - + + Helper class for determining whether assemblies are located in the + Global Assembly Cache. + @@ -11985,9 +11985,9 @@ - - Holds a value indicating whether the object has been disposed. - + + Holds a value indicating whether the object has been disposed. + @@ -12010,21 +12010,21 @@ - - Determines whether an assembly is installed in the Global - Assembly Cache given its file name or path. - - The name or path of the file that contains the manifest of the assembly. - - if is - installed in the Global Assembly Cache; otherwise, - . - + + Determines whether an assembly is installed in the Global + Assembly Cache given its file name or path. + + The name or path of the file that contains the manifest of the assembly. + + if is + installed in the Global Assembly Cache; otherwise, + . + - - Provides a set of helper methods related to reflection. - + + Provides a set of helper methods related to reflection. + @@ -12056,10 +12056,10 @@ - - Provides resource support to NAnt assemblies. This class cannot - be inherited from. - + + Provides resource support to NAnt assemblies. This class cannot + be inherited from. + @@ -12068,142 +12068,142 @@ - - Registers the assembly to be used as the fallback if resources - aren't found in the local satellite assembly. - - - A that represents the - assembly to register. - - - The following example shows how to register a shared satellite - assembly. - - - - + + Registers the assembly to be used as the fallback if resources + aren't found in the local satellite assembly. + + + A that represents the + assembly to register. + + + The following example shows how to register a shared satellite + assembly. + + + + - - Returns the value of the specified string resource. - - - A that contains the name of the - resource to get. - - - A that contains the value of the - resource localized for the current culture. - - - The returned resource is localized for the cultural settings of the - current . - - The GetString method is thread-safe. - - - - The following example demonstrates the GetString method using - the cultural settings of the current . - - - - + + Returns the value of the specified string resource. + + + A that contains the name of the + resource to get. + + + A that contains the value of the + resource localized for the current culture. + + + The returned resource is localized for the cultural settings of the + current . + + The GetString method is thread-safe. + + + + The following example demonstrates the GetString method using + the cultural settings of the current . + + + + - - Returns the value of the specified string resource localized for - the specified culture. - - - - - A that contains the value of the - resource localized for the specified culture. - - - - The GetString method is thread-safe. - - - - The following example demonstrates the GetString method using - a specific culture. - - - - + + Returns the value of the specified string resource localized for + the specified culture. + + + + + A that contains the value of the + resource localized for the specified culture. + + + + The GetString method is thread-safe. + + + + The following example demonstrates the GetString method using + a specific culture. + + + + - - Returns the value of the specified string resource localized for - the specified culture for the specified assembly. - - - A that contains the name of the - resource to get. - - - A that represents - the culture for which the resource is localized. - - - A - - - A that contains the value of the - resource localized for the specified culture. - - - - The GetString method is thread-safe. - - - - The following example demonstrates the GetString method using - specific culture and assembly. - - - - + + Returns the value of the specified string resource localized for + the specified culture for the specified assembly. + + + A that contains the name of the + resource to get. + + + A that represents + the culture for which the resource is localized. + + + A + + + A that contains the value of the + resource localized for the specified culture. + + + + The GetString method is thread-safe. + + + + The following example demonstrates the GetString method using + specific culture and assembly. + + + + - - Registers the specified assembly. - - - A that represents the - assembly to register. - + + Registers the specified assembly. + + + A that represents the + assembly to register. + - - Determines the manifest resource name of the resource holding the - localized strings. - - The name of the assembly. - - The manifest resource name of the resource holding the localized - strings for the specified assembly. - - - The manifest resource name of the resource holding the localized - strings should match the name of the assembly, minus Tasks - suffix. - + + Determines the manifest resource name of the resource holding the + localized strings. + + The name of the assembly. + + The manifest resource name of the resource holding the localized + strings for the specified assembly. + + + The manifest resource name of the resource holding the localized + strings should match the name of the assembly, minus Tasks + suffix. + @@ -12244,24 +12244,24 @@ - - Converts an empty string ("") to . - - The value to convert. - - if is an empty - string ("") or ; otherwise, . - + + Converts an empty string ("") to . + + The value to convert. + + if is an empty + string ("") or ; otherwise, . + - - Converts to an empty string. - - The value to convert. - - An empty string if is ; - otherwise, . - + + Converts to an empty string. + + The value to convert. + + An empty string if is ; + otherwise, . + @@ -12298,14 +12298,14 @@ - - Thrown whenever an error occurs during the build. - + + Thrown whenever an error occurs during the build. + - - The location of the exception in the build document (xml file). - + + The location of the exception in the build document (xml file). + @@ -12362,155 +12362,155 @@ The destination for this serialization. - - Creates and returns a string representation of the current - exception. - - - A string representation of the current exception. - + + Creates and returns a string representation of the current + exception. + + + A string representation of the current exception. + - - Gets the raw message as specified when the exception was - constructed. - - - The raw message as specified when the exception was - constructed. - + + Gets the raw message as specified when the exception was + constructed. + + + The raw message as specified when the exception was + constructed. + - - Gets the location in the build file of the element from which the - exception originated. - - - The location in the build file of the element from which the - exception originated. - + + Gets the location in the build file of the element from which the + exception originated. + + + The location in the build file of the element from which the + exception originated. + - - Gets a message that describes the current exception. - - - The error message that explains the reason for the exception. - - - Adds location information to the message, if available. - + + Gets a message that describes the current exception. + + + The error message that explains the reason for the exception. + + + Adds location information to the message, if available. + - - Represents the set of command-line options supported by NAnt. - + + Represents the set of command-line options supported by NAnt. + - - Gets or sets the target framework to use (overrides - NAnt.exe.config settings) - - - The framework that should be used. - - - For a list of possible frameworks, see NAnt.exe.config, possible - values include "net-1.0", "net-1.1", etc. - + + Gets or sets the target framework to use (overrides + NAnt.exe.config settings) + + + The framework that should be used. + + + For a list of possible frameworks, see NAnt.exe.config, possible + values include "net-1.0", "net-1.1", etc. + - - Gets or sets the target framework to use (overrides - NAnt.exe.config settings) - - - The framework that should be used. - - - For a list of possible frameworks, see NAnt.exe.config, possible - values include "net-1.0", "net-1.1", etc. - + + Gets or sets the target framework to use (overrides + NAnt.exe.config settings) + + + The framework that should be used. + + + For a list of possible frameworks, see NAnt.exe.config, possible + values include "net-1.0", "net-1.1", etc. + - - Gets or sets the buildfile that should be executed. - - - The buildfile that should be executed. - - - Can be both a file or an URI. - + + Gets or sets the buildfile that should be executed. + + + The buildfile that should be executed. + + + Can be both a file or an URI. + - - Gets or sets a value indicating whether more information should be - displayed during the build process. - - - if more information should be displayed; - otherwise, . The default is . - + + Gets or sets a value indicating whether more information should be + displayed during the build process. + + + if more information should be displayed; + otherwise, . The default is . + - - Gets or sets a value indicating whether debug information should be - displayed during the build process. - - - if debug information should be displayed; - otherwise, . The default is . - + + Gets or sets a value indicating whether debug information should be + displayed during the build process. + + + if debug information should be displayed; + otherwise, . The default is . + - - Gets or sets a value indicating whether only error and debug debug messages should be - displayed during the build process. - - - if only error or warning messages should be - displayed; otherwise, . The default is - . - + + Gets or sets a value indicating whether only error and debug debug messages should be + displayed during the build process. + + + if only error or warning messages should be + displayed; otherwise, . The default is + . + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - if output is to be unadorned so that emacs - and other editors can parse files names, etc. The default is - . - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + if output is to be unadorned so that emacs + and other editors can parse files names, etc. The default is + . + - - Gets a value indicating whether parent directories should be searched - for a buildfile. - - - if parent directories should be searched for - a build file; otherwise, . The default is - . - + + Gets a value indicating whether parent directories should be searched + for a buildfile. + + + if parent directories should be searched for + a build file; otherwise, . The default is + . + - - Gets or sets the indentation level of the build output. - - - The indentation level of the build output. The default is 0. - + + Gets or sets the indentation level of the build output. + + + The indentation level of the build output. The default is 0. + - - Gets or sets the list of properties that should be set. - - - The list of properties that should be set. - + + Gets or sets the list of properties that should be set. + + + The list of properties that should be set. + @@ -12526,12 +12526,12 @@ - - Gets or sets the name of the file to log output to. - - - The name of the file to log output to. - + + Gets or sets the name of the file to log output to. + + + The name of the file to log output to. + @@ -12545,12 +12545,12 @@ - - Gets a collection of assemblies to load extensions from. - - - A collection of assemblies to load extensions from. - + + Gets a collection of assemblies to load extensions from. + + + A collection of assemblies to load extensions from. + @@ -12564,75 +12564,75 @@ - - Gets or sets a value indicating whether the logo banner should be - printed. - - - if the logo banner should be printed; otherwise, - . The default is . - + + Gets or sets a value indicating whether the logo banner should be + printed. + + + if the logo banner should be printed; otherwise, + . The default is . + - - Gets or sets a value indicating whether the NAnt help should be - printed. - - - if NAnt help should be printed; otherwise, - . The default is . - + + Gets or sets a value indicating whether the NAnt help should be + printed. + + + if NAnt help should be printed; otherwise, + . The default is . + - - Gets a collection containing the targets that should be executed. - - - A collection that contains the targets that should be executed. - + + Gets a collection containing the targets that should be executed. + + + A collection that contains the targets that should be executed. + - - Custom configuration section handler for the element. - + + Custom configuration section handler for the element. + - - This just passed things through. Return the node read from the config file. - + + This just passed things through. Return the node read from the config file. + - - Main entry point to NAnt that is called by the ConsoleStub. - + + Main entry point to NAnt that is called by the ConsoleStub. + - - Starts NAnt. This is the Main entry point. - - Command Line args, or whatever you want to pass it. They will treated as Command Line args. - - The exit code. - + + Starts NAnt. This is the Main entry point. + + Command Line args, or whatever you want to pass it. They will treated as Command Line args. + + The exit code. + - - Prints the projecthelp to the console. - - The build file to show help for. - - is loaded and transformed with - ProjectHelp.xslt, which is an embedded resource. - + + Prints the projecthelp to the console. + + The build file to show help for. + + is loaded and transformed with + ProjectHelp.xslt, which is an embedded resource. + - - Gets the file name for the build file in the specified directory. - - The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory. - Look for a build file with this pattern or name. If null look for a file that matches the default build pattern (*.build). - Whether or not to search the parent directories for a build file. - The path to the build file or null if no build file could be found. + + Gets the file name for the build file in the specified directory. + + The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory. + Look for a build file with this pattern or name. If null look for a file that matches the default build pattern (*.build). + Whether or not to search the parent directories for a build file. + The path to the build file or null if no build file could be found. @@ -12681,9 +12681,9 @@ The to add listeners to. - - Spits out generic help info to the console. - + + Spits out generic help info to the console. + @@ -12798,11 +12798,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -12835,10 +12835,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -12859,28 +12859,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -12894,45 +12894,45 @@ - - Inherits Properties from an existing property - dictionary Instance - - DataType list to inherit + + Inherits Properties from an existing property + dictionary Instance + + DataType list to inherit - - Used for searching filesystem based on given include/exclude rules. - - - Simple client code for testing the class. - - while (true) { - DirectoryScanner scanner = new DirectoryScanner(); - Console.Write("Scan Basedirectory : "); - string s = Console.ReadLine(); - if (s.Length == 0) break; - scanner.BaseDirectory = s; - while(true) { - Console.Write("Include pattern : "); - s = Console.ReadLine(); - if (s.Length == 0) break; - scanner.Includes.Add(s); - } - while(true) { - Console.Write("Exclude pattern : "); - s = Console.ReadLine(); - if (s.Length == 0) break; - scanner.Excludes.Add(s); - } - foreach (string name in scanner.FileNames) - Console.WriteLine("file:" + name); - foreach (string name in scanner.DirectoryNames) - Console.WriteLine("dir :" + name); - Console.WriteLine(""); - } - - + + Used for searching filesystem based on given include/exclude rules. + + + Simple client code for testing the class. + + while (true) { + DirectoryScanner scanner = new DirectoryScanner(); + Console.Write("Scan Basedirectory : "); + string s = Console.ReadLine(); + if (s.Length == 0) break; + scanner.BaseDirectory = s; + while(true) { + Console.Write("Include pattern : "); + s = Console.ReadLine(); + if (s.Length == 0) break; + scanner.Includes.Add(s); + } + while(true) { + Console.Write("Exclude pattern : "); + s = Console.ReadLine(); + if (s.Length == 0) break; + scanner.Excludes.Add(s); + } + foreach (string name in scanner.FileNames) + Console.WriteLine("file:" + name); + foreach (string name in scanner.DirectoryNames) + Console.WriteLine("dir :" + name); + Console.WriteLine(""); + } + + @@ -12965,57 +12965,57 @@ - - Parses specified NAnt search patterns for search directories and - corresponding regex patterns. - - In. NAnt patterns. Absolute or relative paths. - Out. Regex patterns. Absolute canonical paths. - Out. Non-regex files. Absolute canonical paths. - In. Whether to allow a pattern to add search directories. + + Parses specified NAnt search patterns for search directories and + corresponding regex patterns. + + In. NAnt patterns. Absolute or relative paths. + Out. Regex patterns. Absolute canonical paths. + Out. Non-regex files. Absolute canonical paths. + In. Whether to allow a pattern to add search directories. - - Given a NAnt search pattern returns a search directory and an regex - search pattern. - - Whether this pattern is an include or exclude pattern - NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported) - Out. Absolute canonical path to the directory to be searched - Out. Whether the pattern is potentially recursive or not - Out. Whether this is a regex pattern or not - Out. Regex search pattern (absolute canonical path) + + Given a NAnt search pattern returns a search directory and an regex + search pattern. + + Whether this pattern is an include or exclude pattern + NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported) + Out. Absolute canonical path to the directory to be searched + Out. Whether the pattern is potentially recursive or not + Out. Whether this is a regex pattern or not + Out. Regex search pattern (absolute canonical path) - - Searches a directory recursively for files and directories matching - the search criteria. - - Directory in which to search (absolute canonical path) - Whether to scan recursively or not + + Searches a directory recursively for files and directories matching + the search criteria. + + Directory in which to search (absolute canonical path) + Whether to scan recursively or not - - Converts search pattern to a regular expression pattern. - - Search pattern relative to the search directory. - Regular expresssion + + Converts search pattern to a regular expression pattern. + + Search pattern relative to the search directory. + Regular expresssion - - Gets or set a value indicating whether or not to use case-sensitive - pattern matching. - + + Gets or set a value indicating whether or not to use case-sensitive + pattern matching. + - - Gets the collection of include patterns. - + + Gets the collection of include patterns. + - - Gets the collection of exclude patterns. - + + Gets the collection of exclude patterns. + @@ -13024,19 +13024,19 @@ - - Gets the list of files that match the given patterns. - + + Gets the list of files that match the given patterns. + - - Gets the list of directories that match the given patterns. - + + Gets the list of directories that match the given patterns. + - - Gets the list of directories that were scanned for files. - + + Gets the list of directories that were scanned for files. + @@ -13047,12 +13047,12 @@ - - Creates a string representing a list of the strings in the collection. - - - A string that represents the contents. - + + Creates a string representing a list of the strings in the collection. + + + A string that represents the contents. + @@ -13102,53 +13102,53 @@ - - Gets a value indicating whether string comparison is case-sensitive. - - - A value indicating whether string comparison is case-sensitive. - + + Gets a value indicating whether string comparison is case-sensitive. + + + A value indicating whether string comparison is case-sensitive. + - - Gets the value of the specified property. - - The name of the property to get the value of. - - The value of the specified property. - + + Gets the value of the specified property. + + The name of the property to get the value of. + + The value of the specified property. + - - Splits an input string into a sequence of tokens used during parsing. - + + Splits an input string into a sequence of tokens used during parsing. + - - Available tokens - + + Available tokens + - - Encalsulates information about installed frameworks incuding version - information and directory locations for finding tools. - + + Encalsulates information about installed frameworks incuding version + information and directory locations for finding tools. + - - Resolves the specified assembly to a full path by matching it - against the reference assemblies. - - The file name of the assembly to resolve (without path information). - - An absolute path to the assembly, or if the - assembly could not be found or no reference assemblies are configured - for the current framework. - - - Whether the file name is matched case-sensitively depends on the - operating system. - + + Resolves the specified assembly to a full path by matching it + against the reference assemblies. + + The file name of the assembly to resolve (without path information). + + An absolute path to the assembly, or if the + assembly could not be found or no reference assemblies are configured + for the current framework. + + + Whether the file name is matched case-sensitively depends on the + operating system. + @@ -13172,47 +13172,47 @@ - - Gets the value of the specified attribute from the specified node. - - The node of which the attribute value should be retrieved. - The attribute of which the value should be returned. - - The value of the attribute with the specified name or - if the attribute does not exist or has no value. - + + Gets the value of the specified attribute from the specified node. + + The node of which the attribute value should be retrieved. + The attribute of which the value should be returned. + + The value of the attribute with the specified name or + if the attribute does not exist or has no value. + - - Gets the name of the framework. - - - The name of the framework. - + + Gets the name of the framework. + + + The name of the framework. + - - Gets the family of the framework. - - - The family of the framework. - + + Gets the family of the framework. + + + The family of the framework. + - - Gets the description of the framework. - - - The description of the framework. - + + Gets the description of the framework. + + + The description of the framework. + - - Gets the vendor of the framework. - - - The vendor of the framework. - + + Gets the vendor of the framework. + + + The vendor of the framework. + @@ -13322,13 +13322,13 @@ The framework is not valid. - - Returns a value indicating whether the current framework is valid. - - - if the framework is installed and correctly - configured; otherwise, . - + + Returns a value indicating whether the current framework is valid. + + + if the framework is installed and correctly + configured; otherwise, . + @@ -13372,134 +13372,134 @@ - - Defines the types of frameworks. - + + Defines the types of frameworks. + - - Frameworks that are supported on the current platform, but are not - installed. - + + Frameworks that are supported on the current platform, but are not + installed. + - - Frameworks that are installed on the current system. - + + Frameworks that are installed on the current system. + - - Retrieves installation state attributes. - + + Retrieves installation state attributes. + - - Frameworks that typically target full desktop devices. - + + Frameworks that typically target full desktop devices. + - - Frameworks that target compact devices. - + + Frameworks that target compact devices. + - - Frameworks that run in a browser. - + + Frameworks that run in a browser. + - - Retrieves device attributes. - + + Retrieves device attributes. + - - Frameworks released as part of the open-source Mono - project. - + + Frameworks released as part of the open-source Mono + project. + - - Frameworks released by Microsoft. - + + Frameworks released by Microsoft. + - - Retrieves vendor attributes. - + + Retrieves vendor attributes. + - - All frameworks supported on the current platform, regarless of their - installation state, target device or vendor. - + + All frameworks supported on the current platform, regarless of their + installation state, target device or vendor. + - - Stores the file name, line number and column number to record a position - in a text file. - + + Stores the file name, line number and column number to record a position + in a text file. + - - Creates a location consisting of a file name, line number and - column number. - - - can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt. - + + Creates a location consisting of a file name, line number and + column number. + + + can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt. + - - Creates a location consisting of a file name. - - - can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt. - + + Creates a location consisting of a file name. + + + can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt. + - - Creates an "unknown" location. - + + Creates an "unknown" location. + - Private Init function. + Private Init function. - - Returns the file name, line number and a trailing space. An error - message can be appended easily. For unknown locations, returns - an empty string. - + + Returns the file name, line number and a trailing space. An error + message can be appended easily. For unknown locations, returns + an empty string. + - - Gets a string containing the file name for the location. - - - The file name includes both the file path and the extension. - + + Gets a string containing the file name for the location. + + + The file name includes both the file path and the extension. + - - Gets the line number for the location. - - - Lines start at 1. Will be zero if not specified. - + + Gets the line number for the location. + + + Lines start at 1. Will be zero if not specified. + - - Gets the column number for the location. - - - Columns start a 1. Will be zero if not specified. - + + Gets the column number for the location. + + + Columns start a 1. Will be zero if not specified. + - - Maps XML nodes to the text positions from their original source. - + + Maps XML nodes to the text positions from their original source. + @@ -13507,14 +13507,14 @@ - - Determines if a file has been loaded by the current project. - - The file to check. - - if the specified file has already been loaded - by the current project; otherwise, . - + + Determines if a file has been loaded by the current project. + + The file to check. + + if the specified file has already been loaded + by the current project; otherwise, . + @@ -13534,9 +13534,9 @@ - - Represents a position in the build file. - + + Represents a position in the build file. + @@ -13547,47 +13547,47 @@ The column coordinate of the position. - - The line coordinate of the position. - + + The line coordinate of the position. + - - The column coordinate of the position. - + + The column coordinate of the position. + - - Defines the set of levels recognised by the NAnt logging system. - + + Defines the set of levels recognised by the NAnt logging system. + - - Designates fine-grained informational events that are most useful - to debug a build process. - + + Designates fine-grained informational events that are most useful + to debug a build process. + - - Designates events that offer a more detailed view of the build - process. - + + Designates events that offer a more detailed view of the build + process. + - - Designates informational events that are useful for getting a - high-level view of the build process. - + + Designates informational events that are useful for getting a + high-level view of the build process. + - - Designates potentionally harmful events. - + + Designates potentionally harmful events. + - - Designates error events. - + + Designates error events. + @@ -13671,20 +13671,20 @@ The that emitted the event. - - Gets or sets the message associated with this event. - - - The message associated with this event. - + + Gets or sets the message associated with this event. + + + The message associated with this event. + - - Gets or sets the priority level associated with this event. - - - The priority level associated with this event. - + + Gets or sets the priority level associated with this event. + + + The priority level associated with this event. + @@ -13729,10 +13729,10 @@ A that contains the event data. - - Instances of classes that implement this interface can register to be - notified when things happen during a build. - + + Instances of classes that implement this interface can register to be + notified when things happen during a build. + @@ -13806,30 +13806,30 @@ - - Flushes buffered build events or messages to the underlying storage. - + + Flushes buffered build events or messages to the underlying storage. + - - Gets or sets the highest level of message this logger should respond - to. - - The highest level of message this logger should respond to. - - Only messages with a message level higher than or equal to the given - level should actually be written to the log. - + + Gets or sets the highest level of message this logger should respond + to. + + The highest level of message this logger should respond to. + + Only messages with a message level higher than or equal to the given + level should actually be written to the log. + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - if output is to be unadorned so that emacs - and other editors can parse files names, etc. - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + if output is to be unadorned so that emacs + and other editors can parse files names, etc. + @@ -13844,9 +13844,9 @@ - - Flushes buffered build events or messages to the underlying storage. - + + Flushes buffered build events or messages to the underlying storage. + @@ -13914,11 +13914,11 @@ - - Empty implementation which allows derived classes to receive the - output that is generated in this logger. - - The message being logged. + + Empty implementation which allows derived classes to receive the + output that is generated in this logger. + + The message being logged. @@ -13948,33 +13948,33 @@ The number of characters that the message should be indented. - - Holds a stack of reports for all running builds. - + + Holds a stack of reports for all running builds. + - - Gets or sets the highest level of message this logger should respond - to. - - - The highest level of message this logger should respond to. - - - Only messages with a message level higher than or equal to the given - level should be written to the log. - + + Gets or sets the highest level of message this logger should respond + to. + + + The highest level of message this logger should respond to. + + + Only messages with a message level higher than or equal to the given + level should be written to the log. + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - if output is to be unadorned so that emacs - and other editors can parse files names, etc. The default is - . - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + if output is to be unadorned so that emacs + and other editors can parse files names, etc. The default is + . + @@ -13986,100 +13986,100 @@ - - Used to store information about a build, to allow better reporting to - the user. - + + Used to store information about a build, to allow better reporting to + the user. + - - Errors encountered so far. - + + Errors encountered so far. + - - Warnings encountered so far. - + + Warnings encountered so far. + - - The start time of the build process. - + + The start time of the build process. + - - Buffers log messages from DefaultLogger, and sends an e-mail with the - results. - - - The following properties are used to send the mail : - - - Property - Description - - - MailLogger.mailhost - Mail server to use. [default: localhost] - - - MailLogger.from - The address of the e-mail sender. - - - MailLogger.failure.notify - Send build failure e-mails ? [default: true] - - - MailLogger.success.notify - Send build success e-mails ? [default: true] - - - MailLogger.failure.to - The address to send build failure messages to. - - - MailLogger.success.to - The address to send build success messages to. - - - MailLogger.failure.subject - The subject of build failure messages. [default: "Build Failure"] - - - MailLogger.success.subject - The subject of build success messages. [default: "Build Success"] - - - MailLogger.success.attachments - The ID of a fileset holdng set of files to attach when the build is successful. - - - MailLogger.failure.attachments - The ID of a fileset holdng set of files to attach when the build fails. - - - MailLogger.body.encoding - The encoding type of the body of the e-mail message. [default: system's ANSI code page] - - - MailLogger.smtp.username - The name of the user to login to the SMTP server. - - - MailLogger.smtp.password - The password of the specified user. - - - MailLogger.smtp.enablessl - Specifies whether to use SSL to encrypt the connection. [default: false] - - - MailLogger.smtp.port - The SMTP server port to connect to. [default: 25] - - - + + Buffers log messages from DefaultLogger, and sends an e-mail with the + results. + + + The following properties are used to send the mail : + + + Property + Description + + + MailLogger.mailhost + Mail server to use. [default: localhost] + + + MailLogger.from + The address of the e-mail sender. + + + MailLogger.failure.notify + Send build failure e-mails ? [default: true] + + + MailLogger.success.notify + Send build success e-mails ? [default: true] + + + MailLogger.failure.to + The address to send build failure messages to. + + + MailLogger.success.to + The address to send build success messages to. + + + MailLogger.failure.subject + The subject of build failure messages. [default: "Build Failure"] + + + MailLogger.success.subject + The subject of build success messages. [default: "Build Success"] + + + MailLogger.success.attachments + The ID of a fileset holdng set of files to attach when the build is successful. + + + MailLogger.failure.attachments + The ID of a fileset holdng set of files to attach when the build fails. + + + MailLogger.body.encoding + The encoding type of the body of the e-mail message. [default: system's ANSI code page] + + + MailLogger.smtp.username + The name of the user to login to the SMTP server. + + + MailLogger.smtp.password + The password of the specified user. + + + MailLogger.smtp.enablessl + Specifies whether to use SSL to encrypt the connection. [default: false] + + + MailLogger.smtp.port + The SMTP server port to connect to. [default: 25] + + + @@ -14106,10 +14106,10 @@ A object that contains the event data. - - Receives and buffers log messages. - - The message being logged. + + Receives and buffers log messages. + + The message being logged. @@ -14126,14 +14126,14 @@ is , and the specified property is not present and no default value has been given. - - Buffer in which the message is constructed prior to sending. - + + Buffer in which the message is constructed prior to sending. + - - Holds the stack of currently executing projects. - + + Holds the stack of currently executing projects. + @@ -14189,11 +14189,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -14226,10 +14226,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -14244,28 +14244,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -14284,46 +14284,46 @@ An object that controls formatting. - - Writes a character array to the buffer. - - The character array to write to the text stream. + + Writes a character array to the buffer. + + The character array to write to the text stream. - - Writes a string to the buffer. - - + + Writes a string to the buffer. + + - - Writes an empty string to the logging infrastructure. - + + Writes an empty string to the logging infrastructure. + - - Writes a string to the logging infrastructure. - - The string to write. If is a null reference, only the line termination characters are written. + + Writes a string to the logging infrastructure. + + The string to write. If is a null reference, only the line termination characters are written. - - Writes out a formatted string using the same semantics as - . - - The formatting string. - The object array to write into format string. + + Writes out a formatted string using the same semantics as + . + + The formatting string. + The object array to write into format string. - - Causes any buffered data to be written to the logging infrastructure. - + + Causes any buffered data to be written to the logging infrastructure. + - - Closes the current writer and releases any system resources - associated with the writer. - + + Closes the current writer and releases any system resources + associated with the writer. + @@ -14353,19 +14353,19 @@ - - Used to search for files on the PATH. - - - - The local directory is not searched (since this would already be covered - by normal use of the includes element). - - - Also, advanced pattern matching isn't supported: you need to know the - exact name of the file. - - + + Used to search for files on the PATH. + + + + The local directory is not searched (since this would already be covered + by normal use of the includes element). + + + Also, advanced pattern matching isn't supported: you need to know the + exact name of the file. + + @@ -14384,28 +14384,28 @@ - - Adds a file to the list of files to be scanned for. - - The filename or search pattern to add to the list. + + Adds a file to the list of files to be scanned for. + + The filename or search pattern to add to the list. - - Scans all direcetories in the PATH environment variable for files. - - - List of matching files found in the PATH. - + + Scans all direcetories in the PATH environment variable for files. + + + List of matching files found in the PATH. + - - Scans all directories in the given environment variable for files. - - The environment variable of which the directories should be scanned. - - List of matching files found in the directory of the given - environment variable. - + + Scans all directories in the given environment variable for files. + + The environment variable of which the directories should be scanned. + + List of matching files found in the directory of the given + environment variable. + @@ -14417,35 +14417,35 @@ - - Returns a value indicating whether NAnt is running in 64-bit mode. - - - if NAnt is running in 64-bit mode; otherwise, - . - + + Returns a value indicating whether NAnt is running in 64-bit mode. + + + if NAnt is running in 64-bit mode; otherwise, + . + - - Returns a value indicating whether NAnt is running in 32-bit mode. - - - Note that even if the platform is 64-bit, NAnt may be running in - 32-bit mode. - - - if NAnt is running in 32-bit mode; otherwise, - . - + + Returns a value indicating whether NAnt is running in 32-bit mode. + + + Note that even if the platform is 64-bit, NAnt may be running in + 32-bit mode. + + + if NAnt is running in 32-bit mode; otherwise, + . + - - Returns a value indicating whether NAnt is running on Windows. - - - if NAnt is running on Windows; - otherwise, . - + + Returns a value indicating whether NAnt is running on Windows. + + + if NAnt is running on Windows; + otherwise, . + @@ -14477,26 +14477,26 @@ - - Constant for the "visiting" state, used when traversing a DFS of - target dependencies. - + + Constant for the "visiting" state, used when traversing a DFS of + target dependencies. + - - Constant for the "visited" state, used when traversing a DFS of - target dependencies. - + + Constant for the "visited" state, used when traversing a DFS of + target dependencies. + - - Holds the logger for this class. - + + Holds the logger for this class. + - - Holds the default threshold for build loggers. - + + Holds the default threshold for build loggers. + @@ -14742,33 +14742,33 @@ - - Executes a specific target, and its dependencies. - - The name of the target to execute. - - Global tasks are not executed. - + + Executes a specific target, and its dependencies. + + The name of the target to execute. + + Global tasks are not executed. + - - Executes a specific target. - - The name of the target to execute. - Whether dependencies should be forced to execute - - Global tasks are not executed. - + + Executes a specific target. + + The name of the target to execute. + Whether dependencies should be forced to execute + + Global tasks are not executed. + - - Executes the default target and wraps in error handling and time - stamping. - - - if the build was successful; otherwise, - . - + + Executes the default target and wraps in error handling and time + stamping. + + + if the build was successful; otherwise, + . + @@ -14971,20 +14971,20 @@ - - Gets or sets the indentation size of the build output. - - - The indendation size of the build output. - + + Gets or sets the indentation size of the build output. + + + The indendation size of the build output. + - - Gets or sets the default threshold level for build loggers. - - - The default threshold level for build loggers. - + + Gets or sets the default threshold level for build loggers. + + + The default threshold level for build loggers. + @@ -15031,20 +15031,20 @@ - - Gets a collection of available .NET frameworks. - - - A collection of available .NET frameworks. - + + Gets a collection of available .NET frameworks. + + + A collection of available .NET frameworks. + - - Gets the framework in which NAnt is currently running. - - - The framework in which NAnt is currently running. - + + Gets the framework in which NAnt is currently running. + + + The framework in which NAnt is currently running. + @@ -15083,22 +15083,22 @@ NAnt does not support the current platform. - - Gets the current target. - - - The current target, or if no target is - executing. - + + Gets the current target. + + + The current target, or if no target is + executing. + - - Gets the path to the build file. - - - The path to the build file, or if the build - document is not file backed. - + + Gets the path to the build file. + + + The path to the build file, or if the build + document is not file backed. + @@ -15119,70 +15119,70 @@ - - Gets the name of the target that will be executed when no other - build targets are specified. - - - The name of the target that will be executed when no other - build targets are specified, or if no - default target is specified in the build file. - + + Gets the name of the target that will be executed when no other + build targets are specified. + + + The name of the target that will be executed when no other + build targets are specified, or if no + default target is specified in the build file. + - - Gets a value indicating whether tasks should output more build log - messages. - - - if tasks should output more build log message; - otherwise, . - + + Gets a value indicating whether tasks should output more build log + messages. + + + if tasks should output more build log message; + otherwise, . + - - The list of targets to build. - - - Targets are built in the order they appear in the collection. If - the collection is empty the default target will be built. - + + The list of targets to build. + + + Targets are built in the order they appear in the collection. If + the collection is empty the default target will be built. + - - Gets the properties defined in this project. - - The properties defined in this project. - - - This is the collection of properties that are defined by the system - and property task statements. - - - These properties can be used in expansion. - - + + Gets the properties defined in this project. + + The properties defined in this project. + + + This is the collection of properties that are defined by the system + and property task statements. + + + These properties can be used in expansion. + + - - Gets the framework-neutral properties defined in the NAnt - configuration file. - - - The framework-neutral properties defined in the NAnt configuration - file. - - - - This is the collection of read-only properties that are defined in - the NAnt configuration file. - - - These properties can only be used for expansion in framework-specific - and framework-neutral configuration settings. These properties are - not available for expansion in the build file. - - + + Gets the framework-neutral properties defined in the NAnt + configuration file. + + + The framework-neutral properties defined in the NAnt configuration + file. + + + + This is the collection of read-only properties that are defined in + the NAnt configuration file. + + + These properties can only be used for expansion in framework-specific + and framework-neutral configuration settings. These properties are + not available for expansion in the build file. + + @@ -15199,51 +15199,51 @@ - - Gets the targets defined in this project. - - - The targets defined in this project. - + + Gets the targets defined in this project. + + + The targets defined in this project. + - - Gets the build listeners for this project. - - - The build listeners for this project. - + + Gets the build listeners for this project. + + + The build listeners for this project. + - - Allow the project construction to be optimized. - - - Use this with care! - + + Allow the project construction to be optimized. + + + Use this with care! + - - Do not perform any optimizations. - + + Do not perform any optimizations. + - - The project base directory must not be automatically scanned - for extension assemblies. - + + The project base directory must not be automatically scanned + for extension assemblies. + - - Do not scan the project configuration for frameworks, and - do not configure the runtime and target framework. - + + Do not scan the project configuration for frameworks, and + do not configure the runtime and target framework. + - - Holds a value indicating whether a scan for tasks, types and functions - has already been performed for the current runtime framework. - + + Holds a value indicating whether a scan for tasks, types and functions + has already been performed for the current runtime framework. + @@ -15272,15 +15272,15 @@ An representing global properties. - - Gets the value of the specified attribute from the specified node. - - The node of which the attribute value should be retrieved. - The attribute of which the value should be returned. - - The value of the attribute with the specified name or - if the attribute does not exist or has no value. - + + Gets the value of the specified attribute from the specified node. + + The node of which the attribute value should be retrieved. + The attribute of which the value should be returned. + + The value of the attribute with the specified name or + if the attribute does not exist or has no value. + @@ -15303,16 +15303,16 @@ - - Constant for the "visiting" state, used when traversing a DFS of - property references. - + + Constant for the "visiting" state, used when traversing a DFS of + property references. + - - Constant for the "visited" state, used when travesing a DFS of - property references. - + + Constant for the "visited" state, used when travesing a DFS of + property references. + @@ -15339,12 +15339,12 @@ The value of the element to remove. - - Performs additional custom processes when validating the element - with the specified key and value. - - The key of the element to validate. - The value of the element to validate. + + Performs additional custom processes when validating the element + with the specified key and value. + + The key of the element to validate. + The value of the element to validate. @@ -15358,45 +15358,45 @@ - - Marks a property as a property of which the value is expanded at - execution time. - - The name of the property to mark as dynamic. + + Marks a property as a property of which the value is expanded at + execution time. + + The name of the property to mark as dynamic. - - Adds a property to the collection. - - The name of the property. - The value to assign to the property. + + Adds a property to the collection. + + The name of the property. + The value to assign to the property. - - Determines whether the specified property is listed as read-only. - - The name of the property to check. - - if the property is listed as read-only; - otherwise, . - + + Determines whether the specified property is listed as read-only. + + The name of the property to check. + + if the property is listed as read-only; + otherwise, . + - - Determines whether the specified property is listed as dynamic. - - The name of the property to check. - - if the property is listed as dynamic; - otherwise, . - + + Determines whether the specified property is listed as dynamic. + + The name of the property to check. + + if the property is listed as dynamic; + otherwise, . + - - Inherits properties from an existing property dictionary Instance. - - Property list to inherit. - The list of properties to exclude during inheritance. + + Inherits properties from an existing property dictionary Instance. + + Property list to inherit. + The list of properties to exclude during inheritance. @@ -15407,20 +15407,20 @@ The expanded and replaced string. - - Determines whether a property already exists. - - The name of the property to check. - - if the specified property already exists; - otherwise, . - + + Determines whether a property already exists. + + The name of the property to check. + + if the specified property already exists; + otherwise, . + - - Removes the property with the specified name. - - The name of the property to remove. + + Removes the property with the specified name. + + The name of the property to remove. @@ -15433,20 +15433,20 @@ The expanded and replaced string. - - Evaluates the given expression string and returns the result - - - - - - + + Evaluates the given expression string and returns the result + + + + + + - - Checks whether the specified property is deprecated. - - The property to check. + + Checks whether the specified property is deprecated. + + The property to check. @@ -15461,33 +15461,33 @@ - - Maintains a list of the property names that are readonly. - + + Maintains a list of the property names that are readonly. + - - Maintains a list of the property names of which the value is expanded - on usage, not at initalization. - + + Maintains a list of the property names of which the value is expanded + on usage, not at initalization. + - - The project for which the dictionary holds properties. - + + The project for which the dictionary holds properties. + - - Indexer property. - + + Indexer property. + - - Gets the project for which the dictionary holds properties. - - - The project for which the dictionary holds properties. - + + Gets the project for which the dictionary holds properties. + + + The project for which the dictionary holds properties. + @@ -15511,14 +15511,14 @@ - - Executes dependent targets first, then the target. - + + Executes dependent targets first, then the target. + - - This indicates whether the target has already executed. - + + This indicates whether the target has already executed. + @@ -15536,19 +15536,19 @@ - - If then the target will be executed; - otherwise, skipped. The default is . - + + If then the target will be executed; + otherwise, skipped. The default is . + - - Gets a value indicating whether the target should be executed. - - - if the target should be executed; otherwise, - . - + + Gets a value indicating whether the target should be executed. + + + if the target should be executed; otherwise, + . + @@ -15558,29 +15558,29 @@ - - Gets a value indicating whether the target should NOT be executed. - - - if the target should NOT be executed; - otherwise, . - + + Gets a value indicating whether the target should NOT be executed. + + + if the target should NOT be executed; + otherwise, . + - - The description of the target. - + + The description of the target. + - - Space separated list of targets that this target depends on. - + + Space separated list of targets that this target depends on. + - - A collection of target names that must be executed before this - target. - + + A collection of target names that must be executed before this + target. + @@ -15719,11 +15719,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -15756,10 +15756,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -15780,34 +15780,34 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Comprises all of the loaded, and available, tasks. - Use these static methods to register, initialize and create a task. - + + Comprises all of the loaded, and available, tasks. + Use these static methods to register, initialize and create a task. + @@ -15836,11 +15836,11 @@ indicating whether scanning of the directory should halt on first error. - - Adds any task assemblies in the project base directory - and its tasks subdirectory. - - The project to work from. + + Adds any task assemblies in the project base directory + and its tasks subdirectory. + + The project to work from. @@ -15995,14 +15995,14 @@ The that contains contextual information about the source or destination. - - Used to wrap log messages in xml <message/> elements. - + + Used to wrap log messages in xml <message/> elements. + - - Holds the stack of currently executing projects. - + + Holds the stack of currently executing projects. + @@ -16026,9 +16026,9 @@ The destination for this serialization. - - Returns the contents of log captured. - + + Returns the contents of log captured. + @@ -16096,31 +16096,31 @@ - - Flushes buffered build events or messages to the underlying storage. - + + Flushes buffered build events or messages to the underlying storage. + - - Gets or sets the highest level of message this logger should respond - to. - - - The highest level of message this logger should respond to. - - - Only messages with a message level higher than or equal to the given - level should be written to the log. - + + Gets or sets the highest level of message this logger should respond + to. + + + The highest level of message this logger should respond to. + + + Only messages with a message level higher than or equal to the given + level should be written to the log. + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - as it has no meaning in XML format. - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + as it has no meaning in XML format. + diff --git a/example_scripts/Tools/nant/bin/NAnt.DotNetTasks.xml b/example_scripts/Tools/nant/bin/NAnt.DotNetTasks.xml index afce140..731a070 100644 --- a/example_scripts/Tools/nant/bin/NAnt.DotNetTasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.DotNetTasks.xml @@ -63,9 +63,9 @@ - - Generates an AssemblyInfo file. - + + Generates an AssemblyInfo file. + @@ -79,66 +79,66 @@ - - Name of the AssemblyInfo file to generate. - - - The name of the AssemblyInfo file to generate. - + + Name of the AssemblyInfo file to generate. + + + The name of the AssemblyInfo file to generate. + - - The code language in which the AssemblyInfo file should be - generated. - + + The code language in which the AssemblyInfo file should be + generated. + - - The assembly-level attributes to generate. - - - The assembly-level attributes to generate. - + + The assembly-level attributes to generate. + + + The assembly-level attributes to generate. + - - The namespaces to import. - - - The namespaces to import. - + + The namespaces to import. + + + The namespaces to import. + - - Assembly files used to locate the types of the specified attributes. - + + Assembly files used to locate the types of the specified attributes. + - - Defines the supported code languages for generating an AssemblyInfo - file. - + + Defines the supported code languages for generating an AssemblyInfo + file. + - - A value for generating C# code. - + + A value for generating C# code. + - - A value for generating JScript code. - + + A value for generating JScript code. + - - A value for generating Visual Basic code. - + + A value for generating Visual Basic code. + - - Encapsulates functionality to generate a code file with imports - and assembly-level attributes. - + + Encapsulates functionality to generate a code file with imports + and assembly-level attributes. + @@ -216,66 +216,66 @@ - - Wraps al.exe, the assembly linker for the .NET Framework. - - - - All specified sources will be embedded using the /embed flag. - Other source types are not supported. - - - - - Create a library containing all icon files in the current directory. - - - - - - - - ]]> - - - - - Create an executable assembly manifest from modules. - - - - - - - - - ]]> - - + + Wraps al.exe, the assembly linker for the .NET Framework. + + + + All specified sources will be embedded using the /embed flag. + Other source types are not supported. + + + + + Create a library containing all icon files in the current directory. + + + + + + + + ]]> + + + + + Create an executable assembly manifest from modules. + + + + + + + + + ]]> + + - - Generates an assembly manifest. - + + Generates an assembly manifest. + - - Determines whether the assembly manifest needs compiling or is - uptodate. - - - if the assembly manifest needs compiling; - otherwise, . - + + Determines whether the assembly manifest needs compiling or is + uptodate. + + + if the assembly manifest needs compiling; + otherwise, . + - - Specifies an algorithm (in hexadecimal) to hash all files in a - multifile assembly except the file that contains the assembly - manifest. The default algorithm is CALG_SHA1. - + + Specifies an algorithm (in hexadecimal) to hash all files in a + multifile assembly except the file that contains the assembly + manifest. The default algorithm is CALG_SHA1. + @@ -314,21 +314,21 @@ - - The culture string associated with the output assembly. - The string must be in RFC 1766 format, such as "en-US". - - - - Corresponds with the /c[ulture]: flag. - - + + The culture string associated with the output assembly. + The string must be in RFC 1766 format, such as "en-US". + + + + Corresponds with the /c[ulture]: flag. + + - - Specifies whether the assembly should be partially signed. The default - is . - + + Specifies whether the assembly should be partially signed. The default + is . + @@ -343,199 +343,199 @@ - - Security evidence file to embed. - - - The security evidence file to embed. - - - - Corresponds with the /e[vidence] flag. - - + + Security evidence file to embed. + + + The security evidence file to embed. + + + + Corresponds with the /e[vidence] flag. + + - - Specifies a string for the File Version field in the assembly. - - - A string for the File Version field in the assembly. - + + Specifies a string for the File Version field in the assembly. + + + A string for the File Version field in the assembly. + - - Specifies a value (in hexadecimal) for the Flags field in - the assembly. - - - A value (in hexadecimal) for the Flags field in the assembly. - + + Specifies a value (in hexadecimal) for the Flags field in + the assembly. + + + A value (in hexadecimal) for the Flags field in the assembly. + - - Specifies a container that holds a key pair. - + + Specifies a container that holds a key pair. + - - Specifies a file (filename) that contains a key pair or - just a public key to sign an assembly. - - - The complete path to the key file. - - - - Corresponds with the /keyf[ile]: flag. - - + + Specifies a file (filename) that contains a key pair or + just a public key to sign an assembly. + + + The complete path to the key file. + + + + Corresponds with the /keyf[ile]: flag. + + - - Specifies the fully-qualified name (class.method) of the method to - use as an entry point when converting a module to an executable file. - - - The fully-qualified name (class.method) of the method to use as an - entry point when converting a module to an executable file. - + + Specifies the fully-qualified name (class.method) of the method to + use as an entry point when converting a module to an executable file. + + + The fully-qualified name (class.method) of the method to use as an + entry point when converting a module to an executable file. + - - One or more modules to be compiled into an assembly. - + + One or more modules to be compiled into an assembly. + - - The name of the output file for the assembly manifest. - - - The complete output path for the assembly manifest. - - - - Corresponds with the /out flag. - - + + The name of the output file for the assembly manifest. + + + The complete output path for the assembly manifest. + + + + Corresponds with the /out flag. + + - - The target type (one of lib, exe, or winexe). - - - - Corresponds with the /t[arget]: flag. - - + + The target type (one of lib, exe, or winexe). + + + + Corresponds with the /t[arget]: flag. + + - - Specifies a string for the Product field in the assembly. - - - A string for the Product field in the assembly. - + + Specifies a string for the Product field in the assembly. + + + A string for the Product field in the assembly. + - - Specifies a string for the Product Version field in the assembly. - - - A string for the Product Version field in the assembly. - + + Specifies a string for the Product Version field in the assembly. + + + A string for the Product Version field in the assembly. + - - The set of resources to embed. - + + The set of resources to embed. + - - The set of compiled resources to embed. - - - Do not yet expose this to build authors. - + + The set of compiled resources to embed. + + + Do not yet expose this to build authors. + - - Indicates whether the assembly linker for a given target framework - supports the "template" option, which takes an assembly from which - to get all options except the culture field. - The default is . - - - TODO: remove this once Mono bug #74814 is fixed. - + + Indicates whether the assembly linker for a given target framework + supports the "template" option, which takes an assembly from which + to get all options except the culture field. + The default is . + + + TODO: remove this once Mono bug #74814 is fixed. + - - Specifies an assembly from which to get all options except the - culture field. - - - The complete path to the assembly template. - - - - Corresponds with the /template: flag. - - + + Specifies an assembly from which to get all options except the + culture field. + + + The complete path to the assembly template. + + + + Corresponds with the /template: flag. + + - - Specifies a string for the Title field in the assembly. - - - A string for the Title field in the assembly. - + + Specifies a string for the Title field in the assembly. + + + A string for the Title field in the assembly. + - - Specifies a string for the Trademark field in the assembly. - - - A string for the Trademark field in the assembly. - + + Specifies a string for the Trademark field in the assembly. + + + A string for the Trademark field in the assembly. + - - Specifies version information for the assembly. The format of the - version string is major.minor.build.revision. - + + Specifies version information for the assembly. The format of the + version string is major.minor.build.revision. + - - Icon to associate with the assembly. - + + Icon to associate with the assembly. + - - Inserts a Win32 resource (.res file) in the output file. - + + Inserts a Win32 resource (.res file) in the output file. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program or - if the task is not being executed. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program or + if the task is not being executed. + - - Provides the abstract base class for compiler tasks. - + + Provides the abstract base class for compiler tasks. + - - Contains a list of extensions for all file types that should be treated as - 'code-behind' when looking for resources. Ultimately this will determine - if we use the "namespace+filename" or "namespace+classname" algorithm, since - code-behind will use the "namespace+classname" algorithm. - + + Contains a list of extensions for all file types that should be treated as + 'code-behind' when looking for resources. Ultimately this will determine + if we use the "namespace+filename" or "namespace+classname" algorithm, since + code-behind will use the "namespace+classname" algorithm. + @@ -552,9 +552,9 @@ - - Compiles the sources and resources. - + + Compiles the sources and resources. + @@ -585,14 +585,14 @@ - - Extracts the associated namespace/classname linkage found in the - given stream. - - The read-only stream of the source file to search. - - The namespace/classname of the source file matching the resource. - + + Extracts the associated namespace/classname linkage found in the + given stream. + + The read-only stream of the source file to search. + + The namespace/classname of the source file matching the resource. + @@ -654,39 +654,39 @@ - - Determines whether compilation is needed. - + + Determines whether compilation is needed. + - - Finds the correct namespace/classname for a resource file from the - given dependent source file. - - The file from which the resource linkage of the resource file should be determined. - The culture of the resource file for which the resource linkage should be determined. - - The namespace/classname of the source file matching the resource or - if the dependent source file does not exist. - - - This behaviour may be overidden by each particular compiler to - support the namespace/classname syntax for that language. - + + Finds the correct namespace/classname for a resource file from the + given dependent source file. + + The file from which the resource linkage of the resource file should be determined. + The culture of the resource file for which the resource linkage should be determined. + + The namespace/classname of the source file matching the resource or + if the dependent source file does not exist. + + + This behaviour may be overidden by each particular compiler to + support the namespace/classname syntax for that language. + - - Link a list of files into a resource assembly. - - The collection of resources. - Resource assembly to generate - Culture of the generated assembly. + + Link a list of files into a resource assembly. + + The collection of resources. + Resource assembly to generate + Culture of the generated assembly. - - Compiles a set of resx files to a .resources files. - - The set of resx files to compile. + + Compiles a set of resx files to a .resources files. + + The set of resx files to compile. @@ -701,161 +701,161 @@ - - Generate debug output. The default is . - - - Only used for <jsc> tasks, but retained for backward - compatibility (Clover.NET). - + + Generate debug output. The default is . + + + Only used for <jsc> tasks, but retained for backward + compatibility (Clover.NET). + - - The output file created by the compiler. - + + The output file created by the compiler. + - - Output type. Possible values are exe, winexe, - library or module. - + + Output type. Possible values are exe, winexe, + library or module. + - - Define conditional compilation symbol(s). - - - - Corresponds to /d[efine]: flag. - - + + Define conditional compilation symbol(s). + + + + Corresponds to /d[efine]: flag. + + - - Icon to associate with the application. - - - - Corresponds to /win32icon: flag. - - + + Icon to associate with the application. + + + + Corresponds to /win32icon: flag. + + - - Specifies a Win32 resource file (.res). - - - - Corresponds to /win32res[ource]: flag. - - + + Specifies a Win32 resource file (.res). + + + + Corresponds to /win32res[ource]: flag. + + - - Instructs the compiler to treat all warnings as errors. The default - is . - - - - Corresponds to the /warnaserror[+|-] flag of the compiler. - - - When this property is set to , any messages - that would ordinarily be reported as warnings will instead be - reported as errors. - - + + Instructs the compiler to treat all warnings as errors. The default + is . + + + + Corresponds to the /warnaserror[+|-] flag of the compiler. + + + When this property is set to , any messages + that would ordinarily be reported as warnings will instead be + reported as errors. + + - - Controls which warnings should be reported as errors. - + + Controls which warnings should be reported as errors. + - - Specifies a comma-separated list of warnings that should be suppressed - by the compiler. - - - Comma-separated list of warnings that should be suppressed by the - compiler. - - - - Corresponds with the /nowarn flag. - - + + Specifies a comma-separated list of warnings that should be suppressed + by the compiler. + + + Comma-separated list of warnings that should be suppressed by the + compiler. + + + + Corresponds with the /nowarn flag. + + - - Specifies a list of warnings that you want the compiler to suppress. - + + Specifies a list of warnings that you want the compiler to suppress. + - - Instructs NAnt to recompile the output file regardless of the file timestamps. - - - When this parameter is to , NAnt will always - run the compiler to rebuild the output file, regardless of the file timestamps. - + + Instructs NAnt to recompile the output file regardless of the file timestamps. + + + When this parameter is to , NAnt will always + run the compiler to rebuild the output file, regardless of the file timestamps. + - - Specifies which type contains the Main method that you want to use - as the entry point into the program. - - - - Corresponds to the /m[ain]: flag of the compiler. - - - Use this property when creating an executable file. If this property - is not set, the compiler searches for a valid Main method in all - public classes. - - + + Specifies which type contains the Main method that you want to use + as the entry point into the program. + + + + Corresponds to the /m[ain]: flag of the compiler. + + + Use this property when creating an executable file. If this property + is not set, the compiler searches for a valid Main method in all + public classes. + + - - Specifies the key pair container used to strongname the assembly. - + + Specifies the key pair container used to strongname the assembly. + - - Specifies a strong name key file. - + + Specifies a strong name key file. + - - Specifies whether to delay sign the assembly using only the public - portion of the strong name key. The default is - . - + + Specifies whether to delay sign the assembly using only the public + portion of the strong name key. The default is + . + - - Additional directories to search in for assembly references. - - - - Corresponds with the /lib[path]: flag. - - - - - - Reference metadata from the specified assembly files. - - - - - Specifies list of packages to reference. - - - - Resources to embed. + Additional directories to search in for assembly references. + + + + Corresponds with the /lib[path]: flag. + + + + + + Reference metadata from the specified assembly files. + + + + + Specifies list of packages to reference. + + + + + Resources to embed. @@ -881,85 +881,85 @@ - - Link the specified modules into this assembly. - + + Link the specified modules into this assembly. + - - The set of source files for compilation. - + + The set of source files for compilation. + - - Indicates whether package references are supported by compiler for - a given target framework. The default is . - + + Indicates whether package references are supported by compiler for + a given target framework. The default is . + - - Indicates whether the compiler for a given target framework supports - the "warnaserror" option that takes a list of warnings. The default - is . - + + Indicates whether the compiler for a given target framework supports + the "warnaserror" option that takes a list of warnings. The default + is . + - - Indicates whether the compiler for a given target framework supports - a command line option that allows a list of warnings to be - suppressed. The default is . - + + Indicates whether the compiler for a given target framework supports + a command line option that allows a list of warnings to be + suppressed. The default is . + - - Indicates whether the compiler for a given target framework supports - the "keycontainer" option. The default is . - + + Indicates whether the compiler for a given target framework supports + the "keycontainer" option. The default is . + - - Indicates whether the compiler for a given target framework supports - the "keyfile" option. The default is . - + + Indicates whether the compiler for a given target framework supports + the "keyfile" option. The default is . + - - Indicates whether the compiler for a given target framework supports - the "delaysign" option. The default is . - + + Indicates whether the compiler for a given target framework supports + the "delaysign" option. The default is . + - - Gets the file extension required by the current compiler. - - - The file extension required by the current compiler. - + + Gets the file extension required by the current compiler. + + + The file extension required by the current compiler. + - - Gets the class name regular expression for the language of the current compiler. - - class name regular expression for the language of the current compiler + + Gets the class name regular expression for the language of the current compiler. + + class name regular expression for the language of the current compiler - - Gets the namespace regular expression for the language of the current compiler. - - namespace regular expression for the language of the current compiler + + Gets the namespace regular expression for the language of the current compiler. + + namespace regular expression for the language of the current compiler - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Holds class and namespace information for resource (*.resx) linkage. - + + Holds class and namespace information for resource (*.resx) linkage. + @@ -970,12 +970,12 @@ The class name the resource is associated with. - - Returns the resource linkage as a string. - - - A string representation of the resource linkage. - + + Returns the resource linkage as a string. + + + A string representation of the resource linkage. + @@ -1010,29 +1010,29 @@ - - Gets the name of namespace the resource is under. - - - The name of namespace the resource is under. - + + Gets the name of namespace the resource is under. + + + The name of namespace the resource is under. + - - Gets the name of the class (most likely a form) that the resource - is associated with. - - - The name of the class the resource is associated with. - + + Gets the name of the class (most likely a form) that the resource + is associated with. + + + The name of the class the resource is associated with. + - - Gets the culture that the resource is associated with. - - - The culture that the resource is associated with. - + + Gets the culture that the resource is associated with. + + + The culture that the resource is associated with. + @@ -1079,29 +1079,29 @@ to which the compiler options should be written. - - Determines whether compilation is needed. - + + Determines whether compilation is needed. + - - The preferred base address at which to load a DLL. The default base - address for a DLL is set by the .NET Framework common language - runtime. - - - The preferred base address at which to load a DLL. - - - This address can be specified as a decimal, hexadecimal, or octal - number. - + + The preferred base address at which to load a DLL. The default base + address for a DLL is set by the .NET Framework common language + runtime. + + + The preferred base address at which to load a DLL. + + + This address can be specified as a decimal, hexadecimal, or octal + number. + - - Specifies the type of debugging information generated by the - compiler. The default is . - + + Specifies the type of debugging information generated by the + compiler. The default is . + @@ -1110,184 +1110,184 @@ - - The name of the XML documentation file to generate. - - - - Corresponds with the /doc: flag. - - + + The name of the XML documentation file to generate. + + + + Corresponds with the /doc: flag. + + - - Specifies the size of sections in the output file. Valid values are - 512, 1024, 2048, 4096, and 8192. - - - The size of sections in the output file. - + + Specifies the size of sections in the output file. Valid values are + 512, 1024, 2048, 4096, and 8192. + + + The size of sections in the output file. + - - Instructs the compiler not to import mscorlib.dll. The default is - . - - - - Corresponds with the /nostdlib[+|-] flag. - - + + Instructs the compiler not to import mscorlib.dll. The default is + . + + + + Corresponds with the /nostdlib[+|-] flag. + + - - Instructs the compiler not to use implicit references to assemblies. - The default is . - - - - Corresponds with the /noconfig flag. - - + + Instructs the compiler not to use implicit references to assemblies. + The default is . + + + + Corresponds with the /noconfig flag. + + - - Specifies whether an integer arithmetic statement that is not in - the scope of the checked or unchecked keywords and - that results in a value outside the range of the data type should - cause a run-time exception. The default is . - - - - Corresponds with the /checked[+|-] flag. - - + + Specifies whether an integer arithmetic statement that is not in + the scope of the checked or unchecked keywords and + that results in a value outside the range of the data type should + cause a run-time exception. The default is . + + + + Corresponds with the /checked[+|-] flag. + + - - Instructs the compiler to allow code that uses the unsafe - keyword. The default is . - - - - Corresponds with the /unsafe[+|-] flag. - - + + Instructs the compiler to allow code that uses the unsafe + keyword. The default is . + + + + Corresponds with the /unsafe[+|-] flag. + + - - Causes the compiler to only accept syntax that is included in a - given specification. - - - - Corresponds with the /langversion flag. - - + + Causes the compiler to only accept syntax that is included in a + given specification. + + + + Corresponds with the /langversion flag. + + - - Specifies whether the compiler should perform optimizations to the - make output files smaller, faster, and more effecient. The default - is . - - - if the compiler should perform optimizations; - otherwise, . - - - - Corresponds with the /optimize[+|-] flag. - - + + Specifies whether the compiler should perform optimizations to the + make output files smaller, faster, and more effecient. The default + is . + + + if the compiler should perform optimizations; + otherwise, . + + + + Corresponds with the /optimize[+|-] flag. + + - - Specifies which platform version of common language runtime (CLR) - can run the output file. - - - The platform version of common language runtime (CLR) that can run - the output file. - - - - Corresponds with the /platform flag. - - + + Specifies which platform version of common language runtime (CLR) + can run the output file. + + + The platform version of common language runtime (CLR) that can run + the output file. + + + + Corresponds with the /platform flag. + + - - Specifies the warning level for the compiler to display. Valid values - are 0-4. The default is 4. - - - The warning level for the compiler to display. - - - - Corresponds with the /warn flag. - - + + Specifies the warning level for the compiler to display. Valid values + are 0-4. The default is 4. + + + The warning level for the compiler to display. + + + + Corresponds with the /warn flag. + + - - Specifies the code page to use for all source code files in the - compilation. - - - - Corresponds with the /codepage flag. - - + + Specifies the code page to use for all source code files in the + compilation. + + + + Corresponds with the /codepage flag. + + - - Specifies whether the compiler for the active target framework - supports generation of XML Documentation file. The default is - . - + + Specifies whether the compiler for the active target framework + supports generation of XML Documentation file. The default is + . + - - Specifies whether the compiler for the active target framework - supports limiting the platform on which the compiled code can run. - The default is . - + + Specifies whether the compiler for the active target framework + supports limiting the platform on which the compiled code can run. + The default is . + - - Specifies whether the compiler for the active target framework - supports accepting only a specific language syntax. - The default is . - + + Specifies whether the compiler for the active target framework + supports accepting only a specific language syntax. + The default is . + - - Gets the file extension required by the current compiler. - - - For the C# compiler, the file extension is always cs. - + + Gets the file extension required by the current compiler. + + + For the C# compiler, the file extension is always cs. + - - Gets the class name regular expression for the language of the - current compiler. - - - Class name regular expression for the language of the current - compiler. - + + Gets the class name regular expression for the language of the + current compiler. + + + Class name regular expression for the language of the current + compiler. + - - Gets the namespace regular expression for the language of the current compiler. - - - Namespace regular expression for the language of the current - compiler. - + + Gets the namespace regular expression for the language of the current compiler. + + + Namespace regular expression for the language of the current + compiler. + @@ -1315,61 +1315,61 @@ - - Converts a single file or group of files. - + + Converts a single file or group of files. + - - List of assemblies/executables to sign. - + + List of assemblies/executables to sign. + - - Specifies the filesystem path to the signing key. - + + Specifies the filesystem path to the signing key. + - - Specifies the key container. - + + Specifies the key container. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Compiles ILASM programs. - - - - Compiles helloworld.il to helloworld.exe. - - - - - - - - ]]> - - + + Compiles ILASM programs. + + + + Compiles helloworld.il to helloworld.exe. + + + + + + + + ]]> + + - - Compiles the sources. - + + Compiles the sources. + - - Writes the compiler options. - + + Writes the compiler options. + @@ -1402,262 +1402,262 @@ - - Determines whether or not compilation is needed. - - - if compilation is needed; otherwise, - . - + + Determines whether or not compilation is needed. + + + if compilation is needed; otherwise, + . + - - Specifies whether or not the compiler should measure and report - the compilation times. - - - if the compilation times should be - measured and reported; otherwise, . The - default is . - - - - Corresponds to the /CLOCK flag. - - + + Specifies whether or not the compiler should measure and report + the compilation times. + + + if the compilation times should be + measured and reported; otherwise, . The + default is . + + + + Corresponds to the /CLOCK flag. + + - - Specifies whether or not the compiler should generate debug - information. - - - if debug information should be generated; - otherwise, . The default is - . - - - - Corresponds to the /DEBUG flag. - - + + Specifies whether or not the compiler should generate debug + information. + + + if debug information should be generated; + otherwise, . The default is + . + + + + Corresponds to the /DEBUG flag. + + - - Specifies whether or not the compiler should attempt to create a - PE file even if compilation errors have been reported. - - - if a PE file has to be created even if - compilation errors have been reported; otherwise, - . The default is . - - - - Corresponds to the /ERROR flag. - - + + Specifies whether or not the compiler should attempt to create a + PE file even if compilation errors have been reported. + + + if a PE file has to be created even if + compilation errors have been reported; otherwise, + . The default is . + + + + Corresponds to the /ERROR flag. + + - - Instructs NAnt to recompile the output file regardless of the file - timestamps. - - - if the output file should be recompiled - regardless of its timestamps; otherwise . - The default is . - + + Instructs NAnt to recompile the output file regardless of the file + timestamps. + + + if the output file should be recompiled + regardless of its timestamps; otherwise . + The default is . + - - Specifies whether or not the compiler should type a formatted - listing of the compilation result. - - - if a formatted listing of the compilation - result should be typed; otherwise, . The - default is . - - - - Corresponds to the /LISTING flag. - - + + Specifies whether or not the compiler should type a formatted + listing of the compilation result. + + + if a formatted listing of the compilation + result should be typed; otherwise, . The + default is . + + + + Corresponds to the /LISTING flag. + + - - Instructs the compiler to set the FileAlignment value in - the PE header. - - - An that represents the FileAlignment - value to set in the PE header. The value must be a power of 2, in - range from 512 to 65536. - - - - Corresponds to the /ALIGNMENT flag. - - + + Instructs the compiler to set the FileAlignment value in + the PE header. + + + An that represents the FileAlignment + value to set in the PE header. The value must be a power of 2, in + range from 512 to 65536. + + + + Corresponds to the /ALIGNMENT flag. + + - - Instructs the compiler to set the ImageBase value in - the PE header. - - - A that represents the ImageBase - value to set in the PE header. - - - - Corresponds to the /BASE flag. - - + + Instructs the compiler to set the ImageBase value in + the PE header. + + + A that represents the ImageBase + value to set in the PE header. + + + + Corresponds to the /BASE flag. + + - - Instructs the compiler to set the Flags value in the CLR - header. - - - An that represents the Flags - value to set in the CLR header. The most frequently value are 1 - (pre-IL code) and 2 (mixed code). The third bit indicating that - the PE file is strong signed, is ignored. - - - - Corresponds to the /FLAGS flag. - - + + Instructs the compiler to set the Flags value in the CLR + header. + + + An that represents the Flags + value to set in the CLR header. The most frequently value are 1 + (pre-IL code) and 2 (mixed code). The third bit indicating that + the PE file is strong signed, is ignored. + + + + Corresponds to the /FLAGS flag. + + - - Instructs the compiler to set the Subsystem value in the PE - header. - - - An that represents the Subsystem - value to set in the PE header. The most frequently value are 3 - (console application) and 2 (GUI application). - - - - Corresponds to the /SUBSYSTEM flag. - - + + Instructs the compiler to set the Subsystem value in the PE + header. + + + An that represents the Subsystem + value to set in the PE header. The most frequently value are 3 + (console application) and 2 (GUI application). + + + + Corresponds to the /SUBSYSTEM flag. + + - - Specifies which output type should be generated. - - - A that contains the target type. - Possible values are dll and exe. - - - - Corresponds to the /OUTPUT flag. - - + + Specifies which output type should be generated. + + + A that contains the target type. + Possible values are dll and exe. + + + + Corresponds to the /OUTPUT flag. + + - - Instructs the compiler to generate a strong signature of the PE - file. - - - A that contains the private - encryption key. - - - - Corresponds to the /KEY=keysource]]> - flag. - - + + Instructs the compiler to generate a strong signature of the PE + file. + + + A that contains the private + encryption key. + + + + Corresponds to the /KEY=keysource]]> + flag. + + - - Instructs the compiler to generate a strong signature of the PE - file. - - - A that represents the file - containing the private encryption key. - - - - Corresponds to the /KEY=keyfile]]> - flag. - - + + Instructs the compiler to generate a strong signature of the PE + file. + + + A that represents the file + containing the private encryption key. + + + + Corresponds to the /KEY=keyfile]]> + flag. + + - - Specifies the name of the output file created by the compiler. - - - A that represents the name of - the output file. - - - - Corresponds to the /OUTPUT flag. - - + + Specifies the name of the output file created by the compiler. + + + A that represents the name of + the output file. + + + + Corresponds to the /OUTPUT flag. + + - - Instructs the compiler to link the specified unmanaged resource - file into the resulting PE file. - - - A that represents the unmanaged - resource file to link. - - - - Corresponds to the /RESOURCE flag. - - + + Instructs the compiler to link the specified unmanaged resource + file into the resulting PE file. + + + A that represents the unmanaged + resource file to link. + + + + Corresponds to the /RESOURCE flag. + + - - Specifies the set of source files to compile. - - - A that represents the set - of source files to compile. - + + Specifies the set of source files to compile. + + + A that represents the set + of source files to compile. + - - Gets the command-line arguments for the external program. - - - A that contains the command-line - arguments for the external program. - + + Gets the command-line arguments for the external program. + + + A that contains the command-line + arguments for the external program. + - - Compiles JScript.NET programs. - - - Compile helloworld.js to helloworld.exe. - - - - - - - ]]> - - + + Compiles JScript.NET programs. + + + Compile helloworld.js to helloworld.exe. + + + + + + + ]]> + + @@ -1672,16 +1672,16 @@ to which the compiler options should be written. - - Automatically references assemblies if they have the same name as - an imported namespace or as a type annotation when declaring a - variable. The default is . - - - - Corresponds with the /autoref flag. - - + + Automatically references assemblies if they have the same name as + an imported namespace or as a type annotation when declaring a + variable. The default is . + + + + Corresponds with the /autoref flag. + + @@ -1696,216 +1696,216 @@ - - Specifies which platform version of common language runtime (CLR) - can run the output file. - - - The platform version of common language runtime (CLR) that can run - the output file. - - - - Corresponds with the /platform flag. - - + + Specifies which platform version of common language runtime (CLR) + can run the output file. + + + The platform version of common language runtime (CLR) that can run + the output file. + + + + Corresponds with the /platform flag. + + - - Causes the compiler to generate errors for implicit method - overrides. The default is . - - - - Corresponds with the /versionsafe flag. - - + + Causes the compiler to generate errors for implicit method + overrides. The default is . + + + + Corresponds with the /versionsafe flag. + + - - Specifies the warning level for the compiler to display. Valid - values are 0-4. The default is 4. - - - The warning level for the compiler to display. - - - - Corresponds with the /warn flag. - - + + Specifies the warning level for the compiler to display. Valid + values are 0-4. The default is 4. + + + The warning level for the compiler to display. + + + + Corresponds with the /warn flag. + + - - Controls which warnings should be reported as errors. - - - Override to avoid exposing this to build authors, as the JScript.NET - compiler does not allow control over which warnings should be - reported as errors. - + + Controls which warnings should be reported as errors. + + + Override to avoid exposing this to build authors, as the JScript.NET + compiler does not allow control over which warnings should be + reported as errors. + - - Specifies a comma-separated list of warnings that should be suppressed - by the compiler. - - - Override to avoid exposing this to build authors, as the JScript.NET - compiler does not support package references. - + + Specifies a comma-separated list of warnings that should be suppressed + by the compiler. + + + Override to avoid exposing this to build authors, as the JScript.NET + compiler does not support package references. + - - Specifies a list of warnings that you want the compiler to suppress. - - - Override to avoid exposing this to build authors, as the JScript.NET - compiler does not support suppressing warnings. - + + Specifies a list of warnings that you want the compiler to suppress. + + + Override to avoid exposing this to build authors, as the JScript.NET + compiler does not support suppressing warnings. + - - Specifies the code page to use for all source code files in the - compilation. - - - - Corresponds with the /codepage flag. - - + + Specifies the code page to use for all source code files in the + compilation. + + + + Corresponds with the /codepage flag. + + - - Specifies the key pair container used to strongname the assembly. - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Specifies the key pair container used to strongname the assembly. + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Specifies a strong name key file. - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Specifies a strong name key file. + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Specifies whether to delay sign the assembly using only the public - portion of the strong name key. - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Specifies whether to delay sign the assembly using only the public + portion of the strong name key. + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Indicates whether the compiler for a given target framework supports - the "keycontainer" option. The default is . - - - . - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Indicates whether the compiler for a given target framework supports + the "keycontainer" option. The default is . + + + . + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Indicates whether the compiler for a given target framework supports - the "keyfile" option. The default is . - - - . - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Indicates whether the compiler for a given target framework supports + the "keyfile" option. The default is . + + + . + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Indicates whether the compiler for a given target framework supports - the "delaysign" option. The default is . - - - . - - - Override to avoid exposing this to build authors, as the JScript.NET - does not support this. - + + Indicates whether the compiler for a given target framework supports + the "delaysign" option. The default is . + + + . + + + Override to avoid exposing this to build authors, as the JScript.NET + does not support this. + - - Specifies whether the compiler for the active target framework - supports limiting the platform on which the compiled code can run. - The default is . - + + Specifies whether the compiler for the active target framework + supports limiting the platform on which the compiled code can run. + The default is . + - - Link the specified modules into this assembly. - - - Override to avoid exposing this to build authors, as the JScript.NET - compiler does not support linking modules. - + + Link the specified modules into this assembly. + + + Override to avoid exposing this to build authors, as the JScript.NET + compiler does not support linking modules. + - - Gets the file extension required by the current compiler. - - - For the JScript.NET compiler, the file extension is always js. - + + Gets the file extension required by the current compiler. + + + For the JScript.NET compiler, the file extension is always js. + - - Gets the class name regular expression for the language of the - current compiler. - - - Class name regular expression for the language of the current - compiler. - + + Gets the class name regular expression for the language of the + current compiler. + + + Class name regular expression for the language of the current + compiler. + - - Gets the namespace regular expression for the language of the - current compiler. - - - Namespace regular expression for the language of the current - compiler. - + + Gets the namespace regular expression for the language of the + current compiler. + + + Namespace regular expression for the language of the current + compiler. + - - Generates a .licence file from a .licx file. - - - - If no output file is specified, the default filename is the name of the - target file with the extension .licenses appended. - - - - - Generate the file component.exe.licenses file from component.licx. - - - - ]]> - - + + Generates a .licence file from a .licx file. + + + + If no output file is specified, the default filename is the name of the + target file with the extension .licenses appended. + + + + + Generate the file component.exe.licenses file from component.licx. + + + + ]]> + + @@ -1920,104 +1920,104 @@ The of which the should be updated. - - Generates the license file. - + + Generates the license file. + - - Determines whether the .licenses file needs to be recompiled - or is uptodate. - - The .licenses file. - - if the .licenses file needs compiling; - otherwise, . - + + Determines whether the .licenses file needs to be recompiled + or is uptodate. + + The .licenses file. + + if the .licenses file needs compiling; + otherwise, . + - - Input file to process. - + + Input file to process. + - - Name of the license file to output. - + + Name of the license file to output. + - - Names of the references to scan for the licensed component. - + + Names of the references to scan for the licensed component. + - - Specifies the executable for which the .licenses file is generated. - + + Specifies the executable for which the .licenses file is generated. + - - Specifies the executable for which the .licenses file is generated. - + + Specifies the executable for which the .licenses file is generated. + - - Indicates whether assembly references are supported by the current - target framework. The default is . - - - Applies only to frameworks having a command line tool for compiling - licenses files. - + + Indicates whether assembly references are supported by the current + target framework. The default is . + + + Applies only to frameworks having a command line tool for compiling + licenses files. + - - Indicates whether the current target framework has a command line - tool for compiling licenses files. The default is - . - + + Indicates whether the current target framework has a command line + tool for compiling licenses files. The default is + . + - - Gets the working directory for the application. - - - The working directory for the application. - + + Gets the working directory for the application. + + + The working directory for the application. + - - The command-line arguments for the external program. - - - Override to avoid exposing these elements in build file. - + + The command-line arguments for the external program. + + + Override to avoid exposing these elements in build file. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Gets the filename of the external program to start. - - - The filename of the external program. - - - Override in derived classes to explicitly set the location of the - external tool. - + + Gets the filename of the external program to start. + + + The filename of the external program. + + + Override in derived classes to explicitly set the location of the + external tool. + - - Responsible for reading the license and writing them to a license - file. - + + Responsible for reading the license and writing them to a license + file. + @@ -2039,15 +2039,15 @@ The .licenses file to create. - - Determines whether the given object is serializable in binary - format. - - The object to check. - - if is - serializable in binary format; otherwise, . - + + Determines whether the given object is serializable in binary + format. + + The object to check. + + if is + serializable in binary format; otherwise, . + @@ -2124,14 +2124,14 @@ - - Initializes the taks and verifies the parameters. - + + Initializes the taks and verifies the parameters. + - - Generates an NDoc project and builds the documentation. - + + Generates an NDoc project and builds the documentation. + @@ -2167,119 +2167,119 @@ for which expansion should be performed. - - Use Reflection to set HtmplHelp._htmlHelpCompiler private field for MSDN Documentor. - Ndoc could not handle 64bit installations and is not actively developed anymore. - - Active documentor - Path to hhc.exe + + Use Reflection to set HtmplHelp._htmlHelpCompiler private field for MSDN Documentor. + Ndoc could not handle 64bit installations and is not actively developed anymore. + + Active documentor + Path to hhc.exe - - Searches in %ProgramFiles(x86)%\HTML Help Workshop and %ProgramFiles%\HTML Help Workshop - for hhc.exe. If not found let ndoc msdn documentor search itself - - the path to hhc.exe if found, null otherwise + + Searches in %ProgramFiles(x86)%\HTML Help Workshop and %ProgramFiles%\HTML Help Workshop + for hhc.exe. If not found let ndoc msdn documentor search itself + + the path to hhc.exe if found, null otherwise - - The set of assemblies to document. - + + The set of assemblies to document. + - - The set of namespace summary files. - + + The set of namespace summary files. + - - Specifies the formats in which the documentation should be generated. - + + Specifies the formats in which the documentation should be generated. + - - Collection of additional directories to search for referenced - assemblies. - + + Collection of additional directories to search for referenced + assemblies. + - - Installs or removes .NET Services. - - - - This tasks provides the same functionality as the regsvcs tool - provided in the .NET SDK. - - - It performs the following actions: - - - - Loads and registers an assembly. - - - Generates, registers, and installs a type library into a specified COM+ application. - - - Configures services that are added programmatically to your class. - - - - Refer to the .NET Services Installation Tool (Regsvcs.exe) for more information. - - - - - Adds all public classes contained in myTest.dll to a COM+ - application and produces the myTest.tlb type library. If the - application already exists, it is overwritten. - - - - ]]> - - - - - Adds all public classes contained in myTest.dll to myTargetApp - and produces the myTest.tlb type library. If the application already - exists, it is overwritten. - - - - ]]> - - - - - Adds all public classes contained in myTest.dll to a COM+ - application and produces the myTest.tlb type library. A new - application is always created. - - - - ]]> - - - - - Uninstalls the COM+ application contained in myTest.dll. - - - - ]]> - - + + Installs or removes .NET Services. + + + + This tasks provides the same functionality as the regsvcs tool + provided in the .NET SDK. + + + It performs the following actions: + + + + Loads and registers an assembly. + + + Generates, registers, and installs a type library into a specified COM+ application. + + + Configures services that are added programmatically to your class. + + + + Refer to the .NET Services Installation Tool (Regsvcs.exe) for more information. + + + + + Adds all public classes contained in myTest.dll to a COM+ + application and produces the myTest.tlb type library. If the + application already exists, it is overwritten. + + + + ]]> + + + + + Adds all public classes contained in myTest.dll to myTargetApp + and produces the myTest.tlb type library. If the application already + exists, it is overwritten. + + + + ]]> + + + + + Adds all public classes contained in myTest.dll to a COM+ + application and produces the myTest.tlb type library. A new + application is always created. + + + + ]]> + + + + + Uninstalls the COM+ application contained in myTest.dll. + + + + ]]> + + - - Performs the specified action. - + + Performs the specified action. + @@ -2288,78 +2288,78 @@ - - The source assembly file. - - - The assembly must be signed with a strong name. - + + The source assembly file. + + + The assembly must be signed with a strong name. + - - Specifies the type library file to install. - + + Specifies the type library file to install. + - - Uses an existing type library. The default is . - + + Uses an existing type library. The default is . + - - Do not reconfigure an existing target application. - The default is . - + + Do not reconfigure an existing target application. + The default is . + - - Configures components only; ignores methods and interfaces. - The default is . - + + Configures components only; ignores methods and interfaces. + The default is . + - - Expect an existing application. The default is . - + + Expect an existing application. The default is . + - - Specifies the name of the COM+ application to either find or create. - + + Specifies the name of the COM+ application to either find or create. + - - Specifies the name or id of the COM+ application to either find or - create. - + + Specifies the name or id of the COM+ application to either find or + create. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Defines the possible actions for a .NET Service. - + + Defines the possible actions for a .NET Service. + - - Finds or creates the target application. - + + Finds or creates the target application. + - - Creates the target application. - + + Creates the target application. + - - Uninstalls the target application. - + + Uninstalls the target application. + @@ -2405,155 +2405,155 @@ The of which the should be updated. - - Converts a single file or group of files. - + + Converts a single file or group of files. + - - Cleans up generated files. - + + Cleans up generated files. + - - Determines whether the specified input file needs to be compiled. - - The input file. - The output file. - - if the input file need to be compiled; - otherwise . - + + Determines whether the specified input file needs to be compiled. + + The input file. + The output file. + + if the input file need to be compiled; + otherwise . + - - Determines the full path and extension for the output file. - - The output file for which the full path and extension should be determined. - - The full path (with extensions) for the specified file. - + + Determines the full path and extension for the output file. + + The output file for which the full path and extension should be determined. + + The full path (with extensions) for the specified file. + - - Determines whether the specified resource file references third - party assemblies by checking whether a <data> element exists - with a "type" attribute that does not start with - "System.". - - The resource file to check. - - if the resource file references third party - assemblies, or an error occurred; otherwise, . - - - This check will only be accurate for 1.0 resource file, but the - 2.0 resx files can only be compiled with a resgen tool that supports - assembly references, so this method will not be used anyway. - + + Determines whether the specified resource file references third + party assemblies by checking whether a <data> element exists + with a "type" attribute that does not start with + "System.". + + The resource file to check. + + if the resource file references third party + assemblies, or an error occurred; otherwise, . + + + This check will only be accurate for 1.0 resource file, but the + 2.0 resx files can only be compiled with a resgen tool that supports + assembly references, so this method will not be used anyway. + - - Returns a list of external file references for the specified file. - - The resx file for which a list of external file references should be returned. - - A list of external file references for the specified file, or - if does not - exist or does not support external file references. - + + Returns a list of external file references for the specified file. + + The resx file for which a list of external file references should be returned. + + A list of external file references for the specified file, or + if does not + exist or does not support external file references. + - - Input file to process. - - - The full path to the input file. - + + Input file to process. + + + The full path to the input file. + - - The resource file to output. - + + The resource file to output. + - - The target type. The default is resources. - + + The target type. The default is resources. + - - The directory to which outputs will be stored. - + + The directory to which outputs will be stored. + - - Use each source file's directory as the current directory for - resolving relative file paths. The default is . - Only supported when targeting .NET 2.0 (or higher). - + + Use each source file's directory as the current directory for + resolving relative file paths. The default is . + Only supported when targeting .NET 2.0 (or higher). + - - Takes a list of .resx or .txt files to convert to .resources files. - + + Takes a list of .resx or .txt files to convert to .resources files. + - - Reference metadata from the specified assembly files. - + + Reference metadata from the specified assembly files. + - - Indicates whether assembly references are supported by the - resgen tool for the current target framework. The default - is . - + + Indicates whether assembly references are supported by the + resgen tool for the current target framework. The default + is . + - - Indicates whether external file references are supported by the - resgen tool for the current target framework. The default - is . - + + Indicates whether external file references are supported by the + resgen tool for the current target framework. The default + is . + - - For internal use only ! - + + For internal use only ! + - - Gets the working directory for the application. - - - The working directory for the application. - + + Gets the working directory for the application. + + + The working directory for the application. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Gets the filename of the external program to start. - - - The filename of the external program. - - - Override in derived classes to explicitly set the location of the - external tool. - + + Gets the filename of the external program to start. + + + The filename of the external program. + + + Override in derived classes to explicitly set the location of the + external tool. + - - For internal use only ! - + + For internal use only ! + @@ -2564,20 +2564,20 @@ The compiled resource. - - Gets the resource file to compile. - - - The resource file to compile. - + + Gets the resource file to compile. + + + The resource file to compile. + - - Gets the compiled resource file. - - - The compiled resource file. - + + Gets the compiled resource file. + + + The compiled resource file. + @@ -2770,48 +2770,48 @@ - - Initializes the task. - + + Initializes the task. + - - Executes the script block. - + + Executes the script block. + - - The language of the script block. Possible values are "VB", "vb", "VISUALBASIC", "C#", "c#", "CSHARP". - "JS", "js", "JSCRIPT" "VJS", "vjs", "JSHARP" or a fully-qualified name for a class implementing - . - + + The language of the script block. Possible values are "VB", "vb", "VISUALBASIC", "C#", "c#", "CSHARP". + "JS", "js", "JSCRIPT" "VJS", "vjs", "JSHARP" or a fully-qualified name for a class implementing + . + - - Any required references. - + + Any required references. + - - The name of the main class containing the static ScriptMain - entry point. - + + The name of the main class containing the static ScriptMain + entry point. + - - The namespace prefix for any custom functions defined in the script. - If ommitted the prefix will default to 'script' - + + The namespace prefix for any custom functions defined in the script. + If ommitted the prefix will default to 'script' + - - The namespaces to import. - + + The namespaces to import. + - - The code to execute. - + + The code to execute. + @@ -2888,28 +2888,28 @@ to which the compiler options should be written. - - Determines whether compilation is needed. - + + Determines whether compilation is needed. + - - The preferred base address at which to load a DLL. The default base - address for a DLL is set by the .NET Framework common language - runtime. - - - The preferred base address at which to load a DLL. - - - This address must be specified as a hexadecimal number. - + + The preferred base address at which to load a DLL. The default base + address for a DLL is set by the .NET Framework common language + runtime. + + + The preferred base address at which to load a DLL. + + + This address must be specified as a hexadecimal number. + - - Specifies the type of debugging information generated by the - compiler. The default is . - + + Specifies the type of debugging information generated by the + compiler. The default is . + @@ -2918,179 +2918,179 @@ - - The name of the XML documentation file to generate. Only supported - when targeting .NET 2.0 (or higher). - - - - Corresponds with the /doc: flag. - - + + The name of the XML documentation file to generate. Only supported + when targeting .NET 2.0 (or higher). + + + + Corresponds with the /doc: flag. + + - - Specifies whether the /imports option gets passed to the - compiler. - - - The value of this attribute is a string that contains one or more - namespaces separated by commas. - - - See the Microsoft.NET Framework SDK documentation for details. - - Example of an imports attribute - - + + Specifies whether the /imports option gets passed to the + compiler. + + + The value of this attribute is a string that contains one or more + namespaces separated by commas. + + + See the Microsoft.NET Framework SDK documentation for details. + + Example of an imports attribute + + - - The namespaces to import. - + + The namespaces to import. + - - Instructs the compiler not to reference standard libraries - (system.dll and VBC.RSP). The default is . - Only supported when targeting .NET 2.0 (or higher). - - - - Corresponds with the /nostdlib flag. - - + + Instructs the compiler not to reference standard libraries + (system.dll and VBC.RSP). The default is . + Only supported when targeting .NET 2.0 (or higher). + + + + Corresponds with the /nostdlib flag. + + - - Specifies whether /optioncompare option gets passed to the - compiler. - - - text, binary, or an empty string. If the value is - or an empty string, the option will not be - passed to the compiler. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether /optioncompare option gets passed to the + compiler. + + + text, binary, or an empty string. If the value is + or an empty string, the option will not be + passed to the compiler. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the /optionexplicit option gets passed to - the compiler. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /optionexplicit option gets passed to + the compiler. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the /optimize option gets passed to the - compiler. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /optimize option gets passed to the + compiler. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the /optionstrict option gets passed to - the compiler. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /optionstrict option gets passed to + the compiler. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies which platform version of common language runtime (CLR) - can run the output file. - - - The platform version of common language runtime (CLR) that can run - the output file. - - - - Corresponds with the /platform flag. - - + + Specifies which platform version of common language runtime (CLR) + can run the output file. + + + The platform version of common language runtime (CLR) that can run + the output file. + + + + Corresponds with the /platform flag. + + - - Specifies whether the /removeintchecks option gets passed to - the compiler. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /removeintchecks option gets passed to + the compiler. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the /rootnamespace option gets passed to - the compiler. - - - The value of this attribute is a string that contains the root - namespace of the project. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the /rootnamespace option gets passed to + the compiler. + + + The value of this attribute is a string that contains the root + namespace of the project. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether the compiler for the active target framework - supports generation of XML Documentation file. The default is - . - + + Specifies whether the compiler for the active target framework + supports generation of XML Documentation file. The default is + . + - - Specifies whether the compiler for the active target framework - supports NOT referencing standard libraries (system.dll and VBC.RSP). - The default is . - + + Specifies whether the compiler for the active target framework + supports NOT referencing standard libraries (system.dll and VBC.RSP). + The default is . + - - Specifies whether the compiler for the active target framework - supports limiting the platform on which the compiled code can run. - The default is . - + + Specifies whether the compiler for the active target framework + supports limiting the platform on which the compiled code can run. + The default is . + - - Gets the file extension required by the current compiler. - - - For the VB.NET compiler, the file extension is always vb. - + + Gets the file extension required by the current compiler. + + + For the VB.NET compiler, the file extension is always vb. + - - Gets the class name regular expression for the language of the - current compiler. - - - Class name regular expression for the language of the current - compiler. - + + Gets the class name regular expression for the language of the + current compiler. + + + Class name regular expression for the language of the current + compiler. + - - Gets the namespace regular expression for the language of the - current compiler. - - - Namespace regular expression for the language of the current - compiler. - + + Gets the namespace regular expression for the language of the + current compiler. + + + Namespace regular expression for the language of the current + compiler. + @@ -3142,24 +3142,24 @@ to which the compiler options should be written. - - The preferred base address at which to load a DLL. The default base - address for a DLL is set by the .NET Framework common language - runtime. - - - The preferred base address at which to load a DLL. - - - This address can be specified as a decimal, hexadecimal, or octal - number. - + + The preferred base address at which to load a DLL. The default base + address for a DLL is set by the .NET Framework common language + runtime. + + + The preferred base address at which to load a DLL. + + + This address can be specified as a decimal, hexadecimal, or octal + number. + - - Specifies the type of debugging information generated by the - compiler. The default is . - + + Specifies the type of debugging information generated by the + compiler. The default is . + @@ -3168,185 +3168,185 @@ - - Specifies whether package-scoped members are accessible outside of - the assembly. In other words, package scope is treated as assembly - scope when emitting metadata. The default is . - - - if the option should be passed to the compiler; - otherwise, . - - - - Corresponds to the /securescoping flag. - - - See the Visual J# Reference for details. - - - - ]]> - + + Specifies whether package-scoped members are accessible outside of + the assembly. In other words, package scope is treated as assembly + scope when emitting metadata. The default is . + + + if the option should be passed to the compiler; + otherwise, . + + + + Corresponds to the /securescoping flag. + + + See the Visual J# Reference for details. + + + + ]]> + - - Specifies whether to disable language extensions. - - - The value of this property must be either all, net, - or an empty string. - - - - Corresponds to the /x flag. - - - See the Visual J# Reference for details. - - - - To disable only the .NET Framework extensions: - ]]> - To disable the .NET Framework extensions and the VJ++ 6.0 extensions: - ]]> - + + Specifies whether to disable language extensions. + + + The value of this property must be either all, net, + or an empty string. + + + + Corresponds to the /x flag. + + + See the Visual J# Reference for details. + + + + To disable only the .NET Framework extensions: + ]]> + To disable the .NET Framework extensions and the VJ++ 6.0 extensions: + ]]> + - - Specifies the location of assemblies referenced by way of the /reference flag. - - - - Corresponds to the /libpath:dir[;dir2] flag. - - - See the Visual J# Reference for details. - - + + Specifies the location of assemblies referenced by way of the /reference flag. + + + + Corresponds to the /libpath:dir[;dir2] flag. + + + See the Visual J# Reference for details. + + - - Associate Java-language/COM package names. - - - The value of this propery. must be package=namespace, @filename, - or an empty string. - - - - Corresponds to the /jcpa:package=namespace and /jcpa:@filename flags. - - - See the Visual J# Reference for details. - - - - Map package 'x' to namespace 'y': - ]]> - + + Associate Java-language/COM package names. + + + The value of this propery. must be package=namespace, @filename, + or an empty string. + + + + Corresponds to the /jcpa:package=namespace and /jcpa:@filename flags. + + + See the Visual J# Reference for details. + + + + Map package 'x' to namespace 'y': + ]]> + - - Specifies the code page to use for all source code files in the - compilation. - - - - Corresponds with the /codepage flag. - - - See the Visual J# Reference for details. - - + + Specifies the code page to use for all source code files in the + compilation. + + + + Corresponds with the /codepage flag. + + + See the Visual J# Reference for details. + + - - Specifies the warning level for the compiler to display. Valid values - are 0-4. The default is 4. - - - The warning level for the compiler to display. - - - - Corresponds with the /warn option. - - + + Specifies the warning level for the compiler to display. Valid values + are 0-4. The default is 4. + + + The warning level for the compiler to display. + + + + Corresponds with the /warn option. + + - - Controls which warnings should be reported as errors. - - - Override to avoid exposing this to build authors, as the Visual J# - compiler does not allow control over which warnings should be - reported as errors. - + + Controls which warnings should be reported as errors. + + + Override to avoid exposing this to build authors, as the Visual J# + compiler does not allow control over which warnings should be + reported as errors. + - - Reference packages - - - Override to avoid exposing this to build authors, as the Visual J# - compiler does not support package references. - + + Reference packages + + + Override to avoid exposing this to build authors, as the Visual J# + compiler does not support package references. + - - Link the specified modules into this assembly. - - - Override to avoid exposing this to build authors, as the Visual J# - compiler does not support linking modules. - + + Link the specified modules into this assembly. + + + Override to avoid exposing this to build authors, as the Visual J# + compiler does not support linking modules. + - - Gets the file extension required by the current compiler. - - - For the J# compiler, the file extension is always jsl. - + + Gets the file extension required by the current compiler. + + + For the J# compiler, the file extension is always jsl. + - - Gets the class name regular expression for the language of the - current compiler. - - - Class name regular expression for the language of the current - compiler. - + + Gets the class name regular expression for the language of the + current compiler. + + + Class name regular expression for the language of the current + compiler. + - - Gets the namespace regular expression for the language of the - current compiler. - - - Namespace regular expression for the language of the current - compiler. - + + Gets the namespace regular expression for the language of the + current compiler. + + + Namespace regular expression for the language of the current + compiler. + - - Override to avoid exposing the configuration setting for this - task as Visual J# will never support package references. - - - , as the Visual J# compiler will never - support package references. - + + Override to avoid exposing the configuration setting for this + task as Visual J# will never support package references. + + + , as the Visual J# compiler will never + support package references. + - - Represents an assembly-level attribute. - + + Represents an assembly-level attribute. + @@ -3355,43 +3355,43 @@ - - Typename of the assembly-level attribute. - + + Typename of the assembly-level attribute. + - - Value of the attribute. - + + Value of the attribute. + - - If then the value of the attribute will be - set as is, without actually looking for a matching constructor or - named properties. The default is . - - - if the value of the attribute should be set - as is; otherwise, . - + + If then the value of the attribute will be + set as is, without actually looking for a matching constructor or + named properties. The default is . + + + if the value of the attribute should be set + as is; otherwise, . + - - Indicates if the attribute should be generated. - - - if the attribute should be generated; - otherwise, . - + + Indicates if the attribute should be generated. + + + if the attribute should be generated; + otherwise, . + - - Indicates if the attribute should be not generated. - - - if the attribute should be not generated; - otherwise, . - + + Indicates if the attribute should be not generated. + + + if the attribute should be not generated; + otherwise, . + @@ -3458,11 +3458,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -3495,10 +3495,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -3519,28 +3519,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -3559,11 +3559,11 @@ - - override this. We will always use the base directory of the parent. - overriding without the TaskAttribute attribute prevents it being set - in the source xml - + + override this. We will always use the base directory of the parent. + overriding without the TaskAttribute attribute prevents it being set + in the source xml + @@ -3657,17 +3657,17 @@ - - copy constructor for FileSet. Required in order to - assign references of FileSet type where - AssemblyFileSets are used - - + + copy constructor for FileSet. Required in order to + assign references of FileSet type where + AssemblyFileSets are used + + - - Do a normal scan and then resolve assemblies. - + + Do a normal scan and then resolve assemblies. + @@ -3676,37 +3676,37 @@ - - Additional directories to search in for assembly references. - - - - loosely Corresponds with the /lib[path]: flag of the various compiler tasks. - - + + Additional directories to search in for assembly references. + + + + loosely Corresponds with the /lib[path]: flag of the various compiler tasks. + + - - Represents a compiler warning. - + + Represents a compiler warning. + - - A warning number, or comma-separated list of warnings, that you want - the compiler to suppress or report. - + + A warning number, or comma-separated list of warnings, that you want + the compiler to suppress or report. + - - If then the element will be processed; - otherwise, skipped. The default is . - + + If then the element will be processed; + otherwise, skipped. The default is . + - - If then the element will be skipped; - otherwise, processed. The default is . - + + If then the element will be skipped; + otherwise, processed. The default is . + @@ -3760,11 +3760,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -3797,10 +3797,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -3815,28 +3815,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -3876,25 +3876,25 @@ - - Create no debug information. - + + Create no debug information. + - - Enable attaching a debugger to the running program. - + + Enable attaching a debugger to the running program. + - - Enable attaching a debugger to the running program. - + + Enable attaching a debugger to the running program. + - - Only display assembler when the running program is attached to the - debugger. - + + Only display assembler when the running program is attached to the + debugger. + @@ -3949,20 +3949,20 @@ - - Not specified. - + + Not specified. + - - Fully sign the assembly. - + + Fully sign the assembly. + - - Only place the public key in the assembly, allowing the signature - to be added later. - + + Only place the public key in the assembly, allowing the signature + to be added later. + @@ -3991,12 +3991,12 @@ - - Represents an embedded resource. - - - Do not yet expose this to build authors. - + + Represents an embedded resource. + + + Do not yet expose this to build authors. + @@ -4007,20 +4007,20 @@ The manifest resource name of the embedded resource. - - Gets the physical location of the resource to embed. - - - The physical location of the resource to embed. - + + Gets the physical location of the resource to embed. + + + The physical location of the resource to embed. + - - Gets the manifest resource name to use when embedding the resource. - - - The manifest resource name to use when embedding the resource. - + + Gets the manifest resource name to use when embedding the resource. + + + The manifest resource name to use when embedding the resource. + @@ -4031,9 +4031,9 @@ - - Base class for collections that needs to be globally referencable. - + + Base class for collections that needs to be globally referencable. + @@ -4059,15 +4059,15 @@ - - Removes an item at a specific index. - - The zero-based index of the item to remove. + + Removes an item at a specific index. + + The zero-based index of the item to remove. - - Removes all items from the collection. - + + Removes all items from the collection. + @@ -4077,53 +4077,53 @@ The instance to verify. - - Checks whether the specified index is within the range of this - collection. - - The index to check. + + Checks whether the specified index is within the range of this + collection. + + The index to check. - - Gets a value indicating whether access to the collection is - synchronized (thread-safe). - - - . - + + Gets a value indicating whether access to the collection is + synchronized (thread-safe). + + + . + - - Gets the number of items in the collection. - - - The number of items in the collection. - + + Gets the number of items in the collection. + + + The number of items in the collection. + - - Gets an object that can be used to synchronize access to the - collection. - - - An object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the + collection. + + + An object that can be used to synchronize access to the collection. + - - Gets a value indicating whether the collection has a fixed size. - - - . - + + Gets a value indicating whether the collection has a fixed size. + + + . + - - Gets a value indicating whether the collection has a fixed size. - - - . - + + Gets a value indicating whether the collection has a fixed size. + + + . + @@ -4254,10 +4254,10 @@ - - Gets or sets the item at the specified index. - - The zero-based index of the item to get or set. + + Gets or sets the item at the specified index. + + The zero-based index of the item to get or set. @@ -4275,10 +4275,10 @@ - - Gets or sets the item at the specified index. - - The zero-based index of the item to get or set. + + Gets or sets the item at the specified index. + + The zero-based index of the item to get or set. @@ -4293,61 +4293,61 @@ The collection that should be enumerated. - - Advances the enumerator to the next item of the collection. - - - if the enumerator was successfully advanced - to the next item; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next item of the collection. + + + if the enumerator was successfully advanced + to the next item; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first item in the collection. - + + Sets the enumerator to its initial position, which is before the + first item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Represents a metadata file without assembly manifest. - + + Represents a metadata file without assembly manifest. + - - Returns a textual representation of the module, which can be used as - argument for command-line tools. - - - A textual representation of the path, file[,target]. - + + Returns a textual representation of the module, which can be used as + argument for command-line tools. + + + A textual representation of the path, file[,target]. + - - The path of the module. - + + The path of the module. + - - File name where the module should be copied to before it is compiled - into an assembly. - + + File name where the module should be copied to before it is compiled + into an assembly. + @@ -4387,9 +4387,9 @@ The zero-based index in at which copying begins. - - Removes all items from the collection. - + + Removes all items from the collection. + @@ -4526,46 +4526,46 @@ - - Gets a value indicating whether access to the collection is - synchronized (thread-safe). - - - . - + + Gets a value indicating whether access to the collection is + synchronized (thread-safe). + + + . + - - Gets the number of items in the collection. - - - The number of items in the collection. - + + Gets the number of items in the collection. + + + The number of items in the collection. + - - Gets an object that can be used to synchronize access to the - collection. - - - An object that can be used to synchronize access to the collection. - + + Gets an object that can be used to synchronize access to the + collection. + + + An object that can be used to synchronize access to the collection. + - - Gets a value indicating whether the collection has a fixed size. - - - . - + + Gets a value indicating whether the collection has a fixed size. + + + . + - - Gets a value indicating whether the collection has a fixed size. - - - . - + + Gets a value indicating whether the collection has a fixed size. + + + . + @@ -4587,57 +4587,57 @@ The collection that should be enumerated. - - Advances the enumerator to the next item of the collection. - - - if the enumerator was successfully advanced - to the next item; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next item of the collection. + + + if the enumerator was successfully advanced + to the next item; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first item in the collection. - + + Sets the enumerator to its initial position, which is before the + first item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - - One or more modules to compile into an assembly. - - - - - Define a global <moduleset> that can be referenced by - other tasks or types. - - - - - - - ]]> - - + + + One or more modules to compile into an assembly. + + + + + Define a global <moduleset> that can be referenced by + other tasks or types. + + + + + + + ]]> + + @@ -4656,9 +4656,9 @@ - - Represents a namespace to import. - + + Represents a namespace to import. + @@ -4675,38 +4675,38 @@ is . - - The name of the namespace to import. - - - The name of the namespace to import. - + + The name of the namespace to import. + + + The name of the namespace to import. + - - The name of the namespace to import. - - - The name of the namespace to import. - + + The name of the namespace to import. + + + The name of the namespace to import. + - - Indicates if the import should be generated. - - - if the import should be generated; otherwise, - . - + + Indicates if the import should be generated. + + + if the import should be generated; otherwise, + . + - - Indicates if the import should be not generated. - - - if the import should be not generated; - otherwise, . - + + Indicates if the import should be not generated. + + + if the import should be not generated; + otherwise, . + @@ -4862,10 +4862,10 @@ - - Gets or sets the item at the specified index. - - The zero-based index of the item to get or set. + + Gets or sets the item at the specified index. + + The zero-based index of the item to get or set. @@ -4882,10 +4882,10 @@ - - Gets or sets the item at the specified index. - - The zero-based index of the item to get or set. + + Gets or sets the item at the specified index. + + The zero-based index of the item to get or set. @@ -4900,62 +4900,62 @@ The collection that should be enumerated. - - Advances the enumerator to the next item of the collection. - - - if the enumerator was successfully advanced - to the next item; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next item of the collection. + + + if the enumerator was successfully advanced + to the next item; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first item in the collection. - + + Sets the enumerator to its initial position, which is before the + first item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Gets the current item in the collection. - - - The current item in the collection. - + + Gets the current item in the collection. + + + The current item in the collection. + - - Represents a package. - + + Represents a package. + - - Name of the package to reference. Multiple package can be specified - with a single element as a semi-colon separated list of - package names. - + + Name of the package to reference. Multiple package can be specified + with a single element as a semi-colon separated list of + package names. + - - Indicates if the package should be passed to the task. - If then the package will be passed; - otherwise, skipped. The default is . - + + Indicates if the package should be passed to the task. + If then the package will be passed; + otherwise, skipped. The default is . + - - Indicates if the package should not be passed to the task. - If then the package will be passed; - otherwise, skipped. The default is . - + + Indicates if the package should not be passed to the task. + If then the package will be passed; + otherwise, skipped. The default is . + @@ -5010,11 +5010,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -5047,10 +5047,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -5065,28 +5065,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -5099,12 +5099,12 @@ - - copy constructor for FileSet. Required in order to - assign references of FileSet type where - ResourceFileSet are used - - + + copy constructor for FileSet. Required in order to + assign references of FileSet type where + ResourceFileSet are used + + @@ -5115,41 +5115,41 @@ - - Gets the manifest resource name for the specified resource file. - - The physical path of the resource file. - - The manifest resource name to be sent to the compiler. - + + Gets the manifest resource name for the specified resource file. + + The physical path of the resource file. + + The manifest resource name to be sent to the compiler. + - - Gets the manifest resource name for the file using both its physical - and logical path. - - The physical path of the resource file. - The logical location of the resource file. - - The manifest resource name to be sent to the compiler. - - - We use the relative path of the logical path, but the filename and - and the extension of the physical path to match VS.NET - + + Gets the manifest resource name for the file using both its physical + and logical path. + + The physical path of the resource file. + The logical location of the resource file. + + The manifest resource name to be sent to the compiler. + + + We use the relative path of the logical path, but the filename and + and the extension of the physical path to match VS.NET + - - Indicates the prefix to prepend to the actual resource. - This is usually the default namspace of the assembly. - + + Indicates the prefix to prepend to the actual resource. + This is usually the default namspace of the assembly. + - - Indicates whether prefixes should be dynamically generated by taking - the path of the resource relative to the basedir and appending it - to the specified prefix. The default is . - + + Indicates whether prefixes should be dynamically generated by taking + the path of the resource relative to the basedir and appending it + to the specified prefix. The default is . + @@ -5220,11 +5220,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -5257,10 +5257,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -5275,59 +5275,59 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Controls the behaviour of a compiler with regards to the reporting of - warnings. - - - - Instruct a compiler to report warning 0519 as an error. - - - - - - ]]> - - - - - Instruct a compiler not to report warning 0519 as an error, if the - release property is . - - - - - - ]]> - - + + Controls the behaviour of a compiler with regards to the reporting of + warnings. + + + + Instruct a compiler to report warning 0519 as an error. + + + + + + ]]> + + + + + Instruct a compiler not to report warning 0519 as an error, if the + release property is . + + + + + + ]]> + + diff --git a/example_scripts/Tools/nant/bin/NAnt.MSNetTasks.xml b/example_scripts/Tools/nant/bin/NAnt.MSNetTasks.xml index 51409dc..8327211 100644 --- a/example_scripts/Tools/nant/bin/NAnt.MSNetTasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.MSNetTasks.xml @@ -50,20 +50,20 @@ - - Checks whether the task is initialized with valid attributes. - + + Checks whether the task is initialized with valid attributes. + - - Disassembles the PE file(s). - + + Disassembles the PE file(s). + - - Disassembles the specified PE file. - - The PE file to disassemble. + + Disassembles the specified PE file. + + The PE file to disassemble. @@ -80,9 +80,9 @@ The path of the output file could not be determined. - - Writes the disassembler options. - + + Writes the disassembler options. + @@ -115,76 +115,76 @@ - - Determines whether or not disassembling is needed. - - - if disassembling is needed; otherwise, - . - + + Determines whether or not disassembling is needed. + + + if disassembling is needed; otherwise, + . + - - Specifies whether or not the disassembler should combine the - /HEADER, /BYTE, and /TOKENS options. The default - is . - - - if the disassembler should combine the - /HEADER, /BYTE, and /TOKENS options; - otherwise, . The default is - . - - - - Corresponds to the /ALL flag. - - + + Specifies whether or not the disassembler should combine the + /HEADER, /BYTE, and /TOKENS options. The default + is . + + + if the disassembler should combine the + /HEADER, /BYTE, and /TOKENS options; + otherwise, . The default is + . + + + + Corresponds to the /ALL flag. + + - - Specifies whether or not the disassembler should generate the - IL stream bytes (in hexadecimal notation) as instruction comments. - The default is . - - - if the IL stream bytes should be generated - as instruction comments; otherwise, . The - default is . - - - - Corresponds to the /BYTE flag. - - + + Specifies whether or not the disassembler should generate the + IL stream bytes (in hexadecimal notation) as instruction comments. + The default is . + + + if the IL stream bytes should be generated + as instruction comments; otherwise, . The + default is . + + + + Corresponds to the /BYTE flag. + + - - Instructs NAnt to rebuild the output file regardless of the file - timestamps. The default is . - - - if the output file should be rebuilt - regardless of its timestamps; otherwise . - The default is . - + + Instructs NAnt to rebuild the output file regardless of the file + timestamps. The default is . + + + if the output file should be rebuilt + regardless of its timestamps; otherwise . + The default is . + - - Specifies whether or not the disassembler should include PE header - information and runtime header information in the output. The default - is . - - - if PE header information and runtime header - information should be included in the output; otherwise, - . The default is . - - - - Corresponds to the /HEADER flag. - - + + Specifies whether or not the disassembler should include PE header + information and runtime header information in the output. The default + is . + + + if PE header information and runtime header + information should be included in the output; otherwise, + . The default is . + + + + Corresponds to the /HEADER flag. + + @@ -196,36 +196,36 @@ - - Specifies whether or not the disassembler should include - references to original source lines. The default is . - - - if references to original source lines - should be included; otherwise, . The - default is . - - - - Corresponds to the /LINENUM flag. - - + + Specifies whether or not the disassembler should include + references to original source lines. The default is . + + + if references to original source lines + should be included; otherwise, . The + default is . + + + + Corresponds to the /LINENUM flag. + + - - Specifies whether or not the disassembler should suppress ILASM - code output. The default is . - - - if ILASM code output should be suppresses; - otherwise, . The default is - . - - - - Corresponds to the /NOIL flag. - - + + Specifies whether or not the disassembler should suppress ILASM + code output. The default is . + + + if ILASM code output should be suppresses; + otherwise, . The default is + . + + + + Corresponds to the /NOIL flag. + + @@ -245,103 +245,103 @@ - - Specifies whether or not the disassembler should enclose all names - in single quotation marks. By default, only names that don't match - the ILASM definition of a simple name are quoted. The default is - . - - - if all names should be enclosed in single - quotation marks; otherwise, . The default - is . - - - - Corresponds to the /QUOTEALLNAMES flag. - - + + Specifies whether or not the disassembler should enclose all names + in single quotation marks. By default, only names that don't match + the ILASM definition of a simple name are quoted. The default is + . + + + if all names should be enclosed in single + quotation marks; otherwise, . The default + is . + + + + Corresponds to the /QUOTEALLNAMES flag. + + - - Specifies whether or not the disassembler should generate - structured exception handling clauses in canonical (label) form. - The default is . - - - if structured exception handling clauses - should be generated in canonical form; otherwise, - . The default is . - - - - Corresponds to the /RAWEH flag. - - + + Specifies whether or not the disassembler should generate + structured exception handling clauses in canonical (label) form. + The default is . + + + if structured exception handling clauses + should be generated in canonical form; otherwise, + . The default is . + + + + Corresponds to the /RAWEH flag. + + - - Specifies whether or not the disassembler should generate - original source lines as comments. The default is . - - - if original source lines should be - generated as comments; otherwise, . - The default is . - - - - Corresponds to the /SOURCE flag. - - + + Specifies whether or not the disassembler should generate + original source lines as comments. The default is . + + + if original source lines should be + generated as comments; otherwise, . + The default is . + + + + Corresponds to the /SOURCE flag. + + - - Specifies whether or not the disassembler should generate metadata - token values as comments. The default is . - - - if metadata token values should be - generated as comments; otherwise, . The - default is . - - - - Corresponds to the /TOKENS flag. - - + + Specifies whether or not the disassembler should generate metadata + token values as comments. The default is . + + + if metadata token values should be + generated as comments; otherwise, . The + default is . + + + + Corresponds to the /TOKENS flag. + + - - Specifies whether or not the disassembler should use the UNICODE - encoding when generating the output. The default is ANSI. - - - if the output should be generated using - the UNICODE encoding; otherwise, . The - default is . - - - - Corresponds to the /UNICODE flag. - - + + Specifies whether or not the disassembler should use the UNICODE + encoding when generating the output. The default is ANSI. + + + if the output should be generated using + the UNICODE encoding; otherwise, . The + default is . + + + + Corresponds to the /UNICODE flag. + + - - Specifies whether or not the disassembler should use the UTF-8 - encoding when generating the output. The default is ANSI. - - - if the output should be generated using - the UTF-8 encoding; otherwise, . The - default is . - - - - Corresponds to the /UTF8 flag. - - + + Specifies whether or not the disassembler should use the UTF-8 + encoding when generating the output. The default is ANSI. + + + if the output should be generated using + the UTF-8 encoding; otherwise, . The + default is . + + + + Corresponds to the /UTF8 flag. + + @@ -408,13 +408,13 @@ - - The command-line arguments for the external program. - - - Overridden to ensure the <arg> elements would not be exposed - to build authors. - + + The command-line arguments for the external program. + + + Overridden to ensure the <arg> elements would not be exposed + to build authors. + @@ -426,25 +426,25 @@ - - Allows a Windows service to be controlled. - - - Starts the World Wide Web Publishing Service on the local computer. - - - ]]> - - - - Stops the Alerter service on computer 'MOTHER'. - - - ]]> - - + + Allows a Windows service to be controlled. + + + Starts the World Wide Web Publishing Service on the local computer. + + + ]]> + + + + Stops the Alerter service on computer 'MOTHER'. + + + ]]> + + @@ -453,9 +453,9 @@ - - Peforms actions on the service in order to reach the desired status. - + + Peforms actions on the service in order to reach the desired status. + @@ -503,77 +503,77 @@ instance for controlling the service identified by and . - - Holds the name of the service that should be controlled. - + + Holds the name of the service that should be controlled. + - - Holds the name of the computer on which the service resides. - + + Holds the name of the computer on which the service resides. + - - Holds the action that should be performed on the service. - + + Holds the action that should be performed on the service. + - - Holds the time, in milliseconds, the task will wait for a service - to reach the desired status. - + + Holds the time, in milliseconds, the task will wait for a service + to reach the desired status. + - - The name of the service that should be controlled. - + + The name of the service that should be controlled. + - - The name of the computer on which the service resides. The default - is the local computer. - + + The name of the computer on which the service resides. The default + is the local computer. + - - The action that should be performed on the service. - + + The action that should be performed on the service. + - - The time, in milliseconds, the task will wait for the service to - reach the desired status. The default is 5000 milliseconds. - + + The time, in milliseconds, the task will wait for the service to + reach the desired status. The default is 5000 milliseconds. + - - Defines the actions that can be performed on a service. - + + Defines the actions that can be performed on a service. + - - Starts a service. - + + Starts a service. + - - Stops a service. - + + Stops a service. + - - Restarts a service. - + + Restarts a service. + - - Pauses a running service. - + + Pauses a running service. + - - Continues a paused service. - + + Continues a paused service. + diff --git a/example_scripts/Tools/nant/bin/NAnt.NUnit.xml b/example_scripts/Tools/nant/bin/NAnt.NUnit.xml index e5dfa34..39d46d6 100644 --- a/example_scripts/Tools/nant/bin/NAnt.NUnit.xml +++ b/example_scripts/Tools/nant/bin/NAnt.NUnit.xml @@ -5,31 +5,31 @@ - - Carries data specified through the formatter element. - + + Carries data specified through the formatter element. + - - Gets or sets the type of the formatter. - - The type of the formatter. + + Gets or sets the type of the formatter. + + The type of the formatter. - - Gets or sets a value indicating whether output should be persisted - to a file. - - - if output should be written to a file; otherwise, - . The default is . - + + Gets or sets a value indicating whether output should be persisted + to a file. + + + if output should be written to a file; otherwise, + . The default is . + - - Gets or sets the extension to append to the output filename. - - The extension to append to the output filename. + + Gets or sets the extension to append to the output filename. + + The extension to append to the output filename. @@ -92,11 +92,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -129,10 +129,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -147,64 +147,64 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - The built-in formatter types. - + + The built-in formatter types. + - - A plaintext formatter. - + + A plaintext formatter. + - - An XML formatter. - + + An XML formatter. + - - Represents the FormatterElement of the NUnit task. - + + Represents the FormatterElement of the NUnit task. + - - Type of formatter. - + + Type of formatter. + - - Extension to append to the output filename. - + + Extension to append to the output filename. + - - Determines whether output should be persisted to a file. The default - is . - + + Determines whether output should be persisted to a file. The default + is . + @@ -271,11 +271,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -308,10 +308,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -326,28 +326,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + diff --git a/example_scripts/Tools/nant/bin/NAnt.NUnit1Tasks.xml b/example_scripts/Tools/nant/bin/NAnt.NUnit1Tasks.xml index 1dc317d..941273b 100644 --- a/example_scripts/Tools/nant/bin/NAnt.NUnit1Tasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.NUnit1Tasks.xml @@ -5,14 +5,14 @@ - - The whole test suite started. - + + The whole test suite started. + - - The whole test suite ended. - + + The whole test suite ended. + @@ -72,11 +72,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -109,10 +109,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -127,42 +127,42 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Prints information about running tests directly to the build log. - + + Prints information about running tests directly to the build log. + - Not used, all output goes to Log class. + Not used, all output goes to Log class. - Called when the whole test suite has started. + Called when the whole test suite has started. - Called when the whole test suite has ended. + Called when the whole test suite has ended. Convert a stack trace line into something that can be clicked on in an IDE output window. @@ -207,35 +207,35 @@ - - Stops running tests when a test causes an error. The default is - . - - - Implies haltonfailure. - + + Stops running tests when a test causes an error. The default is + . + + + Implies haltonfailure. + - - Stops running tests if a test fails (errors are considered failures - as well). The default is . - + + Stops running tests if a test fails (errors are considered failures + as well). The default is . + - - Cancel the individual tests if they do not finish in the specified - time (measured in milliseconds). Ignored if fork is disabled. - + + Cancel the individual tests if they do not finish in the specified + time (measured in milliseconds). Ignored if fork is disabled. + - - Tests to run. - + + Tests to run. + - - Formatters to output results of unit tests. - + + Formatters to output results of unit tests. + @@ -243,25 +243,25 @@ - - Base name of the test result. The full filename is determined by this - attribute and the extension of formatter. - + + Base name of the test result. The full filename is determined by this + attribute and the extension of formatter. + - - Directory to write the reports to. - + + Directory to write the reports to. + - - Class name of the test. - + + Class name of the test. + - - Assembly to load the test from. - + + Assembly to load the test from. + @@ -269,20 +269,20 @@ - - Stop the build process if an error occurs during the test run. - + + Stop the build process if an error occurs during the test run. + - - Stop the build process if a test fails (errors are considered failures - as well). - + + Stop the build process if a test fails (errors are considered failures + as well). + - - The application configuration file to use for the NUnit test domain. - + + The application configuration file to use for the NUnit test domain. + @@ -336,11 +336,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -373,10 +373,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -391,98 +391,98 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Carries data specified through the test element. - + + Carries data specified through the test element. + - - Determines if the unit test needs running. - - - if unit test needs running, otherwise, - . - - - - Determines if the test needs running by looking at the date stamp - of the test assembly and the test results log. - - + + Determines if the unit test needs running. + + + if unit test needs running, otherwise, + . + + + + Determines if the test needs running by looking at the date stamp + of the test assembly and the test results log. + + - - Runs a Suite extracted from a TestCase subclass. - + + Runs a Suite extracted from a TestCase subclass. + - - Creates the formatters to be used when running this test. - + + Creates the formatters to be used when running this test. + - - Returns the output file or null if does not use a file. - + + Returns the output file or null if does not use a file. + - - Returns the test suite from a given class. - - - The assemblyQualifiedName parameter needs to be in form: - "full.qualified.class.name,Assembly" - + + Returns the test suite from a given class. + + + The assemblyQualifiedName parameter needs to be in form: + "full.qualified.class.name,Assembly" + - - Gets the collection of registered formatters. - - Collection of registered formatters. + + Gets the collection of registered formatters. + + Collection of registered formatters. - - Gets the result of the test. - - The result of the test. + + Gets the result of the test. + + The result of the test. - - Prints information about running tests in plain text. - + + Prints information about running tests in plain text. + - Sets the Writer the formatter is supposed to write its results to. + Sets the Writer the formatter is supposed to write its results to. - Called when the whole test suite has started. + Called when the whole test suite has started. - Called when the whole test suite has ended. + Called when the whole test suite has ended. Convert a stack trace line into something that can be clicked on in an IDE output window. @@ -502,15 +502,15 @@ - - Gets or sets the total run-time of a test. - - The total run-time of a test. + + Gets or sets the total run-time of a test. + + The total run-time of a test. - - Prints detailed information about running tests in XML format. - + + Prints detailed information about running tests in XML format. + @@ -525,14 +525,14 @@ - - Called when the whole test suite has started. - + + Called when the whole test suite has started. + - - Called when the whole test suite has ended. - + + Called when the whole test suite has ended. + diff --git a/example_scripts/Tools/nant/bin/NAnt.NUnit2Tasks.xml b/example_scripts/Tools/nant/bin/NAnt.NUnit2Tasks.xml index 95682c6..6f9f9f1 100644 --- a/example_scripts/Tools/nant/bin/NAnt.NUnit2Tasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.NUnit2Tasks.xml @@ -34,36 +34,36 @@ - - Specifies a list of categories to include. - + + Specifies a list of categories to include. + - - Specifies a list of categories to exclude. - + + Specifies a list of categories to exclude. + - - Represents a certain group of test cases or fixtures. - + + Represents a certain group of test cases or fixtures. + - - A name of a category, or comma-separated list of names. - + + A name of a category, or comma-separated list of names. + - - If then the category will be processed; - otherwise, skipped. The default is . - + + If then the category will be processed; + otherwise, skipped. The default is . + - - If then the category will be skipped; - otherwise, processed. The default is . - + + If then the category will be skipped; + otherwise, processed. The default is . + @@ -138,11 +138,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -175,10 +175,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -199,28 +199,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -303,24 +303,24 @@ - - Runs the tests and sets up the formatters. - + + Runs the tests and sets up the formatters. + - - Stop the test run if a test fails. The default is . - + + Stop the test run if a test fails. The default is . + - - Tests to run. - + + Tests to run. + - - Formatters to output results of unit tests. - + + Formatters to output results of unit tests. + @@ -328,35 +328,35 @@ - - Name of the assembly to search for tests. - + + Name of the assembly to search for tests. + - - Name of a specific testfixture to run. If not specified then all - testfixtures are run. - + + Name of a specific testfixture to run. If not specified then all + testfixtures are run. + - - Assemblies to include in test. - + + Assemblies to include in test. + - - Assemblies to scan for missing assembly references. - + + Assemblies to scan for missing assembly references. + - - Categories of test cases to include or exclude. - + + Categories of test cases to include or exclude. + - - Build fails on failure. The default is . - + + Build fails on failure. The default is . + @@ -365,19 +365,19 @@ - - The application configuration file to use for the NUnit test domain. - If not specified, NAnt will try to use a configuration name matching - the file name of the assembly with extension ".config". - + + The application configuration file to use for the NUnit test domain. + If not specified, NAnt will try to use a configuration name matching + the file name of the assembly with extension ".config". + - - Gets all assemblies specified for these tests. - - - All assemblies specified for these tests. - + + Gets all assemblies specified for these tests. + + + All assemblies specified for these tests. + @@ -431,11 +431,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -468,10 +468,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -486,34 +486,34 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Custom TestDomain, similar to the one included with NUnit, in order - to workaround some limitations in it. - + + Custom TestDomain, similar to the one included with NUnit, in order + to workaround some limitations in it. + @@ -522,20 +522,20 @@ - - Runs a single testcase. - - The test assembly. - The application configuration file for the test domain. - List of files to scan for missing assembly references. - - The result of the test. - + + Runs a single testcase. + + The test assembly. + The application configuration file for the test domain. + List of files to scan for missing assembly references. + + The result of the test. + - - Helper class called when an assembly resolve event is raised. - + + Helper class called when an assembly resolve event is raised. + @@ -564,21 +564,21 @@ An that contains the event data. - - Holds the list of directories that will be scanned for missing - assembly references. - + + Holds the list of directories that will be scanned for missing + assembly references. + - - Holds the list of assemblies that can be scanned for missing - assembly references. - + + Holds the list of assemblies that can be scanned for missing + assembly references. + - - Holds the loaded assemblies. - + + Holds the loaded assemblies. + diff --git a/example_scripts/Tools/nant/bin/NAnt.SourceControlTasks.xml b/example_scripts/Tools/nant/bin/NAnt.SourceControlTasks.xml index 2e5cb8f..b504997 100644 --- a/example_scripts/Tools/nant/bin/NAnt.SourceControlTasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.SourceControlTasks.xml @@ -5,44 +5,44 @@ - - A base class for creating tasks for executing CVS client commands on a - CVS repository. - + + A base class for creating tasks for executing CVS client commands on a + CVS repository. + - - A base class for creating tasks for executing CVS client commands on a - CVS repository. - + + A base class for creating tasks for executing CVS client commands on a + CVS repository. + - - Name of the environmental variable specifying a users' home - in a *nix environment. - + + Name of the environmental variable specifying a users' home + in a *nix environment. + - - Used on windows to specify the location of application data. - + + Used on windows to specify the location of application data. + - - The environment variable that holds path information. - + + The environment variable that holds path information. + - - The environment variable that holds the location of the - .cvspass file. - + + The environment variable that holds the location of the + .cvspass file. + - - Property name used to specify the source control executable. This is - used as a readonly property. - + + Property name used to specify the source control executable. This is + used as a readonly property. + @@ -51,245 +51,245 @@ - - Build up the command line arguments, determine which executable is being - used and find the path to that executable and set the working - directory. - - The process to prepare. + + Build up the command line arguments, determine which executable is being + used and find the path to that executable and set the working + directory. + + The process to prepare. - - Adds a new global option if none exists. If one does exist then - the use switch is toggled on or of. - - The common name of the option. - The option value or command line switch - of the option. - true if the option should be - appended to the commandline, otherwise false. + + Adds a new global option if none exists. If one does exist then + the use switch is toggled on or of. + + The common name of the option. + The option value or command line switch + of the option. + true if the option should be + appended to the commandline, otherwise false. - - Adds a new command option if none exists. If one does exist then - the use switch is toggled on or of. - - The common name of the option. - The option value or command line switch - of the option. - true if the option should be - appended to the commandline, otherwise false. + + Adds a new command option if none exists. If one does exist then + the use switch is toggled on or of. + + The common name of the option. + The option value or command line switch + of the option. + true if the option should be + appended to the commandline, otherwise false. - - Set up the environment variables for a process. - - A process to setup. + + Set up the environment variables for a process. + + A process to setup. - - Append the files specified in the fileset to the command line argument. - Files are changed to use a relative path from the working directory - that the task is spawned in. - + + Append the files specified in the fileset to the command line argument. + Files are changed to use a relative path from the working directory + that the task is spawned in. + - - Derive the location of the version control system from the environment - variable PATH. - - The file information of the version control system, - or null if this cannot be found. + + Derive the location of the version control system from the environment + variable PATH. + + The file information of the version control system, + or null if this cannot be found. - - The name of the passfile, overriden for each version control system (VCS). - + + The name of the passfile, overriden for each version control system (VCS). + - - The path to the specific home directory of the version control system, - this can be where the binary files are kept, or other app - information. - + + The path to the specific home directory of the version control system, + this can be where the binary files are kept, or other app + information. + - - The environment variable that defines where the version control system - (VCS) home variable is kept. - + + The environment variable that defines where the version control system + (VCS) home variable is kept. + - - The name of the version control system (VCS) executable file. - + + The name of the version control system (VCS) executable file. + - - - The root variable contains information on how to locate a repository. - Although this information is in different formats it typically must - define the following: - - server location - protocol used to communicate with the repository - repository location on the server - project location in the repository - - - + + + The root variable contains information on how to locate a repository. + Although this information is in different formats it typically must + define the following: + + server location + protocol used to communicate with the repository + repository location on the server + project location in the repository + + + - - Destination directory for the local sandbox. If destination is not specified - then the current directory is used. - - - Root path of the local sandbox. - - - - Root path of the local sandbox. - - + + Destination directory for the local sandbox. If destination is not specified + then the current directory is used. + + + Root path of the local sandbox. + + + + Root path of the local sandbox. + + - - The password for logging in to the repository. - - - The password for logging in to the repository. - + + The password for logging in to the repository. + + + The password for logging in to the repository. + - - The full path to the cached password file. If not specified then the - environment variables are used to try and locate the file. - + + The full path to the cached password file. If not specified then the + environment variables are used to try and locate the file. + - - Holds a collection of globally available options. - + + Holds a collection of globally available options. + - - A collection of options that can be used to modify the default behavoir - of the version control commands. See the sub-tasks for implementation - specifics. - + + A collection of options that can be used to modify the default behavoir + of the version control commands. See the sub-tasks for implementation + specifics. + - - Command-line arguments for the program. The command line arguments are used to specify - any cvs command options that are not available as attributes. These are appended - after the command itself and are additive to whatever attributes are currently specified. - - - <cvs-checkout cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant" - module="nant" - destination="e:\test\merillcornish\working" - readonly="true" - quiet="true" - commandline="-n" - cvsfullpath="C:\Program Files\TortoiseCVS\cvs.exe" - /> -
- Produces the cvs command: - c:\Program Files\TortoiseCVS\cvs.exe -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant -q checkout -n nant - + + Command-line arguments for the program. The command line arguments are used to specify + any cvs command options that are not available as attributes. These are appended + after the command itself and are additive to whatever attributes are currently specified. + + + <cvs-checkout cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant" + module="nant" + destination="e:\test\merillcornish\working" + readonly="true" + quiet="true" + commandline="-n" + cvsfullpath="C:\Program Files\TortoiseCVS\cvs.exe" + /> +
+ Produces the cvs command: + c:\Program Files\TortoiseCVS\cvs.exe -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant -q checkout -n nant + - - The name of the command that is going to be executed. - + + The name of the command that is going to be executed. + - - Used to specify the version control system (VCS) files that are going - to be acted on. - + + Used to specify the version control system (VCS) files that are going + to be acted on. + - - The executable to use for ssh communication. - + + The executable to use for ssh communication. + - - The environment name for the ssh variable. - + + The environment name for the ssh variable. + - - The name of the version control system executable. - + + The name of the version control system executable. + - - Get the command line arguments for the task. - + + Get the command line arguments for the task. + - - Default value for the recursive directive. The default is - . - + + Default value for the recursive directive. The default is + . + - - Default value for the quiet command. - + + Default value for the quiet command. + - - Default value for the really quiet command. - + + Default value for the really quiet command. + - - An environment variable that holds path information about where - cvs is located. - + + An environment variable that holds path information about where + cvs is located. + - - Name of the password file that cvs stores pserver - cvsroot/ password pairings. - + + Name of the password file that cvs stores pserver + cvsroot/ password pairings. + - - The default compression level to use for cvs commands. - + + The default compression level to use for cvs commands. + - - The default use of binaries, defaults to use sharpcvs. - + + The default use of binaries, defaults to use sharpcvs. + - - The name of the cvs executable. - + + The name of the cvs executable. + - - The temporary name of the sharpcvslib binary file, to avoid - conflicts in the path variable. - + + The temporary name of the sharpcvslib binary file, to avoid + conflicts in the path variable. + - - Environment variable that holds the executable name that is used for - ssh communication. - + + Environment variable that holds the executable name that is used for + ssh communication. + - - Property name used to specify on a project level whether sharpcvs is - used or not. - + + Property name used to specify on a project level whether sharpcvs is + used or not. + @@ -308,244 +308,244 @@ - - Build up the command line arguments, determine which executable is being - used and find the path to that executable and set the working - directory. - - The process to prepare. + + Build up the command line arguments, determine which executable is being + used and find the path to that executable and set the working + directory. + + The process to prepare. - - Override to append any commands before the modele and files. - + + Override to append any commands before the modele and files. + - - Append the command line options or commen names for the options - to the generic options collection. This is then piped to the - command line as a switch. - + + Append the command line options or commen names for the options + to the generic options collection. This is then piped to the + command line as a switch. + - - Add the given argument to the command line options. Note that are not explicitly - quoted are split into seperate arguments. This is to resolve a recent issue - with quoting command line arguments. - - + + Add the given argument to the command line options. Note that are not explicitly + quoted are split into seperate arguments. This is to resolve a recent issue + with quoting command line arguments. + + - - The environment name for the ssh variable. - + + The environment name for the ssh variable. + - - The name of the cvs binary, or cvs.exe at the time this - was written. - + + The name of the cvs binary, or cvs.exe at the time this + was written. + - - The name of the pass file, or .cvspass at the time - of this writing. - + + The name of the pass file, or .cvspass at the time + of this writing. + - - The name of the version control system specific home environment - variable. - + + The name of the version control system specific home environment + variable. + - - Specify if the module is needed for this cvs command. It is - only needed if there is no module information on the local file - system. - + + Specify if the module is needed for this cvs command. It is + only needed if there is no module information on the local file + system. + - - Used to specify the version control system (VCS) files that are going - to be acted on. - + + Used to specify the version control system (VCS) files that are going + to be acted on. + - - Get the cvs file set. - + + Get the cvs file set. + - - The name of the cvs executable. - + + The name of the cvs executable. + - - The full path to the cvs binary used. The cvs tasks will attempt to - "guess" the location of your cvs binary based on your path. If the - task is unable to resolve the location, or resolves it incorrectly - this can be used to manually specify the path. - - - A full path (i.e. including file name) of your cvs binary: - On Windows: c:\vcs\cvs\cvs.exe - On *nix: /usr/bin/cvs - + + The full path to the cvs binary used. The cvs tasks will attempt to + "guess" the location of your cvs binary based on your path. If the + task is unable to resolve the location, or resolves it incorrectly + this can be used to manually specify the path. + + + A full path (i.e. including file name) of your cvs binary: + On Windows: c:\vcs\cvs\cvs.exe + On *nix: /usr/bin/cvs + - - - The cvs root variable has the following components: - - - [protocol]:[username]@[servername]:[server path] -
    -
  • protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation.
    • -
  • username: [username]
    • -
  • servername: cvs.sourceforge.net
    • -
  • server path: /cvsroot/nant
    • -
- - - - NAnt anonymous cvsroot: - - :pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant - - + + + The cvs root variable has the following components: + + + [protocol]:[username]@[servername]:[server path] +
    +
  • protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation.
    • +
  • username: [username]
    • +
  • servername: cvs.sourceforge.net
    • +
  • server path: /cvsroot/nant
    • +
+ + + + NAnt anonymous cvsroot: + + :pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant + + - - The module to perform an operation on. - - - The module to perform an operation on. This is a normal file/folder - name without path information. - - - In NAnt the module name would be: - nant - + + The module to perform an operation on. + + + The module to perform an operation on. This is a normal file/folder + name without path information. + + + In NAnt the module name would be: + nant + - - - if the SharpCvsLib binaries that come bundled - with NAnt should be used to perform the cvs commands, - otherwise. - - - You may also specify an override value for all cvs tasks instead - of specifying a value for each. To do this set the property - sourcecontrol.usesharpcvslib to . - - - If you choose not to use SharpCvsLib to checkout from cvs you will - need to include a cvs.exe binary in your path. - - - - To use a cvs client in your path instead of sharpcvslib specify - the property: - >property name="sourcecontrol.usesharpcvslib" value="false"< - The default settings is to use sharpcvslib and the setting closest - to the task execution is used to determine which value is used - to execute the process. - For instance if the attribute usesharpcvslib was set to false - and the global property was set to true, the usesharpcvslib is - closes to the point of execution and would be used and is false. - Therefore the sharpcvslib binary would NOT be used. - + + + if the SharpCvsLib binaries that come bundled + with NAnt should be used to perform the cvs commands, + otherwise. + + + You may also specify an override value for all cvs tasks instead + of specifying a value for each. To do this set the property + sourcecontrol.usesharpcvslib to . + + + If you choose not to use SharpCvsLib to checkout from cvs you will + need to include a cvs.exe binary in your path. + + + + To use a cvs client in your path instead of sharpcvslib specify + the property: + >property name="sourcecontrol.usesharpcvslib" value="false"< + The default settings is to use sharpcvslib and the setting closest + to the task execution is used to determine which value is used + to execute the process. + For instance if the attribute usesharpcvslib was set to false + and the global property was set to true, the usesharpcvslib is + closes to the point of execution and would be used and is false. + Therefore the sharpcvslib binary would NOT be used. + - - The executable to use for ssh communication. - + + The executable to use for ssh communication. + - - Indicates if the output from the cvs command should be supressed. - The default is . - + + Indicates if the output from the cvs command should be supressed. + The default is . + - - Indicates if the output from the cvs command should be stopped. - The default is . - + + Indicates if the output from the cvs command should be stopped. + The default is . + - - if the sandbox files should be checked out in - read only mode. The default is . - + + if the sandbox files should be checked out in + read only mode. The default is . + - - if the sandbox files should be checked out in - read/write mode. The default is . - + + if the sandbox files should be checked out in + read/write mode. The default is . + - - Compression level to use for all net traffic. This should be a value from 1-9. -
-
- NOTE: This is not available on sharpcvslib. - + + Compression level to use for all net traffic. This should be a value from 1-9. +
+
+ NOTE: This is not available on sharpcvslib. + - - Produces an XML report that represents the cvs changes from the given - start day, to a given end date. - - - Report changes in NAnt from 1st of June 2004 until 25th of July 2004. - - - ]]> - - + + Produces an XML report that represents the cvs changes from the given + start day, to a given end date. + + + Report changes in NAnt from 1st of June 2004 until 25th of July 2004. + + + ]]> + + - - The command being executed. - + + The command being executed. + - - Name of the xml file that will contain the cvs log information. - + + Name of the xml file that will contain the cvs log information. + - - The earliest change to use in the cvs log command. - + + The earliest change to use in the cvs log command. + - - The latest date to use in the cvs log command. - + + The latest date to use in the cvs log command. + - - The cvs command to execute. - + + The cvs command to execute. + - - Override use of sharpcvslib, needs to be true. - + + Override use of sharpcvslib, needs to be true. + @@ -575,61 +575,61 @@ - - Checks out a CVS module to the required directory. - - - Checkout NAnt. - - - ]]> - - - - - Checkout NAnt revision named 0_85 to the - folder c:\src\nant\v0.85. - - - - ]]> - - So the nant module tagged with revision 0_85 will be checked - out in the folder v0.85 under the working/ destination directory. -
This could be used to work on different - branches of a repository at the same time. - - - - Checkout NAnt with specified revision date to the - folder c:\src\nant\2003_08_16. - - - - ]]> - - + + Checks out a CVS module to the required directory. + + + Checkout NAnt. + + + ]]> + + + + + Checkout NAnt revision named 0_85 to the + folder c:\src\nant\v0.85. + + + + ]]> + + So the nant module tagged with revision 0_85 will be checked + out in the folder v0.85 under the working/ destination directory. +
This could be used to work on different + branches of a repository at the same time. + + + + Checkout NAnt with specified revision date to the + folder c:\src\nant\2003_08_16. + + + + ]]> + + - - The command being executed. - + + The command being executed. + @@ -637,55 +637,55 @@ - - Specify the revision to checkout. This corresponds to the "sticky-tag" - of the file. - + + Specify the revision to checkout. This corresponds to the "sticky-tag" + of the file. + - - Sticky tag or revision to checkout. - + + Sticky tag or revision to checkout. + - - Specify the revision date to checkout. The date specified is validated - and then passed to the cvs binary in a standard format recognized by - cvs. - + + Specify the revision date to checkout. The date specified is validated + and then passed to the cvs binary in a standard format recognized by + cvs. + - - Specify a directory name to replace the module name. Valid names - include any valid filename, excluding path information. - + + Specify a directory name to replace the module name. Valid names + include any valid filename, excluding path information. + - - Specify a directory name to replace the module name. Valid names - include any valid filename, excluding path information. - + + Specify a directory name to replace the module name. Valid names + include any valid filename, excluding path information. + - - The name of the cvs command that is going to be executed. - + + The name of the cvs command that is going to be executed. + - - Executes the cvs login command which appends or updates an entry to the - specified .cvspass file. - - - Update .cvspass file to include the NAnt anonymous login. - - - ]]> - - + + Executes the cvs login command which appends or updates an entry to the + specified .cvspass file. + + + Update .cvspass file to include the NAnt anonymous login. + + + ]]> + + @@ -693,111 +693,111 @@ - - Update the .cvspass file with the given password. If the passfile - is not specified then the default search locations are used: - - CVS_PASSFILE/.cvspass - HOME/.cvspass - USERPROFILE/.cvspass TODO: Confirm that this is valid - behavior or if it is going to give problems with the - cvsnt implementation. - - + + Update the .cvspass file with the given password. If the passfile + is not specified then the default search locations are used: + + CVS_PASSFILE/.cvspass + HOME/.cvspass + USERPROFILE/.cvspass TODO: Confirm that this is valid + behavior or if it is going to give problems with the + cvsnt implementation. + + - - Password to append or update to the .cvspass file. - + + Password to append or update to the .cvspass file. + - - The full path to the .cvspass file. The default is ~/.cvspass. - - + + The full path to the .cvspass file. The default is ~/.cvspass. + + - - The current working directory. - + + The current working directory. + - - The repository root string. - + + The repository root string. + - - Executes the cvs command specified by the command attribute. - - - Checkout NAnt. - - - ]]> - - + + Executes the cvs command specified by the command attribute. + + + Checkout NAnt. + + + ]]> + + - - The cvs command to execute. - + + The cvs command to execute. + - - Specify if the module is needed for this cvs command. - + + Specify if the module is needed for this cvs command. + - - Exports a cvs module in preperation for a release (i.e. the CVS version - folders are not exported). - - - Export the most recent NAnt sources from cvs. - - - ]]> - - - - - Export NAnt revision named your_favorite_revision_here to the - folder c:\src\nant\replacement_for_module_directory_name. - - **NOTE**: filesets names for the export task must be - prefixed with the module name. This is different than other tasks. - - - - - - - - - ]]> - - + + Exports a cvs module in preperation for a release (i.e. the CVS version + folders are not exported). + + + Export the most recent NAnt sources from cvs. + + + ]]> + + + + + Export NAnt revision named your_favorite_revision_here to the + folder c:\src\nant\replacement_for_module_directory_name. + + **NOTE**: filesets names for the export task must be + prefixed with the module name. This is different than other tasks. + + + + + + + + + ]]> + + - - The command being executed. - + + The command being executed. + @@ -811,9 +811,9 @@ - - No shortening. Do not shorten module paths if -d specified. - + + No shortening. Do not shorten module paths if -d specified. + @@ -827,82 +827,82 @@ - - If a directory is specified indicates whether sub-directories should - also be processed. - - - if the sub-directories should be tagged; - otherwise, . The default is . - + + If a directory is specified indicates whether sub-directories should + also be processed. + + + if the sub-directories should be tagged; + otherwise, . The default is . + - - Specify the revision to update the file to. This corresponds to the "sticky-tag" - of the file. - + + Specify the revision to update the file to. This corresponds to the "sticky-tag" + of the file. + - - Specify the revision date to update to. The version of the file that - existed at the date specified is retrieved. - - - A valid date time value, which is then converted to a format that - cvs can parse. - + + Specify the revision date to update to. The version of the file that + existed at the date specified is retrieved. + + + A valid date time value, which is then converted to a format that + cvs can parse. + - - Specify a directory name to replace the module name. Valid names - include any valid filename, excluding path information. - + + Specify a directory name to replace the module name. Valid names + include any valid filename, excluding path information. + - - The export command name for the cvs client. - + + The export command name for the cvs client. + - - Tags all sources in the remote repository with a given tag. - - - - Unlike tag, the rtag command acts only on sources that are in the repository. - Any modified sources on the local file system will NOT be tagged with this - command, so a commit should be performed before an rtag is done. - - - NOTE: Although a working directory is not necessary to perform the command - one must be specified in order to remain in compliance with the cvs library. - - - - Tag NAnt sources remotely. - - - ]]> - - - - Remove a tag from the remote repository. - - - ]]> - - + + Tags all sources in the remote repository with a given tag. + + + + Unlike tag, the rtag command acts only on sources that are in the repository. + Any modified sources on the local file system will NOT be tagged with this + command, so a commit should be performed before an rtag is done. + + + NOTE: Although a working directory is not necessary to perform the command + one must be specified in order to remain in compliance with the cvs library. + + + + Tag NAnt sources remotely. + + + ]]> + + + + Remove a tag from the remote repository. + + + ]]> + + @@ -911,17 +911,17 @@ - - Append the tag information to the commandline. - + + Append the tag information to the commandline. + - - The name of the tag to assign or remove. - - - The name of the tag to assign or remove. - + + The name of the tag to assign or remove. + + + The name of the tag to assign or remove. + @@ -945,14 +945,14 @@ - - If a directory is specified indicates whether sub-directories should - also be processed. - - - if the sub-directories should be tagged; - otherwise, . The default is . - + + If a directory is specified indicates whether sub-directories should + also be processed. + + + if the sub-directories should be tagged; + otherwise, . The default is . + @@ -966,14 +966,14 @@ - - Indicates the revision date of the file that the tag should be - applied to. - - - A valid date which specifies the revision point that the tag will - be applied to. - + + Indicates the revision date of the file that the tag should be + applied to. + + + A valid date which specifies the revision point that the tag will + be applied to. + @@ -987,9 +987,9 @@ - - The name of the cvs command that is going to be executed. - + + The name of the cvs command that is going to be executed. + @@ -1032,9 +1032,9 @@ - - Cvs command to be executed. - + + Cvs command to be executed. + @@ -1043,17 +1043,17 @@ - - Append the tag information to the commandline. - + + Append the tag information to the commandline. + - - The name of the tag to assign or remove. - - - The name of the tag to assign or remove. - + + The name of the tag to assign or remove. + + + The name of the tag to assign or remove. + @@ -1077,14 +1077,14 @@ - - If a directory is specified indicates whether sub-directories should - also be processed. - - - if the sub-directories should be tagged; - otherwise, . The default is . - + + If a directory is specified indicates whether sub-directories should + also be processed. + + + if the sub-directories should be tagged; + otherwise, . The default is . + @@ -1098,14 +1098,14 @@ - - Indicates the revision date of the file that the tag should be - applied to. - - - A valid date which specifies the revision point that the tag will - be applied to. - + + Indicates the revision date of the file that the tag should be + applied to. + + + A valid date which specifies the revision point that the tag will + be applied to. + @@ -1130,64 +1130,64 @@ - - The name of the cvs command that is going to be executed. - + + The name of the cvs command that is going to be executed. + - - Not used - + + Not used + - - Specify if the module is needed for this cvs command. It is - only needed if there is no module information on the local file - system. - + + Specify if the module is needed for this cvs command. It is + only needed if there is no module information on the local file + system. + - - Updates a CVS module in a local working directory. - - - Update nant. - - - ]]> - - - - - Update your NAnt revision named your_favorite_revision_here in - the folder c:\src\nant\replacement_for_module_directory_name. - - - - - - - - ]]> - - + + Updates a CVS module in a local working directory. + + + Update nant. + + + ]]> + + + + + Update your NAnt revision named your_favorite_revision_here in + the folder c:\src\nant\replacement_for_module_directory_name. + + + + + + + + ]]> + + - - The command being executed. - + + The command being executed. + @@ -1200,69 +1200,69 @@ - - If . new directories will be created on the local - sandbox. The default is . - + + If . new directories will be created on the local + sandbox. The default is . + - - If empty directories copied down from the - remote repository will be removed from the local sandbox. - The default is . - + + If empty directories copied down from the + remote repository will be removed from the local sandbox. + The default is . + - - If the local copy of the file will be - overwritten with the copy from the remote repository. The default - is . - + + If the local copy of the file will be + overwritten with the copy from the remote repository. The default + is . + - - Specifies if the command should be executed recursively. The - default is . - - - The -R option is on by default in cvs. - + + Specifies if the command should be executed recursively. The + default is . + + + The -R option is on by default in cvs. + - - Specify the revision to update the file to. This corresponds to the - "sticky-tag" of the file. - + + Specify the revision to update the file to. This corresponds to the + "sticky-tag" of the file. + - - Sticky tag or revision to update the local file to. - - - A valid cvs tag. - + + Sticky tag or revision to update the local file to. + + + A valid cvs tag. + - - Specify the revision date to update to. The version of the file that - existed at the date specified is retrieved. - - - A valid date time value, which is then converted to a format that - cvs can parse. - + + Specify the revision date to update to. The version of the file that + existed at the date specified is retrieved. + + + A valid date time value, which is then converted to a format that + cvs can parse. + - - Specify if the module is needed for this cvs command. It is - only needed if there is no module information on the local file - system. - + + Specify if the module is needed for this cvs command. It is + only needed if there is no module information on the local file + system. + - - The name of the cvs command that is going to be executed. - + + The name of the cvs command that is going to be executed. + @@ -1277,11 +1277,11 @@ - - Indicates whether the entires in the .cvsignore should be used to limit the - file list; to exclude files in .cvsignore, otherwise - . The default is . - + + Indicates whether the entires in the .cvsignore should be used to limit the + file list; to exclude files in .cvsignore, otherwise + . The default is . + diff --git a/example_scripts/Tools/nant/bin/NAnt.VSNetTasks.xml b/example_scripts/Tools/nant/bin/NAnt.VSNetTasks.xml index 8220497..7a67649 100644 --- a/example_scripts/Tools/nant/bin/NAnt.VSNetTasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.VSNetTasks.xml @@ -5,9 +5,9 @@ - - Analyses Microsoft Visual Studio .NET 2003 (Everett) solution files. - + + Analyses Microsoft Visual Studio .NET 2003 (Everett) solution files. + @@ -20,14 +20,14 @@ No project with unique identifier could be located. - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the underlying task. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the underlying task. + @@ -51,15 +51,15 @@ A project GUID in the solution file does not match the actual GUID of the project in the project file. - - Translates a project path, in the form of a relative file path or - a URL, to an absolute file path. - - The directory of the solution. - The project path to translate to an absolute file path. - - The project path translated to an absolute file path. - + + Translates a project path, in the form of a relative file path or + a URL, to an absolute file path. + + The directory of the solution. + The project path to translate to an absolute file path. + + The project path translated to an absolute file path. + @@ -84,20 +84,20 @@ - - Returns a number representing how much this file fits this project type. - - - - - - This enables the override in other providers. Do not return big numbers, mainly when compring only on filename. - + + Returns a number representing how much this file fits this project type. + + + + + + This enables the override in other providers. Do not return big numbers, mainly when compring only on filename. + - - Analyses Microsoft Visual Studio .NET 2002 (Rainier) solution files. - + + Analyses Microsoft Visual Studio .NET 2002 (Rainier) solution files. + @@ -246,9 +246,9 @@ - - Private var containing custom properties. - + + Private var containing custom properties. + @@ -267,29 +267,29 @@ The macro cannot be expanded. - - Builds the list of folders that should be scanned for assembly - references. - - - The list of folders that should be scanned for assembly references. - + + Builds the list of folders that should be scanned for assembly + references. + + + The list of folders that should be scanned for assembly references. + - - The projects to build. - + + The projects to build. + - - The projects to scan, but not build. - - - These projects are used to resolve project references and are - generally external to the solution being built. References to - these project's output files are converted to use the appropriate - solution configuration at build time. - + + The projects to scan, but not build. + + + These projects are used to resolve project references and are + generally external to the solution being built. References to + these project's output files are converted to use the appropriate + solution configuration at build time. + @@ -303,52 +303,52 @@ - - The name of the solution configuration to build. - - - - Generally release or debug. Not case-sensitive. - - + + The name of the solution configuration to build. + + + + Generally release or debug. Not case-sensitive. + + - - The name of platform to build the solution for. - + + The name of platform to build the solution for. + - - Gets the solution configuration to build. - + + Gets the solution configuration to build. + - - The directory where compiled targets will be placed. This - overrides path settings contained in the solution/project. - + + The directory where compiled targets will be placed. This + overrides path settings contained in the solution/project. + - - WebMap of URL's to project references. - + + WebMap of URL's to project references. + - - Fileset of projects to exclude. - + + Fileset of projects to exclude. + - - Set of folders where references are searched when not found in path - from project file (HintPath). - + + Set of folders where references are searched when not found in path + from project file (HintPath). + - - Includes Visual Studio search folders in reference search path. - The default is . - + + Includes Visual Studio search folders in reference search path. + The default is . + @@ -362,163 +362,163 @@ - - Set of properties set at solution level. Builders for projects in solution may or may not use them. - - - - TODO: some documentataion which properties could be defined here. - - + + Set of properties set at solution level. Builders for projects in solution may or may not use them. + + + + TODO: some documentataion which properties could be defined here. + + - - Gets the list of folders to scan for assembly references. - - - The list of folders to scan for assembly references. - + + Gets the list of folders to scan for assembly references. + + + The list of folders to scan for assembly references. + - - Defines how the project is using the ATL library. - + + Defines how the project is using the ATL library. + - - Don't use ATL. - + + Don't use ATL. + - - Use ATL in a Static Library. - + + Use ATL in a Static Library. + - - Use ATL in a Shared DLL. - + + Use ATL in a Shared DLL. + - - Defines how the project is using the MFC library. - + + Defines how the project is using the MFC library. + - - Don't use MFC. - + + Don't use MFC. + - - Use MFC in a Static Library. - + + Use MFC in a Static Library. + - - Use MFC in a Shared DLL. - + + Use MFC in a Shared DLL. + - - Indicates the possible ways in which precompiled header file use is - specified in a Visual C++ project. - - - The integer values assigned match those specified in the Visual C++ - project file for each setting. - > + + Indicates the possible ways in which precompiled header file use is + specified in a Visual C++ project. + + + The integer values assigned match those specified in the Visual C++ + project file for each setting. + > - - Precompiled header file use not specified. - + + Precompiled header file use not specified. + - - Don't use a precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yc. - + + Don't use a precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yc. + - - Create precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yc. - + + Create precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yc. + - - Automatically create precompiled header file if necessary. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yc. - + + Automatically create precompiled header file if necessary. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yc. + - - Use a precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yu. - + + Use a precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yu. + - - Represents a single mapping from URL project path to physical project - path. - + + Represents a single mapping from URL project path to physical project + path. + - - Specifies the URL of the project file, or a URL fragment to match. - - - The URL of the project file or the URL fragment to match. - + + Specifies the URL of the project file, or a URL fragment to match. + + + The URL of the project file or the URL fragment to match. + - - Specifies the actual path to the project file, or the path fragment - to replace. - - - The actual path to the project file or the path fragment to replace - the URL fragment with. - + + Specifies the actual path to the project file, or the path fragment + to replace. + + + The actual path to the project file or the path fragment to replace + the URL fragment with. + - - Specifies whether the mapping is case-sensitive or not. - - - A boolean flag representing the case-sensitivity of the mapping. Default is . - + + Specifies whether the mapping is case-sensitive or not. + + + A boolean flag representing the case-sensitivity of the mapping. Default is . + - - Indicates if the URL of the project file should be mapped. - - - if the URL of the project file should be - mapped; otherwise, . - + + Indicates if the URL of the project file should be mapped. + + + if the URL of the project file should be + mapped; otherwise, . + - - Indicates if the URL of the project file should not be mapped. - - - if the URL of the project file should not - be mapped; otherwise, . - + + Indicates if the URL of the project file should not be mapped. + + + if the URL of the project file should not + be mapped; otherwise, . + @@ -591,11 +591,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -628,10 +628,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -652,38 +652,38 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Gets the output path of the reference, without taking the "copy local" - setting into consideration. - - The solution configuration that is built. - - The full output path of the reference. - + + Gets the output path of the reference, without taking the "copy local" + setting into consideration. + + The solution configuration that is built. + + The full output path of the reference. + @@ -699,35 +699,35 @@ - - Gets the complete set of assemblies that need to be referenced when - a project references this component. - - The solution configuration that is built. - - The complete set of assemblies that need to be referenced when a - project references this component. - + + Gets the complete set of assemblies that need to be referenced when + a project references this component. + + The solution configuration that is built. + + The complete set of assemblies that need to be referenced when a + project references this component. + - - Gets the timestamp of the reference. - - The solution configuration that is built. - - The timestamp of the reference. - + + Gets the timestamp of the reference. + + The solution configuration that is built. + + The timestamp of the reference. + - - Gets a value indicating whether the reference is managed for the - specified configuration. - - The solution configuration that is built. - - if the reference is managed for the - specified configuration; otherwise, . - + + Gets a value indicating whether the reference is managed for the + specified configuration. + + The solution configuration that is built. + + if the reference is managed for the + specified configuration; otherwise, . + @@ -742,14 +742,14 @@ - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the underlying task. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the underlying task. + @@ -763,39 +763,39 @@ - - Gets a value indicating whether the output file(s) of this reference - should be copied locally. - - - if the output file(s) of this reference - should be copied locally; otherwise, . - + + Gets a value indicating whether the output file(s) of this reference + should be copied locally. + + + if the output file(s) of this reference + should be copied locally; otherwise, . + - - Gets a value indicating whether this reference represents a system - assembly. - - - if this reference represents a system - assembly; otherwise, . - + + Gets a value indicating whether this reference represents a system + assembly. + + + if this reference represents a system + assembly; otherwise, . + - - Gets the project in which the reference is defined. - + + Gets the project in which the reference is defined. + - - Gets a value indicating whether the reference is managed for the - specified configuration. - - The build configuration of the reference. - - . - + + Gets a value indicating whether the reference is managed for the + specified configuration. + + The build configuration of the reference. + + . + @@ -811,14 +811,14 @@ - - Gets the path of the reference, without taking the "copy local" - setting into consideration. - - The solution configuration that is built. - - The output path of the reference. - + + Gets the path of the reference, without taking the "copy local" + setting into consideration. + + The solution configuration that is built. + + The output path of the reference. + @@ -833,55 +833,55 @@ - - Gets the complete set of assemblies that need to be referenced when - a project references this component. - - The solution configuration that is built. - - The complete set of assemblies that need to be referenced when a - project references this component. - + + Gets the complete set of assemblies that need to be referenced when + a project references this component. + + The solution configuration that is built. + + The complete set of assemblies that need to be referenced when a + project references this component. + - - Gets the timestamp of the reference. - - The solution configuration that is built. - - The timestamp of the reference. - + + Gets the timestamp of the reference. + + The solution configuration that is built. + + The timestamp of the reference. + - - Resolves an assembly reference. - - - The full path to the resolved assembly, or - if the assembly reference could not be resolved. - + + Resolves an assembly reference. + + + The full path to the resolved assembly, or + if the assembly reference could not be resolved. + - - Searches for the given file in all paths in . - - The folders to search. - The file to search for. - - The path of the assembly if was found - in ; otherwise, . - + + Searches for the given file in all paths in . + + The folders to search. + The file to search for. + + The path of the assembly if was found + in ; otherwise, . + - - Resolves an assembly reference in the framework assembly directory - of the target framework. - - The file to search for. - - The full path of the assembly file if the assembly could be located - in the framework assembly directory; otherwise, . - + + Resolves an assembly reference in the framework assembly directory + of the target framework. + + The file to search for. + + The full path of the assembly file if the assembly could be located + in the framework assembly directory; otherwise, . + @@ -895,24 +895,24 @@ - - Gets a value indicating whether the output file(s) of this reference - should be copied locally. - - - if the output file(s) of this reference - should be copied locally; otherwise, . - + + Gets a value indicating whether the output file(s) of this reference + should be copied locally. + + + if the output file(s) of this reference + should be copied locally; otherwise, . + - - Gets a value indicating whether this reference represents a system - assembly. - - - if this reference represents a system - assembly; otherwise, . - + + Gets a value indicating whether this reference represents a system + assembly. + + + if this reference represents a system + assembly; otherwise, . + @@ -951,14 +951,14 @@ - - Gets the project. - + + Gets the project. + - - Gets the name of the configuration. - + + Gets the name of the configuration. + @@ -978,34 +978,34 @@ - - Gets the output directory. - + + Gets the output directory. + - - Gets the path for the output file. - + + Gets the path for the output file. + - - Gets the path in which the output file will be created before its - copied to the actual output path. - + + Gets the path in which the output file will be created before its + copied to the actual output path. + - - Get the path of the output directory relative to the project - directory. - + + Get the path of the output directory relative to the project + directory. + - - Gets the platform that the configuration targets. - - - The platform targeted by the configuration. - + + Gets the platform that the configuration targets. + + + The platform targeted by the configuration. + @@ -1040,33 +1040,33 @@ The appropriate number of entries that the can initially contain. - - Gets the platform that the configuration targets. - - - The platform targeted by the configuration. - + + Gets the platform that the configuration targets. + + + The platform targeted by the configuration. + - - Gets the path in which the output file will be created before its - copied to the actual output path. - + + Gets the path in which the output file will be created before its + copied to the actual output path. + - - Gets a value indicating whether to register the project output for - use with COM components. - - - if the project output should be registered - for use with COM components; otherwise, . - + + Gets a value indicating whether to register the project output for + use with COM components. + + + if the project output should be registered + for use with COM components; otherwise, . + - - Base class for all project classes. - + + Base class for all project classes. + @@ -1093,25 +1093,25 @@ - - Gets a value indicating whether building the project for the specified - build configuration results in managed output. - - The build configuration. - - if the project output for the given build - configuration is managed; otherwise, . - + + Gets a value indicating whether building the project for the specified + build configuration results in managed output. + + The build configuration. + + if the project output for the given build + configuration is managed; otherwise, . + - - Expands the given macro. - - The macro to expand. - - The expanded macro or if the macro is not - supported. - + + Expands the given macro. + + The macro to expand. + + The expanded macro or if the macro is not + supported. + @@ -1142,33 +1142,33 @@ - - Prepares the project for being built. - - The solution configuration that is built. - - The default implementation will ensure that none of the output files - are marked read-only. - - - - Copies the specified file if the destination file does not exist, or - the source file has been modified since it was previously copied. + Prepares the project for being built. + + The solution configuration that is built. + + The default implementation will ensure that none of the output files + are marked read-only. + + + + + Copies the specified file if the destination file does not exist, or + the source file has been modified since it was previously copied. The file to copy. The destination file. The in which context the operation will be performed. - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the underlying task. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the underlying task. + @@ -1182,77 +1182,77 @@ - - Gets the Visual Studio product version of the project. - - - The Visual Studio product version of the project. - + + Gets the Visual Studio product version of the project. + + + The Visual Studio product version of the project. + - - Gets the name of the VS.NET project. - + + Gets the name of the VS.NET project. + - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the path of the VS.NET project. - + + Gets the path of the VS.NET project. + - - Gets the directory containing the VS.NET project. - + + Gets the directory containing the VS.NET project. + - - Get the location of the project. - + + Get the location of the project. + - - Get the directory in which intermediate build output that is not - specific to the build configuration will be stored. - - - - For projects, this is defined - as <Project Directory<\obj. - - - For projects, this is defined - as %HOMEPATH%\VSWebCache\<Machine Name>\<Project Directory>\obj. - - + + Get the directory in which intermediate build output that is not + specific to the build configuration will be stored. + + + + For projects, this is defined + as <Project Directory<\obj. + + + For projects, this is defined + as %HOMEPATH%\VSWebCache\<Machine Name>\<Project Directory>\obj. + + - - Gets or sets the unique identifier of the VS.NET project. - + + Gets or sets the unique identifier of the VS.NET project. + - - Gets a list of all configurations defined in the project. - + + Gets a list of all configurations defined in the project. + - - Gets a list of project configurations that can be build. - - - - Project configurations that are not in this list do not need to be - compiled. - - + + Gets a list of project configurations that can be build. + + + + Project configurations that are not in this list do not need to be + compiled. + + @@ -1268,37 +1268,37 @@ - - Gets the set of projects that the project depends on. - - - The set of projects that the project depends on. - + + Gets the set of projects that the project depends on. + + + The set of projects that the project depends on. + - - TODO: refactor this !!! - + + TODO: refactor this !!! + - - Gets a value indicating whether building the project for the specified - build configuration results in managed output. - - The solution configuration that is built. - - . - + + Gets a value indicating whether building the project for the specified + build configuration results in managed output. + + The solution configuration that is built. + + . + - - Prepares the project for being built. - - The solution configuration that is built. - - Ensures the configuration-level object directory exists and ensures - that none of the output files are marked read-only. - + + Prepares the project for being built. + + The solution configuration that is built. + + Ensures the configuration-level object directory exists and ensures + that none of the output files are marked read-only. + @@ -1346,37 +1346,37 @@ - - Gets the absolute path of the type library for the project - output. - - The configuration to build. - - The absolute path of the type library for the project output. - + + Gets the absolute path of the type library for the project + output. + + The configuration to build. + + The absolute path of the type library for the project output. + - - Generates a type library for the specified assembly, registers it. - - The project configuration that is built. - The solution configuration that is built. - The path of the type library to generate. - - The regasm tool is used to generate the type library. - + + Generates a type library for the specified assembly, registers it. + + The project configuration that is built. + The solution configuration that is built. + The path of the type library to generate. + + The regasm tool is used to generate the type library. + - - Unregister a type library for the specified assembly, and the types - in that assembly. - - The project configuration that is built. - The solution configuration that is built. - - The regasm tool is used to unregister the type library, and - remove the COM registration for types in the specified assembly. - + + Unregister a type library for the specified assembly, and the types + in that assembly. + + The project configuration that is built. + The solution configuration that is built. + + The regasm tool is used to unregister the type library, and + remove the COM registration for types in the specified assembly. + @@ -1441,52 +1441,52 @@ - - Gets the default file extension of sources for this project. - - - The default file extension of sources for this project. - + + Gets the default file extension of sources for this project. + + + The default file extension of sources for this project. + - - Gets a value indicating if this is a web project. - - - if this is a web project; otherwise, - . - - - If the url of a web project has been mapped to a local path - (using the <webmap> element), then this property will return - for a - project. - + + Gets a value indicating if this is a web project. + + + if this is a web project; otherwise, + . + + + If the url of a web project has been mapped to a local path + (using the <webmap> element), then this property will return + for a + project. + - - Gets the name of the VS.NET project. - + + Gets the name of the VS.NET project. + - - Gets the path of the VS.NET project. - + + Gets the path of the VS.NET project. + - - Gets the directory containing the VS.NET project. - + + Gets the directory containing the VS.NET project. + - - Get the location of the project. - + + Get the location of the project. + - - Gets or sets the unique identifier of the VS.NET project. - + + Gets or sets the unique identifier of the VS.NET project. + @@ -1502,15 +1502,15 @@ A . - - Gets the intermediate build directory in which the satellite - assembly is built. - - The project build configuration. - - The intermediate build directory in which the satellite assembly - is built. - + + Gets the intermediate build directory in which the satellite + assembly is built. + + The project build configuration. + + The intermediate build directory in which the satellite assembly + is built. + @@ -1525,15 +1525,15 @@ - - Gets path of the satellite assembly, relative to the output - directory. - - The project settings. - - The path of the satellite assembly, relative to the output - directory. - + + Gets path of the satellite assembly, relative to the output + directory. + + The project settings. + + The path of the satellite assembly, relative to the output + directory. + @@ -1542,9 +1542,9 @@ - - Gets the set of localized resources. - + + Gets the set of localized resources. + @@ -1630,25 +1630,25 @@ - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the default file extension of sources for this project. - - - For C# projects, the default file extension is ".cs". - + + Gets the default file extension of sources for this project. + + + For C# projects, the default file extension is ".cs". + - - Supports grouping of individual projects, and treating them as a solution. - + + Supports grouping of individual projects, and treating them as a solution. + @@ -1679,14 +1679,14 @@ - - Prepares the project for being built. - - The solution configuration that is built. - - Ensures the configuration-level object directory exists and ensures - that none of the output files are marked read-only. - + + Prepares the project for being built. + + The solution configuration that is built. + + Ensures the configuration-level object directory exists and ensures + that none of the output files are marked read-only. + @@ -1744,112 +1744,112 @@ - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the default file extension of sources for this project. - - - For J# projects, the default file extension is ".jsl". - + + Gets the default file extension of sources for this project. + + + For J# projects, the default file extension is ".jsl". + - - Resolves an assembly reference. - - - The full path to the resolved assembly, or - if the assembly reference could not be resolved. - - - - Visual Studio .NET uses the following search mechanism : - - - - - The project directory. - - - - - The directories specified in the "ReferencePath" property, - which is stored in the .USER file. - - - - - The .NET Framework directory (see KB306149) - - - - - - The directories specified under the following registry - keys: - - - - - HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders - - - - - HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders - - - - - HKLM\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders - - - - - HKCU\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders - - - - - Future versions of Visual Studio .NET will also check - in: - - - - - HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx - - - - - HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx - - - - - - - - The HintPath. - - - - + + Resolves an assembly reference. + + + The full path to the resolved assembly, or + if the assembly reference could not be resolved. + + + + Visual Studio .NET uses the following search mechanism : + + + + + The project directory. + + + + + The directories specified in the "ReferencePath" property, + which is stored in the .USER file. + + + + + The .NET Framework directory (see KB306149) + + + + + + The directories specified under the following registry + keys: + + + + + HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders + + + + + HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders + + + + + HKLM\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders + + + + + HKCU\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders + + + + + Future versions of Visual Studio .NET will also check + in: + + + + + HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx + + + + + HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx + + + + + + + + The HintPath. + + + + - - Gets the name of the referenced assembly. - - - The name of the referenced assembly, or if - the name could not be determined. - + + Gets the name of the referenced assembly. + + + The name of the referenced assembly, or if + the name could not be determined. + @@ -1868,37 +1868,37 @@ - - Indentifies the different output types of a managed project. - - - Visual Studio .NET does not support modules. - + + Indentifies the different output types of a managed project. + + + Visual Studio .NET does not support modules. + - - A class library. - + + A class library. + - - A console application. - + + A console application. + - - A Windows program. - + + A Windows program. + - - Gets the output path of the reference, without taking the "copy local" - setting into consideration. - - The solution configuration that is built. - - The output path of the reference. - + + Gets the output path of the reference, without taking the "copy local" + setting into consideration. + + The solution configuration that is built. + + The output path of the reference. + @@ -1916,86 +1916,86 @@ - - Gets the complete set of assemblies that need to be referenced when - a project references this project. - - The solution configuration that is built. - - The complete set of assemblies that need to be referenced when a - project references this project. - - - - Apparently, there's some hack in VB.NET that allows a type to be used - that derives from a type in an assembly that is not referenced by the - project. - - - When building from the command line (using vbc), the following error - is reported "error BC30007: Reference required to assembly 'X' - containing the base class 'X'. Add one to your project". - - - Somehow VB.NET can workaround this issue, without actually adding a - reference to that assembly. I verified this with both VS.NET 2003 and - VS.NET 2005. - - - For now, we have no other option than to return all assembly - references of the referenced project if the parent is a VB.NET - project. - - + + Gets the complete set of assemblies that need to be referenced when + a project references this project. + + The solution configuration that is built. + + The complete set of assemblies that need to be referenced when a + project references this project. + + + + Apparently, there's some hack in VB.NET that allows a type to be used + that derives from a type in an assembly that is not referenced by the + project. + + + When building from the command line (using vbc), the following error + is reported "error BC30007: Reference required to assembly 'X' + containing the base class 'X'. Add one to your project". + + + Somehow VB.NET can workaround this issue, without actually adding a + reference to that assembly. I verified this with both VS.NET 2003 and + VS.NET 2005. + + + For now, we have no other option than to return all assembly + references of the referenced project if the parent is a VB.NET + project. + + - - Gets the timestamp of the reference. - - The solution configuration that is built. - - The timestamp of the reference. - + + Gets the timestamp of the reference. + + The solution configuration that is built. + + The timestamp of the reference. + - - Gets a value indicating whether the output file(s) of this reference - should be copied locally. - - - if the output file(s) of this reference - should be copied locally; otherwise, . - + + Gets a value indicating whether the output file(s) of this reference + should be copied locally. + + + if the output file(s) of this reference + should be copied locally; otherwise, . + - - Gets a value indicating whether this reference represents a system - assembly. - - - as a project by itself can never be a - system assembly. - + + Gets a value indicating whether this reference represents a system + assembly. + + + as a project by itself can never be a + system assembly. + - - Gets a value indicating whether the reference is managed for the - specified configuration. - - The solution configuration that is built. - - . - + + Gets a value indicating whether the reference is managed for the + specified configuration. + + The solution configuration that is built. + + . + - - Gets the path of the reference, without taking the "copy local" - setting into consideration. - - The solution configuration that is built. - - The output path of the reference. - + + Gets the path of the reference, without taking the "copy local" + setting into consideration. + + The solution configuration that is built. + + The output path of the reference. + @@ -2010,52 +2010,52 @@ - - Gets the complete set of assemblies that need to be referenced when - a project references this component. - - The solution configuration that is built. - - The complete set of assemblies that need to be referenced when a - project references this component. - + + Gets the complete set of assemblies that need to be referenced when + a project references this component. + + The solution configuration that is built. + + The complete set of assemblies that need to be referenced when a + project references this component. + - - Gets the timestamp of the reference. - - The solution configuration that is built. - - The timestamp of the reference. - + + Gets the timestamp of the reference. + + The solution configuration that is built. + + The timestamp of the reference. + - - Removes wrapper assembly from build directory, if wrapper assembly - no longer exists in output directory or is not in sync with build - directory, to force rebuild. - - The project configuration. + + Removes wrapper assembly from build directory, if wrapper assembly + no longer exists in output directory or is not in sync with build + directory, to force rebuild. + + The project configuration. - - Gets a value indicating whether the output file(s) of this reference - should be copied locally. - - - if the reference wraps a Primary Interop - Assembly; otherwise, . - + + Gets a value indicating whether the output file(s) of this reference + should be copied locally. + + + if the reference wraps a Primary Interop + Assembly; otherwise, . + - - Gets a value indicating whether this reference represents a system - assembly. - - - as none of the system assemblies are wrappers - or Primary Interop Assemblies anyway. - + + Gets a value indicating whether this reference represents a system + assembly. + + + as none of the system assemblies are wrappers + or Primary Interop Assemblies anyway. + @@ -2068,74 +2068,74 @@ - - Gets the path of the wrapper assembly. - - - The path of the wrapper assembly. - - - The wrapper assembly is stored in the object directory of the - project. - + + Gets the path of the wrapper assembly. + + + The path of the wrapper assembly. + + + The wrapper assembly is stored in the object directory of the + project. + - - Gets a value indicating whether the wrapper assembly has already been - created. - + + Gets a value indicating whether the wrapper assembly has already been + created. + - - Gets the path of the Primary Interop Assembly. - - - The path of the Primary Interop Assembly, or - if not available. - + + Gets the path of the Primary Interop Assembly. + + + The path of the Primary Interop Assembly, or + if not available. + - - Gets the hex version of the type library as defined in the definition - of the reference. - - - The hex version of the type library. - + + Gets the hex version of the type library as defined in the definition + of the reference. + + + The hex version of the type library. + - - Gets the GUID of the type library as defined in the definition - of the reference. - - - The GUID of the type library. - + + Gets the GUID of the type library as defined in the definition + of the reference. + + + The GUID of the type library. + - - Gets the locale of the type library in hex notation. - - - The locale of the type library. - + + Gets the locale of the type library in hex notation. + + + The locale of the type library. + - - Gets the name of the type library. - - - The name of the type library. - + + Gets the name of the type library. + + + The name of the type library. + - - Gets the name of the referenced assembly. - - - The name of the referenced assembly, or if - the name could not be determined. - + + Gets the name of the referenced assembly. + + + The name of the referenced assembly, or if + the name could not be determined. + @@ -2148,25 +2148,25 @@ - - Gets the path of the wrapper assembly. - - - The path of the wrapper assembly. - - - The wrapper assembly is stored in the object directory of the - project. - + + Gets the path of the wrapper assembly. + + + The path of the wrapper assembly. + + + The wrapper assembly is stored in the object directory of the + project. + - - Gets the path of the Primary Interop Assembly. - - - The path of the Primary Interop Assembly, or - if not available. - + + Gets the path of the Primary Interop Assembly. + + + The path of the Primary Interop Assembly, or + if not available. + @@ -2187,111 +2187,111 @@ - - Gets the GUID of the type library as defined in the definition - of the reference. - - - The GUID of the type library. - + + Gets the GUID of the type library as defined in the definition + of the reference. + + + The GUID of the type library. + - - Gets the locale of the type library in hex notation. - - - The locale of the type library. - + + Gets the locale of the type library in hex notation. + + + The locale of the type library. + - - Specifies the type of the project. - + + Specifies the type of the project. + - - A Visual Basic.NET project. - + + A Visual Basic.NET project. + - - A Visual C# project. - + + A Visual C# project. + - - A Visual C++ project. - + + A Visual C++ project. + - - A Visual J# project. - + + A Visual J# project. + - - MSBuild project. - + + MSBuild project. + - - Specifies the result of the build. - + + Specifies the result of the build. + - - The build failed. - + + The build failed. + - - The build succeeded. - + + The build succeeded. + - - The build succeeded and the output was updated. - + + The build succeeded and the output was updated. + - - Visual Studio.NET 2002 - + + Visual Studio.NET 2002 + - - Visual Studio.NET 2003 - + + Visual Studio.NET 2003 + - - Visual Studio 2005 - + + Visual Studio 2005 + - - Visual Studio 2008 - + + Visual Studio 2008 + - - Visual Studio 2010 - + + Visual Studio 2010 + - - Indentifies the physical location of a managed project. - + + Indentifies the physical location of a managed project. + - - A local project. - + + A local project. + - - A web project. - + + A web project. + @@ -2357,11 +2357,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -2394,16 +2394,16 @@ The to remove from the collection. - - Remove items with the specified guid from the collection. - - The guid of the project to remove from the collection. + + Remove items with the specified guid from the collection. + + The guid of the project to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -2427,56 +2427,56 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Gets or sets the in memory representation of the project. - - - The in memory representation of the project, or - if the project is not (yet) loaded. - - - This property will always be for - projects that are not supported. - + + Gets or sets the in memory representation of the project. + + + The in memory representation of the project, or + if the project is not (yet) loaded. + + + This property will always be for + projects that are not supported. + - - Return a mapping between the configurations defined in the - solution file and the project build configurations. - - - Mapping between configurations defined in the solution file - and the project build configurations, or - if the project is not defined in a solution file. - - - This mapping only includes project build configurations that - are configured to be built for a given solution configuration. - + + Return a mapping between the configurations defined in the + solution file and the project build configurations. + + + Mapping between configurations defined in the solution file + and the project build configurations, or + if the project is not defined in a solution file. + + + This mapping only includes project build configurations that + are configured to be built for a given solution configuration. + @@ -2544,11 +2544,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -2581,10 +2581,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -2608,33 +2608,33 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Factory class for VS.NET projects. - + + Factory class for VS.NET projects. + @@ -2703,38 +2703,38 @@ - - Gets the .ico file to use as application icon. - - - The .ico file to use as application icon, or - if no application icon should be used. - + + Gets the .ico file to use as application icon. + + + The .ico file to use as application icon, or + if no application icon should be used. + - - Gets the key file to use to sign ActiveX/COM wrappers. - - - The path of the key file to use to sign ActiveX/COM wrappers, - relative to the project root directory, or - if the wrapper assembly should not be signed using a key file. - + + Gets the key file to use to sign ActiveX/COM wrappers. + + + The path of the key file to use to sign ActiveX/COM wrappers, + relative to the project root directory, or + if the wrapper assembly should not be signed using a key file. + - - Gets the key name to use to sign ActiveX/COM wrappers. - - - The name of the key container to use to sign ActiveX/COM wrappers, - or if the wrapper assembly should not be - signed using a key container. - + + Gets the key name to use to sign ActiveX/COM wrappers. + + + The name of the key container to use to sign ActiveX/COM wrappers, + or if the wrapper assembly should not be + signed using a key container. + - - Gets the output type of this project. - + + Gets the output type of this project. + @@ -2744,20 +2744,20 @@ - - Contains commands to be run before a build takes place. - - - Valid commands are those in a .bat file. For more info see MSDN. - + + Contains commands to be run before a build takes place. + + + Valid commands are those in a .bat file. For more info see MSDN. + - - Contains commands to be ran after a build has taken place. - - - Valid commands are those in a .bat file. For more info see MSDN. - + + Contains commands to be ran after a build has taken place. + + + Valid commands are those in a .bat file. For more info see MSDN. + @@ -2772,13 +2772,13 @@ - - Gets the file name of the assembly with the given assembly name. - - The assembly name of the assembly of which the file name should be returned. - - The file name of the assembly with the given assembly name. - + + Gets the file name of the assembly with the given assembly name. + + The assembly name of the assembly of which the file name should be returned. + + The file name of the assembly with the given assembly name. + @@ -2819,18 +2819,18 @@ - - Gets a value indicating whether the resource is in fact a ResX file. - - - if the resource is a ResX file; otherwise, - . - + + Gets a value indicating whether the resource is in fact a ResX file. + + + if the resource is a ResX file; otherwise, + . + - - Factory class for VS.NET solutions. - + + Factory class for VS.NET solutions. + @@ -2927,25 +2927,25 @@ - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the default file extension of sources for this project. - - - For VB projects, the default file extension is ".vb". - + + Gets the default file extension of sources for this project. + + + For VB projects, the default file extension is ".vb". + - - A mapping from properties in the .vcproj file to command line arguments. - + + A mapping from properties in the .vcproj file to command line arguments. + @@ -2954,19 +2954,19 @@ - - Gets the argument string corresponding with a configuration property - named with value . - An ignore mask can be used to eliminate some arguments from the search. - - The name of the configuration property. - The value of the configuration property. - Specify any groups that needs to be ignored. - - The argument string corresponding with a configuration property - named with value , - or if no corresponding argument exists. - + + Gets the argument string corresponding with a configuration property + named with value . + An ignore mask can be used to eliminate some arguments from the search. + + The name of the configuration property. + The value of the configuration property. + Specify any groups that needs to be ignored. + + The argument string corresponding with a configuration property + named with value , + or if no corresponding argument exists. + @@ -3164,55 +3164,55 @@ - - Gets the name of the command-line argument. - - - The name of the command-line argument. - + + Gets the name of the command-line argument. + + + The name of the command-line argument. + - - Represents a command-line arguments of which the trailing backslashes - in the value should be duplicated. - + + Represents a command-line arguments of which the trailing backslashes + in the value should be duplicated. + - - Represents a command-line argument of which the value should be - quoted, and of which trailing backslahes should be duplicated. - + + Represents a command-line argument of which the value should be + quoted, and of which trailing backslahes should be duplicated. + - - Gets the string that the configuration setting should match in - order for the command line argument to be set. - + + Gets the string that the configuration setting should match in + order for the command line argument to be set. + - - Allow us to assign an argument to a specific group. - + + Allow us to assign an argument to a specific group. + - - The argument is not assigned to any group. - + + The argument is not assigned to any group. + - - The argument is ignored when the optimization level is set to - Minimum Size (1) or Maximum Size (2). - + + The argument is ignored when the optimization level is set to + Minimum Size (1) or Maximum Size (2). + - - Resolves an assembly reference. - - - The full path to the resolved assembly, or - if the assembly reference could not be resolved. - + + Resolves an assembly reference. + + + The full path to the resolved assembly, or + if the assembly reference could not be resolved. + @@ -3227,19 +3227,19 @@ Expansion of a given macro is not yet implemented. - - Gets the name of the referenced assembly. - - - The name of the referenced assembly, or if - the name could not be determined. - + + Gets the name of the referenced assembly. + + + The name of the referenced assembly, or if + the name could not be determined. + - - A single build configuration for a Visual C++ project or for a specific - file in the project. - + + A single build configuration for a Visual C++ project or for a specific + file in the project. + @@ -3290,69 +3290,69 @@ - - Gets the intermediate directory, specified relative to project - directory. - - - The intermediate directory, specified relative to project directory. - + + Gets the intermediate directory, specified relative to project + directory. + + + The intermediate directory, specified relative to project directory. + - - Gets a comma-separated list of directories to scan for assembly - references. - - - A comma-separated list of directories to scan for assembly - references, or if no additional directories - should scanned. - + + Gets a comma-separated list of directories to scan for assembly + references. + + + A comma-separated list of directories to scan for assembly + references, or if no additional directories + should scanned. + - - Gets the name of the configuration, including the platform it - targets. - - - Tthe name of the configuration, including the platform it targets. - + + Gets the name of the configuration, including the platform it + targets. + + + Tthe name of the configuration, including the platform it targets. + - - Gets the output directory. - + + Gets the output directory. + - - Gets the path in which the output file will be created before its - copied to the actual output path. - - - For Visual C++ projects, the output file will be immediately - created in the output path. - + + Gets the path in which the output file will be created before its + copied to the actual output path. + + + For Visual C++ projects, the output file will be immediately + created in the output path. + - - Gets the name of the configuration. - - - The name of the configuration. - + + Gets the name of the configuration. + + + The name of the configuration. + - - Gets the platform that the configuration targets. - - - The platform targeted by the configuration. - + + Gets the platform that the configuration targets. + + + The platform targeted by the configuration. + - - Represents the configuration of a file. - + + Represents the configuration of a file. + @@ -3394,75 +3394,75 @@ - - Gets a value indication whether the file should be excluded from - the build for this configuration. - - - if the file should be excluded from the - build for this configuration; otherwise, . - + + Gets a value indication whether the file should be excluded from + the build for this configuration. + + + if the file should be excluded from the + build for this configuration; otherwise, . + - - Gets the relative path of the file. - - - The path of the file relative to the project directory. - + + Gets the relative path of the file. + + + The path of the file relative to the project directory. + - - Get the path of the output directory relative to the project - directory. - + + Get the path of the output directory relative to the project + directory. + - - Gets the intermediate directory, specified relative to project - directory. - - - The intermediate directory, specified relative to project directory. - + + Gets the intermediate directory, specified relative to project + directory. + + + The intermediate directory, specified relative to project directory. + - - Gets the path for the output file. - - - The path for the output file, or if there's - no output file for this configuration. - + + Gets the path for the output file. + + + The path for the output file, or if there's + no output file for this configuration. + - - Gets a comma-separated list of directories to scan for assembly - references. - - - A comma-separated list of directories to scan for assembly - references, or if no additional directories - should scanned. - + + Gets a comma-separated list of directories to scan for assembly + references. + + + A comma-separated list of directories to scan for assembly + references, or if no additional directories + should scanned. + - - Visual C++ project. - + + Visual C++ project. + - - Gets a value indicating whether building the project for the specified - build configuration results in managed output. - - The solution configuration that is built. - - if the project output for the specified build - configuration is either a Dynamic Library (dll) or an Application - (exe), and Managed Extensions are enabled; otherwise, - . - + + Gets a value indicating whether building the project for the specified + build configuration results in managed output. + + The solution configuration that is built. + + if the project output for the specified build + configuration is either a Dynamic Library (dll) or an Application + (exe), and Managed Extensions are enabled; otherwise, + . + @@ -3493,65 +3493,65 @@ - - Expands the given macro. - - The macro to expand. - - The expanded macro or if the macro is not - supported. - + + Expands the given macro. + + The macro to expand. + + The expanded macro or if the macro is not + supported. + - - Build resource files for the given configuration. - - The resource files to build. - The project configuration. - The build configuration. - - TODO: refactor this as we should always get only one element in the - list. Each res file should be built - with its own file configuration. - + + Build resource files for the given configuration. + + The resource files to build. + The project configuration. + The build configuration. + + TODO: refactor this as we should always get only one element in the + list. Each res file should be built + with its own file configuration. + - - Build Interface Definition Language files for the given - configuration. - - The IDL files to build. - The project configuration. - The build configuration. - - TODO: refactor this as we should always get only one element in the - list. Each IDL file should be built - with its own file configuration. - + + Build Interface Definition Language files for the given + configuration. + + The IDL files to build. + The project configuration. + The build configuration. + + TODO: refactor this as we should always get only one element in the + list. Each IDL file should be built + with its own file configuration. + - - Merges the specified tool setting of - with . - - - The merge is suppressed when the flag $(noinherit) is defined in - . - + + Merges the specified tool setting of + with . + + + The merge is suppressed when the flag $(noinherit) is defined in + . + - - Gets the absolute path to the object file or directory. - - The build configuration - - The absolute path to the object file or directory, or - - - We use an absolute path for the object file, otherwise - <cl> assumes a location relative to the output - directory - not the project directory. - + + Gets the absolute path to the object file or directory. + + The build configuration + + The absolute path to the object file or directory, or + + + We use an absolute path for the object file, otherwise + <cl> assumes a location relative to the output + directory - not the project directory. + @@ -3581,10 +3581,10 @@ - - Removes leading and trailing quotes from the specified path. - - The path to clean. + + Removes leading and trailing quotes from the specified path. + + The path to clean. @@ -3619,58 +3619,58 @@ - - Gets the name of the Visual C++ project. - + + Gets the name of the Visual C++ project. + - - Gets the type of the project. - - - The type of the project. - + + Gets the type of the project. + + + The type of the project. + - - Gets the path of the Visual C++ project. - + + Gets the path of the Visual C++ project. + - - Gets the directory containing the VS.NET project. - + + Gets the directory containing the VS.NET project. + - - Get the location of the project. - - - . - - - For now, we only support local Visual C++ projects. - + + Get the location of the project. + + + . + + + For now, we only support local Visual C++ projects. + - - Get the directory in which intermediate build output that is not - specific to the build configuration will be stored. - - - This is a directory relative to the project directory, - named temp\. - + + Get the directory in which intermediate build output that is not + specific to the build configuration will be stored. + + + This is a directory relative to the project directory, + named temp\. + - - Gets or sets the unique identifier of the Visual C++ project. - + + Gets or sets the unique identifier of the Visual C++ project. + - - Represents a Visual C++ project configuration. - + + Represents a Visual C++ project configuration. + @@ -3692,15 +3692,15 @@ - - Gets the value of the specified attribute from the specified node. - - The node of which the attribute value should be retrieved. - The attribute of which the value should be returned. - - The value of the attribute with the specified name or - if the attribute does not exist or has no value. - + + Gets the value of the specified attribute from the specified node. + + The node of which the attribute value should be retrieved. + The attribute of which the value should be returned. + + The value of the attribute with the specified name or + if the attribute does not exist or has no value. + @@ -3711,106 +3711,106 @@ - - Holds list of files to link in the order in which they are defined - in the project file. - + + Holds list of files to link in the order in which they are defined + in the project file. + - - Holds the C++ sources for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the C++ source files for that - build configuration. - + + Holds the C++ sources for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the C++ source files for that + build configuration. + - - Holds the resources for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the resources files for that - build configuration. - + + Holds the resources for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the resources files for that + build configuration. + - - Holds the IDL files for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the IDL files for that build - configuration. - + + Holds the IDL files for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the IDL files for that build + configuration. + - - Tells the compiler which character set to use. - + + Tells the compiler which character set to use. + - - Gets a value indicating whether Managed Extensions for C++ are - enabled. - + + Gets a value indicating whether Managed Extensions for C++ are + enabled. + - - Gets a value indicating how MFC is used by the configuration. - + + Gets a value indicating how MFC is used by the configuration. + - - Gets a value indicating how ATL is used by the configuration. - + + Gets a value indicating how ATL is used by the configuration. + - - Gets the list of files to link in the order in which they are - defined in the project file. - + + Gets the list of files to link in the order in which they are + defined in the project file. + - - Holds the C++ sources for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the C++ source files for that - build configuration. - + + Holds the C++ sources for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the C++ source files for that + build configuration. + - - Gets the resources for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the resources files for that - build configuration. - + + Gets the resources for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the resources files for that + build configuration. + - - Get the IDL files for each build configuration. - - - The key of the hashtable is a build configuration, and the - value is an ArrayList holding the IDL files for that build - configuration. - + + Get the IDL files for each build configuration. + + + The key of the hashtable is a build configuration, and the + value is an ArrayList holding the IDL files for that build + configuration. + - - Gets the target path for usage in macro expansion. - - - The target path, or a zero-length string if there's no output file - for this configuration. - + + Gets the target path for usage in macro expansion. + + + The target path, or a zero-length string if there's no output file + for this configuration. + @@ -3830,69 +3830,69 @@ - - Get the path of the output directory relative to the project - directory. - + + Get the path of the output directory relative to the project + directory. + - - Gets the intermediate directory, specified relative to project - directory. - - - The intermediate directory, specified relative to project directory. - + + Gets the intermediate directory, specified relative to project + directory. + + + The intermediate directory, specified relative to project directory. + - - Gets the absolute path for the output file. - - - The absolute path for the output file, or - if there's no output file for this configuration. - + + Gets the absolute path for the output file. + + + The absolute path for the output file, or + if there's no output file for this configuration. + - - Gets a comma-separated list of directories to scan for assembly - references. - - - A comma-separated list of directories to scan for assembly - references, or if no additional directories - should scanned. - + + Gets a comma-separated list of directories to scan for assembly + references. + + + A comma-separated list of directories to scan for assembly + references, or if no additional directories + should scanned. + - - The type of output for a given configuration. - + + The type of output for a given configuration. + - - A Makefile. - + + A Makefile. + - - Application (.exe). - + + Application (.exe). + - - Dynamic Library (.dll). - + + Dynamic Library (.dll). + - - Static Library (.lib). - + + Static Library (.lib). + - - Utility. - + + Utility. + @@ -3906,23 +3906,23 @@ - - Gets a value indicating whether the reference is managed for the - specified configuration. - - The build configuration of the reference. - - if the reference is managed for the - specified configuration; otherwise, . - + + Gets a value indicating whether the reference is managed for the + specified configuration. + + The build configuration of the reference. + + if the reference is managed for the + specified configuration; otherwise, . + - - Gets the name of the referenced assembly. - - - The name of the referenced assembly. - + + Gets the name of the referenced assembly. + + + The name of the referenced assembly. + @@ -3935,25 +3935,25 @@ - - Gets the path of the wrapper assembly. - - - The path of the wrapper assembly. - - - The wrapper assembly is stored in the object directory of the - project. - + + Gets the path of the wrapper assembly. + + + The path of the wrapper assembly. + + + The wrapper assembly is stored in the object directory of the + project. + - - Gets the path of the Primary Interop Assembly. - - - The path of the Primary Interop Assembly, or - if not available. - + + Gets the path of the Primary Interop Assembly. + + + The path of the Primary Interop Assembly, or + if not available. + @@ -3966,21 +3966,21 @@ The definition of the reference does not contain a "ControlVersion" attribute. - - Gets the GUID of the type library as defined in the definition - of the reference. - - - The GUID of the type library. - + + Gets the GUID of the type library as defined in the definition + of the reference. + + + The GUID of the type library. + - - Gets the locale of the type library in hex notation. - - - The locale of the type library. - + + Gets the locale of the type library in hex notation. + + + The locale of the type library. + diff --git a/example_scripts/Tools/nant/bin/NAnt.VisualCppTasks.xml b/example_scripts/Tools/nant/bin/NAnt.VisualCppTasks.xml index 876d46d..95a9075 100644 --- a/example_scripts/Tools/nant/bin/NAnt.VisualCppTasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.VisualCppTasks.xml @@ -5,24 +5,24 @@ - - Compiles C/C++ programs using cl.exe, Microsoft's C/C++ compiler. - - - This task is intended for version 13.00.9466 of cl.exe. - - - Compiles helloworld.cpp for the Common Language Runtime. - - - - - - - ]]> - - + + Compiles C/C++ programs using cl.exe, Microsoft's C/C++ compiler. + + + This task is intended for version 13.00.9466 of cl.exe. + + + Compiles helloworld.cpp for the Common Language Runtime. + + + + + + + ]]> + + @@ -30,77 +30,77 @@ - - Compiles the sources. - + + Compiles the sources. + - - Determines if the sources need to be compiled. - + + Determines if the sources need to be compiled. + - - Determines whether the precompiled header file is up-to-date. - - - if no precompiled header file was specified; - otherwise, . - - - In order to determine accurately whether the precompile header file - is up-to-date, we'd need scan all the header files that are pulled - in. As this is not implemented right now, its safer to always - recompile. - + + Determines whether the precompiled header file is up-to-date. + + + if no precompiled header file was specified; + otherwise, . + + + In order to determine accurately whether the precompile header file + is up-to-date, we'd need scan all the header files that are pulled + in. As this is not implemented right now, its safer to always + recompile. + - - Determines whether any file that are includes in the specified - source file has been updated after the obj was compiled. - - The source file to check. - The last write time of the compiled obj. - - The full path to the include file that was modified after the obj - was compiled, or if no include files were - modified since the obj was compiled. - - - - To determine what includes are defined in a source file, conditional - directives are not honored. - - - If a given include cannot be resolved to an existing file, then - it will be considered stable. - - + + Determines whether any file that are includes in the specified + source file has been updated after the obj was compiled. + + The source file to check. + The last write time of the compiled obj. + + The full path to the include file that was modified after the obj + was compiled, or if no include files were + modified since the obj was compiled. + + + + To determine what includes are defined in a source file, conditional + directives are not honored. + + + If a given include cannot be resolved to an existing file, then + it will be considered stable. + + - - Quotes an argument value and duplicates trailing backslahes. - - The argument value to quote. - - The quotes argument value. - + + Quotes an argument value and duplicates trailing backslahes. + + The argument value to quote. + + The quotes argument value. + - - Determines the file name of the OBJ file for the specified source - file. - - The source file for which the OBJ file should be determined. - The path of the object file. - - The file name of the OBJ file for the specified source file. - + + Determines the file name of the OBJ file for the specified source + file. + + The source file for which the OBJ file should be determined. + The path of the object file. + + The file name of the OBJ file for the specified source file. + - - Directory where all output files are placed. - + + Directory where all output files are placed. + @@ -123,244 +123,244 @@ - - Specifies whether Managed Extensions for C++ should be enabled. - The default is . - + + Specifies whether Managed Extensions for C++ should be enabled. + The default is . + - - Tells the compiler to use the specified character set. - + + Tells the compiler to use the specified character set. + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - The list of files to compile. - + + The list of files to compile. + - - The list of directories in which to search for include files. - + + The list of directories in which to search for include files. + - - Directories that the compiler will search to resolve file references - passed to the #using directive. - + + Directories that the compiler will search to resolve file references + passed to the #using directive. + - - Specifies metadata files to reference in this compilation as an - alternative to passing a file name to #using in source code. - + + Specifies metadata files to reference in this compilation as an + alternative to passing a file name to #using in source code. + - - Macro definitions to pass to cl.exe. - Each entry will generate a /D - + + Macro definitions to pass to cl.exe. + Each entry will generate a /D + - - Macro undefines (/U) to pass to cl.exe. - + + Macro undefines (/U) to pass to cl.exe. + - - A name to override the default object file name; can be either a file - or directory name. The default is the output directory. - + + A name to override the default object file name; can be either a file + or directory name. The default is the output directory. + - - A name for the compiler-generated PDB file; can be either a file or - directory name. The default is the output directory. - + + A name for the compiler-generated PDB file; can be either a file or + directory name. The default is the output directory. + - - Gets the filename of the external program to start. - - The filename of the external program. + + Gets the filename of the external program to start. + + The filename of the external program. - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Defines the supported modes for the use of precompiled header files. - + + Defines the supported modes for the use of precompiled header files. + - - Create a precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yc. - + + Create a precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yc. + - - Automatically create a precompiled header file if necessary. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /YX. - + + Automatically create a precompiled header file if necessary. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /YX. + - - Use a (previously generated) precompiled header file. - - - For further information on the use of this option - see the Microsoft documentation on the C++ compiler flag /Yu. - + + Use a (previously generated) precompiled header file. + + + For further information on the use of this option + see the Microsoft documentation on the C++ compiler flag /Yu. + - - Run lib.exe, Microsoft's Library Manager. - - - Create a library. - - - - - - - ]]> - - + + Run lib.exe, Microsoft's Library Manager. + + + Create a library. + + + + + + + ]]> + + - - Creates the library. - + + Creates the library. + - - Determines if the sources need to be linked. - + + Determines if the sources need to be linked. + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - The output file. - + + The output file. + - - The module definition file. - + + The module definition file. + - - The list of files to combine into the output file. - + + The list of files to combine into the output file. + - - Symbols to add to the symbol table. - + + Symbols to add to the symbol table. + - - Names of default libraries to ignore. - + + Names of default libraries to ignore. + - - The list of additional library directories to search. - + + The list of additional library directories to search. + - - Gets the filename of the external program to start. - - The filename of the external program. + + Gets the filename of the external program to start. + + The filename of the external program. - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Links files using link.exe, Microsoft's Incremental Linker. - - - This task is intended for version 7.00.9466 of link.exe. - - - - Combine all object files in the current directory into helloworld.exe. - - - - - - - - ]]> - - + + Links files using link.exe, Microsoft's Incremental Linker. + + + This task is intended for version 7.00.9466 of link.exe. + + + + Combine all object files in the current directory into helloworld.exe. + + + + + + + + ]]> + + - - Links the sources. - + + Links the sources. + - - Determines if the output needs linking. - + + Determines if the output needs linking. + - - Quotes an argument value and duplicates trailing backslahes. - - The argument value to quote. - - The quotes argument value. - + + Quotes an argument value and duplicates trailing backslahes. + + The argument value to quote. + + The quotes argument value. + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - Create debugging information for the .exe file or DLL. The default is - . - + + Create debugging information for the .exe file or DLL. The default is + . + - - The output file. - + + The output file. + @@ -370,237 +370,237 @@ - - The name of a module-definition file (.def) to be passed to the - linker. - + + The name of a module-definition file (.def) to be passed to the + linker. + - - Specified DLLs for delay loading. - + + Specified DLLs for delay loading. + - - The list of files to combine into the output file. - + + The list of files to combine into the output file. + - - The list of additional library directories to search. - + + The list of additional library directories to search. + - - Link the specified modules into this assembly. - + + Link the specified modules into this assembly. + - - Embed the specified resources into this assembly. - + + Embed the specified resources into this assembly. + - - Symbols to add to the symbol table. - + + Symbols to add to the symbol table. + - - Names of libraries that you want the linker to ignore when it - resolves external references. - + + Names of libraries that you want the linker to ignore when it + resolves external references. + - - Gets the filename of the external program to start. - - The filename of the external program. + + Gets the filename of the external program to start. + + The filename of the external program. - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Compiles messages using mc.exe, Microsoft's Win32 message compiler. - - - - Compile text.mc using the default options. - - - - ]]> - - - Compile text.mc, passing a path to store the header, the rc - file and some additonal options. - - - - ]]> - - + + Compiles messages using mc.exe, Microsoft's Win32 message compiler. + + + + Compile text.mc using the default options. + + + + ]]> + + + Compile text.mc, passing a path to store the header, the rc + file and some additonal options. + + + + ]]> + + - - Compiles the sources. - + + Compiles the sources. + - - Determine if source files need re-building. - + + Determine if source files need re-building. + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - Path to store header file. The default is the project base directory. - + + Path to store header file. The default is the project base directory. + - - Path to store RC file. The default is the project base directory. - + + Path to store RC file. The default is the project base directory. + - - Input filename. - + + Input filename. + - - Gets the filename of the external program to start. - - - The filename of the external program. - + + Gets the filename of the external program to start. + + + The filename of the external program. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - This tasks allows you to run MIDL.exe. - - - - This task only supports a small subset of the MIDL.EXE command line - switches, but you can use the options element to specify any other - unsupported commands you want to specify. - - - - - - - - - - - - - ]]> - - + + This tasks allows you to run MIDL.exe. + + + + This task only supports a small subset of the MIDL.EXE command line + switches, but you can use the options element to specify any other + unsupported commands you want to specify. + + + + + + + + + + + + + ]]> + + - - This is where the work is done. - + + This is where the work is done. + - - Check output files to see if we need rebuilding. - - if a rebuild is needed; otherwise, - . + + Check output files to see if we need rebuilding. + + if a rebuild is needed; otherwise, + . - - Check output files to see if we need rebuilding. - - - if a rebuild is needed; otherwise, - . - + + Check output files to see if we need rebuilding. + + + if a rebuild is needed; otherwise, + . + - - Writes the response file for midl.exe. - + + Writes the response file for midl.exe. + - - The /acf switch allows the user to supply an - explicit ACF file name. The switch also - allows the use of different interface names in - the IDL and ACF files. - + + The /acf switch allows the user to supply an + explicit ACF file name. The switch also + allows the use of different interface names in + the IDL and ACF files. + - - The /align switch is functionally the same as the - MIDL /Zp option and is recognized by the MIDL compiler - solely for backward compatibility with MkTypLib. - - The alignment value can be 1, 2, 4, or 8. + + The /align switch is functionally the same as the + MIDL /Zp option and is recognized by the MIDL compiler + solely for backward compatibility with MkTypLib. + + The alignment value can be 1, 2, 4, or 8. - - The /app_config switch selects application-configuration - mode, which allows you to use some ACF keywords in the - IDL file. With this MIDL compiler switch, you can omit - the ACF and specify an interface in a single IDL file. - + + The /app_config switch selects application-configuration + mode, which allows you to use some ACF keywords in the + IDL file. With this MIDL compiler switch, you can omit + the ACF and specify an interface in a single IDL file. + - - The /char switch helps to ensure that the MIDL compiler - and C compiler operate together correctly for all char - and small types. - - Can be one of signed | unsigned | ascii7 + + The /char switch helps to ensure that the MIDL compiler + and C compiler operate together correctly for all char + and small types. + + Can be one of signed | unsigned | ascii7 - - The /client switch directs the MIDL compiler to generate - client-side C source files for an RPC interface - - can be one of stub | none + + The /client switch directs the MIDL compiler to generate + client-side C source files for an RPC interface + + can be one of stub | none - - The /cstub switch specifies the name of the client - stub file for an RPC interface. - + + The /cstub switch specifies the name of the client + stub file for an RPC interface. + @@ -610,198 +610,198 @@ - - The /env switch selects the - environment in which the application runs. - - It can take the values win32 and win64 + + The /env switch selects the + environment in which the application runs. + + It can take the values win32 and win64 - - The /Oi switch directs the MIDL compiler to - use a fully-interpreted marshaling method. - The /Oic and /Oicf switches provide additional - performance enhancements. - - - If you specify the Oi attribute, you must set it to - one of the values: - - Oi="" - - Oi="c" - - Oi="f" - - Oi="cf" - + + The /Oi switch directs the MIDL compiler to + use a fully-interpreted marshaling method. + The /Oic and /Oicf switches provide additional + performance enhancements. + + + If you specify the Oi attribute, you must set it to + one of the values: + - Oi="" + - Oi="c" + - Oi="f" + - Oi="cf" + - - Specifies a file name for the type library generated by the MIDL - compiler. - + + Specifies a file name for the type library generated by the MIDL + compiler. + - - Specifies the name of the header file. - + + Specifies the name of the header file. + - - Specifies the name of the interface identifier file for a COM - interface, overriding the default name obtained by adding _i.c - to the IDL file name. - + + Specifies the name of the interface identifier file for a COM + interface, overriding the default name obtained by adding _i.c + to the IDL file name. + - - Specifies the name of the interface proxy file for a COM interface. - + + Specifies the name of the interface proxy file for a COM interface. + - - Name of .IDL file to process. - + + Name of .IDL file to process. + - - Additional options to pass to midl.exe. - + + Additional options to pass to midl.exe. + - - Macro definitions to pass to mdil.exe. - Each entry will generate a /D - + + Macro definitions to pass to mdil.exe. + Each entry will generate a /D + - - Macro undefines (/U) to pass to mdil. - + + Macro undefines (/U) to pass to mdil. + - - The list of directories in which to search for include files. - + + The list of directories in which to search for include files. + - - Filename of program to execute - + + Filename of program to execute + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Compiles resources using rc.exe, Microsoft's Win32 resource - compiler. - - - - Compile text.rc to text.res using the default options. - - - - ]]> - - - - - Compile text.rc, passing an additional option. - - - - ]]> - - + + Compiles resources using rc.exe, Microsoft's Win32 resource + compiler. + + + + Compile text.rc to text.res using the default options. + + + + ]]> + + + + + Compile text.rc, passing an additional option. + + + + ]]> + + - - Compile the resource file - + + Compile the resource file + - - Determines if the resource need compiling. - + + Determines if the resource need compiling. + - - Check if a resource file has been updated. - - - + + Check if a resource file has been updated. + + + - - Options to pass to the compiler. - + + Options to pass to the compiler. + - - Output file. - + + Output file. + - - The resource file to compile. - + + The resource file to compile. + - - Default language ID. - + + Default language ID. + - - The list of directories in which to search for include files. - + + The list of directories in which to search for include files. + - - Macro definitions to pass to rc.exe. - Each entry will generate a /d - + + Macro definitions to pass to rc.exe. + Each entry will generate a /d + - - Filename of program to execute - + + Filename of program to execute + - - Arguments of program to execute - + + Arguments of program to execute + - - Defines the character sets that can be used by the C++ compiler. - + + Defines the character sets that can be used by the C++ compiler. + - - Have the compiler determine the character set. - + + Have the compiler determine the character set. + - - Unicode character set. - + + Unicode character set. + - - Multi-byte character set. - + + Multi-byte character set. + - - Represents a library. - + + Represents a library. + @@ -816,21 +816,21 @@ is . - - The name of the library. - + + The name of the library. + - - If then the element will be processed; - otherwise, skipped. The default is . - + + If then the element will be processed; + otherwise, skipped. The default is . + - - If then the element will be skipped; - otherwise, processed. The default is . - + + If then the element will be skipped; + otherwise, processed. The default is . + @@ -884,11 +884,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -921,10 +921,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -939,33 +939,33 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Represents a symbol. - + + Represents a symbol. + @@ -980,21 +980,21 @@ is . - - The name of the symbol. - + + The name of the symbol. + - - If then the element will be processed; - otherwise, skipped. The default is . - + + If then the element will be processed; + otherwise, skipped. The default is . + - - If then the element will be skipped; - otherwise, processed. The default is . - + + If then the element will be skipped; + otherwise, processed. The default is . + @@ -1048,11 +1048,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -1085,10 +1085,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -1103,55 +1103,55 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Defines how to deal with backslashes in values of command line - arguments. - + + Defines how to deal with backslashes in values of command line + arguments. + - - Does not perform any processing on backslashes. - + + Does not perform any processing on backslashes. + - - Duplicates the trailing backslash. - + + Duplicates the trailing backslash. + - - Fixes the trailing backslash by replaces trailing double backslashes - with only one backslash and removing single trailing backslashes. - + + Fixes the trailing backslash by replaces trailing double backslashes + with only one backslash and removing single trailing backslashes. + - - Removes all the trailing backslashes. - + + Removes all the trailing backslashes. + @@ -1172,29 +1172,29 @@ - - Duplicates the trailing backslash. - - The input string to check and duplicate the trailing backslash if necessary. - The result string after being processed. - - Also duplicates trailing backslash in quoted value. - + + Duplicates the trailing backslash. + + The input string to check and duplicate the trailing backslash if necessary. + The result string after being processed. + + Also duplicates trailing backslash in quoted value. + - - Fixes the trailing backslash. This function replaces the trailing double backslashes with - only one backslash. It also, removes the single trailing backslash. - - The input string. - The result string after being processed. + + Fixes the trailing backslash. This function replaces the trailing double backslashes with + only one backslash. It also, removes the single trailing backslash. + + The input string. + The result string after being processed. - - Removes all the trailing backslashes from the input. - - The input string. - The result string without trailing backslashes. + + Removes all the trailing backslashes from the input. + + The input string. + The result string without trailing backslashes. diff --git a/example_scripts/Tools/nant/bin/NAnt.Win32Tasks.xml b/example_scripts/Tools/nant/bin/NAnt.Win32Tasks.xml index 0fb6349..1478bd8 100644 --- a/example_scripts/Tools/nant/bin/NAnt.Win32Tasks.xml +++ b/example_scripts/Tools/nant/bin/NAnt.Win32Tasks.xml @@ -5,15 +5,15 @@ - - Groups a set of functions that convert Windows native filenames to - Cygwin POSIX-style pathnames and vice versa. - - - It can be used when a Cygwin program needs to pass a file name to a - native Windows program, or expects to get a file name from a native - Windows program. - + + Groups a set of functions that convert Windows native filenames to + Cygwin POSIX-style pathnames and vice versa. + + + It can be used when a Cygwin program needs to pass a file name to a + native Windows program, or expects to get a file name from a native + Windows program. + @@ -67,128 +67,128 @@ - - Factory method to return a new instance of ExecTask - - - + + Factory method to return a new instance of ExecTask + + + - - Generates a Windows Forms Control that wraps ActiveX Controls defined - in an OCX. - - - - - ]]> - - + + Generates a Windows Forms Control that wraps ActiveX Controls defined + in an OCX. + + + + + ]]> + + - - Import the ActiveX control. - + + Import the ActiveX control. + - - Determines whether the assembly needs to be created again. - - - if the assembly needs to be created again; - otherwise, . - + + Determines whether the assembly needs to be created again. + + + if the assembly needs to be created again; + otherwise, . + - - Filename of the .ocx file. - + + Filename of the .ocx file. + - - Filename of the generated assembly. - + + Filename of the generated assembly. + - - Specifies the file containing the public key to use to sign the - resulting assembly. - - - The file containing the public key to use to sign the resulting - assembly. - + + Specifies the file containing the public key to use to sign the + resulting assembly. + + + The file containing the public key to use to sign the resulting + assembly. + - - Specifies the publisher's official public/private key pair with which - the resulting assembly should be signed with a strong name. - - - The keyfile to use to sign the resulting assembly with a strong name. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the publisher's official public/private key pair with which + the resulting assembly should be signed with a strong name. + + + The keyfile to use to sign the resulting assembly with a strong name. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the key container in which the public/private key pair - should be found that should be used to sign the resulting assembly - with a strong name. - - - The key container containing a public/private key pair that should - be used to sign the resulting assembly. - + + Specifies the key container in which the public/private key pair + should be found that should be used to sign the resulting assembly + with a strong name. + + + The key container containing a public/private key pair that should + be used to sign the resulting assembly. + - - Specifies to sign the resulting control using delayed signing. - + + Specifies to sign the resulting control using delayed signing. + - - Determines whether C# source code for the Windows Form wrapper should - be generated. The default is . - + + Determines whether C# source code for the Windows Form wrapper should + be generated. The default is . + - - Assembly to use for Runtime Callable Wrapper rather than generating - new one [.NET 1.1 or higher]. - + + Assembly to use for Runtime Callable Wrapper rather than generating + new one [.NET 1.1 or higher]. + - - Indicates whether aximp supports using an existing Runtime - Callable Wrapper for a given target framework. The default is - . - + + Indicates whether aximp supports using an existing Runtime + Callable Wrapper for a given target framework. The default is + . + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Reads the most recent Windows SDK InstallationFolder key into a NAnt property - - - - - ]]> - - + + Reads the most recent Windows SDK InstallationFolder key into a NAnt property + + + + + ]]> + + - - locate the most recent WinSDK installed - + + locate the most recent WinSDK installed + @@ -202,153 +202,153 @@ - - - The property to set to the value stored in the InstalledFolder key of the located WinSDK version. - - + + + The property to set to the value stored in the InstalledFolder key of the located WinSDK version. + + - - - The minimum acceptable Windows SDK version. - - + + + The minimum acceptable Windows SDK version. + + - - - The maximum acceptable Windows SDK version. - - + + + The maximum acceptable Windows SDK version. + + - - - The minimum acceptable .NET sdk version. - - + + + The minimum acceptable .NET sdk version. + + - - - The maximum acceptable .NET sdk version. - - + + + The maximum acceptable .NET sdk version. + + - - Reads the mono registry path into a NAnt property. - - - The mono registry keyes can exist in one of two places depending on the platform. This - task will check to see which registry path that Mono is using. - - - - - ]]> - - + + Reads the mono registry path into a NAnt property. + + + The mono registry keyes can exist in one of two places depending on the platform. This + task will check to see which registry path that Mono is using. + + + + + ]]> + + - - The Mono reg key to default to if none of the keys in _regKeys are found - in the running machine. - + + The Mono reg key to default to if none of the keys in _regKeys are found + in the running machine. + - - Private property name to assign the Mono registry path to. - + + Private property name to assign the Mono registry path to. + - - Private array of Mono registry paths to test in order. - - - If new registry paths are used by the Mono team, add them to this array. - + + Private array of Mono registry paths to test in order. + + + If new registry paths are used by the Mono team, add them to this array. + - - Locates the appropriate Mono registry path to use. - + + Locates the appropriate Mono registry path to use. + - - - The property to set to the Mono registry path. - - + + + The property to set to the Mono registry path. + + - - Reads a value or set of values from the Windows Registry into one or - more NAnt properties. - - - Read a single value from the registry. - - - ]]> - - Read all the registry values in a key. - - - ]]> - - + + Reads a value or set of values from the Windows Registry into one or + more NAnt properties. + + + Read a single value from the registry. + + + ]]> + + Read all the registry values in a key. + + + ]]> + + - - read the specified registry value - + + read the specified registry value + - - Returns the hive for a given key. - - - - - The hive for a given key. - + + Returns the hive for a given key. + + + + + The hive for a given key. + - - Returns the key for a given registry hive. - - The registry hive to return the key for. - - The key for a given registry hive. - + + Returns the key for a given registry hive. + + The registry hive to return the key for. + + The key for a given registry hive. + - - The property to set to the specified registry key value. - If this attribute is used then a single value will be read. - + + The property to set to the specified registry key value. + If this attribute is used then a single value will be read. + - - The prefix to use for the specified registry key values. - If this attribute is used then all registry values will be read and stored as properties with this prefix. - - - Registry values a, b, c will be turned into prefixa, prefixb, prefixc named properties - + + The prefix to use for the specified registry key values. + If this attribute is used then all registry values will be read and stored as properties with this prefix. + + + Registry values a, b, c will be turned into prefixa, prefixb, prefixc named properties + - - The registry key to read, including the path. - - - SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot - + + The registry key to read, including the path. + + + SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot + @@ -361,55 +361,55 @@ - - Registers an assembly, or set of assemblies for use from COM clients. - - - - Refer to the Regasm - documentation for more information on the regasm tool. - - - - - Register types in a single assembly. - - - - ]]> - - - - - Register types of an assembly and generate a type library containing - definitions of accessible types defined within the assembly. - - - - ]]> - - - - - Register types of set of assemblies at once, while specifying a set - of reference assemblies. - - - - - - - - - - - - ]]> - - + + Registers an assembly, or set of assemblies for use from COM clients. + + + + Refer to the Regasm + documentation for more information on the regasm tool. + + + + + Register types in a single assembly. + + + + ]]> + + + + + Register types of an assembly and generate a type library containing + definitions of accessible types defined within the assembly. + + + + ]]> + + + + + Register types of set of assemblies at once, while specifying a set + of reference assemblies. + + + + + + + + + + + + ]]> + + @@ -419,9 +419,9 @@ The of which the should be updated. - - Registers or unregisters a single assembly, or a group of assemblies. - + + Registers or unregisters a single assembly, or a group of assemblies. + @@ -430,371 +430,371 @@ - - Registry file to export to instead of entering the types directly - into the registry. - + + Registry file to export to instead of entering the types directly + into the registry. + - - Set the code base registry setting. - + + Set the code base registry setting. + - - Only refer to already registered type libraries. - + + Only refer to already registered type libraries. + - - Export the assemblies to the specified type library and register it. - + + Export the assemblies to the specified type library and register it. + - - Unregister the assembly. The default is . - + + Unregister the assembly. The default is . + - - The set of assemblies to register, or unregister. - + + The set of assemblies to register, or unregister. + - - The set of assembly references. - + + The set of assembly references. + - - Gets the working directory for the application. - - - The working directory for the application. - + + Gets the working directory for the application. + + + The working directory for the application. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Gets the filename of the external program to start. - - - The filename of the external program. - - - Override in derived classes to explicitly set the location of the - external tool. - + + Gets the filename of the external program to start. + + + The filename of the external program. + + + Override in derived classes to explicitly set the location of the + external tool. + - - Exports a .NET assembly to a type library that can be used from unmanaged - code (wraps Microsoft's tlbexp.exe). - - - - See the Microsoft.NET Framework SDK documentation for details. - - - - Export DotNetAssembly.dll to LegacyCOM.dll. - - - ]]> - - + + Exports a .NET assembly to a type library that can be used from unmanaged + code (wraps Microsoft's tlbexp.exe). + + + + See the Microsoft.NET Framework SDK documentation for details. + + + + Export DotNetAssembly.dll to LegacyCOM.dll. + + + ]]> + + - - Exports the type library. - + + Exports the type library. + - - Determines whether the assembly needs to be exported to a type - library again. - - - if the assembly needs to be exported to a - type library; otherwise, . - + + Determines whether the assembly needs to be exported to a type + library again. + + + if the assembly needs to be exported to a + type library; otherwise, . + - - Specifies the assembly for which to export a type library. - - - The assembly for which to export a type library. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the assembly for which to export a type library. + + + The assembly for which to export a type library. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the name of the type library file to generate. - - - The name of the type library file to generate. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the name of the type library file to generate. + + + The name of the type library file to generate. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the file used to determine capitalization of names in a - type library. - - - The file used to determine capitalization of names in a type library. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the file used to determine capitalization of names in a + type library. + + + The file used to determine capitalization of names in a type library. + + See the Microsoft.NET Framework SDK documentation for details. - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Imports a type library to a .NET assembly (wraps Microsoft's tlbimp.exe). - - - - This task lets you easily create interop assemblies. By default, it will - not reimport if the underlying COM TypeLib or reference has not changed. - - - See the Microsoft.NET Framework SDK documentation for details. - - - - Import LegacyCOM.dll to DotNetAssembly.dll. - - - ]]> - - - - - Generate an assembly named "Interop.MSVidCtlLib.dll" for the - MS Video Control 1.0 Type Library, transforming any [out, retval] - parameters of methods on dispinterfaces in the type library into - return values in the managed library. - - - - - - - - ]]> - - + + Imports a type library to a .NET assembly (wraps Microsoft's tlbimp.exe). + + + + This task lets you easily create interop assemblies. By default, it will + not reimport if the underlying COM TypeLib or reference has not changed. + + + See the Microsoft.NET Framework SDK documentation for details. + + + + Import LegacyCOM.dll to DotNetAssembly.dll. + + + ]]> + + + + + Generate an assembly named "Interop.MSVidCtlLib.dll" for the + MS Video Control 1.0 Type Library, transforming any [out, retval] + parameters of methods on dispinterfaces in the type library into + return values in the managed library. + + + + + + + + ]]> + + - - Imports the type library to a .NET assembly. - + + Imports the type library to a .NET assembly. + - - Returns the path of the type library, removing the identifier of - the type library from the specified string. - - The path from which to extract the path of the type library. - - The path of the type library without the type library identifier. - - - An example of a path which includes the identifier of the type - library (in this case "2") is - C:\WINDOWS\system32\msvidctl.dll\2. - + + Returns the path of the type library, removing the identifier of + the type library from the specified string. + + The path from which to extract the path of the type library. + + The path of the type library without the type library identifier. + + + An example of a path which includes the identifier of the type + library (in this case "2") is + C:\WINDOWS\system32\msvidctl.dll\2. + - - Determines whether the type library needs to be imported again. - - - if the type library needs to be imported; - otherwise, . - + + Determines whether the type library needs to be imported again. + + + if the type library needs to be imported; + otherwise, . + - - Specifies the name of the output file. - - - The name of the output file. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the name of the output file. + + + The name of the output file. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the namespace in which to produce the assembly. - - - The namespace in which to produce the assembly. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the namespace in which to produce the assembly. + + + The namespace in which to produce the assembly. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the version number of the assembly to produce. - - - - The version number of the assembly to produce. - - - The version number should be in the format major.minor.build.revision. - - - See the Microsoft.NET Framework SDK documentation for details. - - + + Specifies the version number of the assembly to produce. + + + + The version number of the assembly to produce. + + + The version number should be in the format major.minor.build.revision. + + + See the Microsoft.NET Framework SDK documentation for details. + + - - Specifies whether the resulting assembly should be signed with a - strong name using delayed signing. The default is . - - - if the resulting assembly should be signed - with a strong name using delayed signing; otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether the resulting assembly should be signed with a + strong name using delayed signing. The default is . + + + if the resulting assembly should be signed + with a strong name using delayed signing; otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether a primary interop assembly should be produced for - the specified type library. The default is . - - - if a primary interop assembly should be - produced; otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether a primary interop assembly should be produced for + the specified type library. The default is . + + + if a primary interop assembly should be + produced; otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the file containing the public key to use to sign the - resulting assembly. - - - The file containing the public key to use to sign the resulting - assembly. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the file containing the public key to use to sign the + resulting assembly. + + + The file containing the public key to use to sign the resulting + assembly. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the publisher's official public/private key pair with which - the resulting assembly should be signed with a strong name. - - - The keyfile to use to sign the resulting assembly with a strong name. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the publisher's official public/private key pair with which + the resulting assembly should be signed with a strong name. + + + The keyfile to use to sign the resulting assembly with a strong name. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the key container in which the public/private key pair - should be found that should be used to sign the resulting assembly - with a strong name. - - - The key container containing a public/private key pair that should - be used to sign the resulting assembly. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the key container in which the public/private key pair + should be found that should be used to sign the resulting assembly + with a strong name. + + + The key container containing a public/private key pair that should + be used to sign the resulting assembly. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies the assembly files to use to resolve references to types - defined outside the current type library. - - - The assembly files to use to resolve references to types defined - outside the current type library. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the assembly files to use to resolve references to types + defined outside the current type library. + + + The assembly files to use to resolve references to types defined + outside the current type library. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether a type library should not be imported if all - references within the current assembly or the reference assemblies - cannot be resolved. The default is . - - - if a type library should not be imported if - all references cannot be resolved; otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether a type library should not be imported if all + references within the current assembly or the reference assemblies + cannot be resolved. The default is . + + + if a type library should not be imported if + all references cannot be resolved; otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether to import a COM style SafeArray as a managed - class type. The default is . - - - if a COM style SafeArray should be imported - as a managed class type; otherwise, - . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether to import a COM style SafeArray as a managed + class type. The default is . + + + if a COM style SafeArray should be imported + as a managed class type; otherwise, + . + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies how to transform the metadata [.NET 1.1 or higher]. - + + Specifies how to transform the metadata [.NET 1.1 or higher]. + - - Specifies the source type library that gets passed to the type - library importer. - - - The source type library that gets passed to the type library - importer. - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies the source type library that gets passed to the type + library importer. + + + The source type library that gets passed to the type library + importer. + + See the Microsoft.NET Framework SDK documentation for details. - - Specifies whether interfaces should be produced without .NET Framework - security checks. The default is . - - - if interfaces without .NET Framework security - checks should be produced; otherwise, . - - See the Microsoft.NET Framework SDK documentation for details. + + Specifies whether interfaces should be produced without .NET Framework + security checks. The default is . + + + if interfaces without .NET Framework security + checks should be produced; otherwise, . + + See the Microsoft.NET Framework SDK documentation for details. - - Indicates whether tlbimp supports transforming metadata for - a given target framework. The default is . - + + Indicates whether tlbimp supports transforming metadata for + a given target framework. The default is . + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + diff --git a/example_scripts/Tools/nant/bin/NAnt.xml b/example_scripts/Tools/nant/bin/NAnt.xml index 64a0575..286dda1 100644 --- a/example_scripts/Tools/nant/bin/NAnt.xml +++ b/example_scripts/Tools/nant/bin/NAnt.xml @@ -11,47 +11,47 @@ - - Entry point for executable - - Command Line arguments - The result of the real execution + + Entry point for executable + + Command Line arguments + The result of the real execution - - Constructs the privatebinpath. - - - - For the common version dir, we do not use the framework version - as defined in the NAnt configuration file but the CLR version - since the assemblies in that directory are not specific to a - certain family and the framwork version might differ between - families (eg. mono 1.0 == .NET 1.1). - - - The runtime framework. - The base directory of the domain. - - The privatebinpath. - + + Constructs the privatebinpath. + + + + For the common version dir, we do not use the framework version + as defined in the NAnt configuration file but the CLR version + since the assemblies in that directory are not specific to a + certain family and the framwork version might differ between + families (eg. mono 1.0 == .NET 1.1). + + + The runtime framework. + The base directory of the domain. + + The privatebinpath. + - - Given an absolute directory and an absolute file name, returns a - relative file name. - - An absolute directory. - An absolute file name. - - A relative file name for the given absolute file name. - + + Given an absolute directory and an absolute file name, returns a + relative file name. + + An absolute directory. + An absolute file name. + + A relative file name for the given absolute file name. + - - Helper class for invoking the application entry point in NAnt.Core - and passing the command-line arguments. - + + Helper class for invoking the application entry point in NAnt.Core + and passing the command-line arguments. + @@ -62,17 +62,17 @@ Directories relative to the base directory of the AppDomain to probe for missing assembly references. - - Invokes the application entry point in NAnt.Core. - + + Invokes the application entry point in NAnt.Core. + - - Gets the status that the build process returned when it exited. - - - The code that the build process specified when it terminated. - + + Gets the status that the build process returned when it exited. + + + The code that the build process specified when it terminated. + diff --git a/example_scripts/Tools/nant/contrib/NAnt.Contrib.Tasks.xml b/example_scripts/Tools/nant/contrib/NAnt.Contrib.Tasks.xml index c877adb..de1c5bf 100644 --- a/example_scripts/Tools/nant/contrib/NAnt.Contrib.Tasks.xml +++ b/example_scripts/Tools/nant/contrib/NAnt.Contrib.Tasks.xml @@ -5,9 +5,9 @@ - - Groups a set of functions for dealing with files. - + + Groups a set of functions for dealing with files. + @@ -43,9 +43,9 @@ - - Provides methods for interrogating Filesets. - + + Provides methods for interrogating Filesets. + @@ -115,10 +115,10 @@ - - Allows information on Windows Installer databases and products to be - retrieved. - + + Allows information on Windows Installer databases and products to be + retrieved. + @@ -154,32 +154,32 @@ - - Returns a value indicating whether a product with the specified - product code is installed. - - The product code of the product to check. - - if a product with the specified product - code is installed; otherwise, . - - - - Retrieves the product code of a given installer database, and - fails the build if the product is not installed. - - - - Please install Office first. - ]]> - - + + Returns a value indicating whether a product with the specified + product code is installed. + + The product code of the product to check. + + if a product with the specified product + code is installed; otherwise, . + + + + Retrieves the product code of a given installer database, and + fails the build if the product is not installed. + + + + Please install Office first. + ]]> + + - - Allow information on a Windows service to be retrieved. - + + Allow information on a Windows service to be retrieved. + @@ -311,43 +311,43 @@ - - Gets the friendly name of the specified service. - - The short name that identifies the service to the system. - The computer on which the service resides. - - The friendly name of the service, which can be used to identify the service. - + + Gets the friendly name of the specified service. + + The short name that identifies the service to the system. + The computer on which the service resides. + + The friendly name of the service, which can be used to identify the service. + - - Gets the name that identifies the specified service - - The short name that identifies the service to the system. - The computer on which the service resides. - - The name that identifies the service. - + + Gets the name that identifies the specified service + + The short name that identifies the service to the system. + The computer on which the service resides. + + The name that identifies the service. + - - The name of the management SQL database. - + + The name of the management SQL database. + - - The name of the SQL Server where the management database is - located. - + + The name of the SQL Server where the management database is + located. + - - Deploys an assembly to a given BizTalk configuration database. - - - Deployment will fail if the assembly is already deployed. - + + Deploys an assembly to a given BizTalk configuration database. + + + Deployment will fail if the assembly is already deployed. + @@ -362,32 +362,32 @@ - - The path to the BizTalk assembly to deploy. - + + The path to the BizTalk assembly to deploy. + - - Determines whether to install the assembly in the Global Assembly - Cache. The default is . - + + Determines whether to install the assembly in the Global Assembly + Cache. The default is . + - - The path to an assembly binding information file to import bindings - from. - + + The path to an assembly binding information file to import bindings + from. + - - The path to the HTML log file to generate. - + + The path to the HTML log file to generate. + - - Exports bindings for a BizTalk assembly to an assembly binding - information file. - + + Exports bindings for a BizTalk assembly to an assembly binding + information file. + @@ -400,88 +400,88 @@ - - The path to the BizTalk assembly for which to export bindings. - + + The path to the BizTalk assembly for which to export bindings. + - - The path to an assembly binding information file in which the - bindings will be saved. - + + The path to an assembly binding information file in which the + bindings will be saved. + - - The path to the HTML log file to generate. - + + The path to the HTML log file to generate. + - - Allows BizTalk (in-process) host instances to be controlled. - - - - Starts the "BizTalkServerApplication" host instance - on server "SV-ARD-EAI". - - - - ]]> - - - - - Stops all "BizTalkServerApplication" host instances. - - - - ]]> - - + + Allows BizTalk (in-process) host instances to be controlled. + + + + Starts the "BizTalkServerApplication" host instance + on server "SV-ARD-EAI". + + + + ]]> + + + + + Stops all "BizTalkServerApplication" host instances. + + + + ]]> + + - - The name of the host on which the perform the action. - + + The name of the host on which the perform the action. + - - The name of the BizTalk server on which to perform the action. - If not specified, the action will be performed on all instances. - + + The name of the BizTalk server on which to perform the action. + If not specified, the action will be performed on all instances. + - - The action that should be performed on the host. - + + The action that should be performed on the host. + - - Defines the actions that can be performed on a host instance. - + + Defines the actions that can be performed on a host instance. + - - Starts the host instance. - + + Starts the host instance. + - - Stops the host instance. - + + Stops the host instance. + - - Stops and restarts the host instance. - + + Stops and restarts the host instance. + - - Imports bindings from a given assembly binding information file into - the specified BizTalk configuration database. - + + Imports bindings from a given assembly binding information file into + the specified BizTalk configuration database. + @@ -494,40 +494,40 @@ - - The path to the assembly binding information file containing the - bindings to import. - + + The path to the assembly binding information file containing the + bindings to import. + - - The path to the HTML log file to generate. - + + The path to the HTML log file to generate. + - - Performs a set of actions on a given orchestration. - + + Performs a set of actions on a given orchestration. + - - The name of the BizTalk server on which to perform the action. - + + The name of the BizTalk server on which to perform the action. + - - The name of the orchestration to perform an action on. - + + The name of the orchestration to perform an action on. + - - Logs a message with the given priority. - - The message priority at which the specified message is to be logged. - The message to be logged. - - The actual logging is delegated to the project. - + + Logs a message with the given priority. + + The message priority at which the specified message is to be logged. + The message to be logged. + + The actual logging is delegated to the project. + @@ -541,34 +541,34 @@ - - Starts the orchestration. - - - If the orchestration is not yet enlisted, then this will be done - first. - + + Starts the orchestration. + + + If the orchestration is not yet enlisted, then this will be done + first. + - - Specifies whether receive locations associated with this - orchestration should be automatically enabled. The default is - . - + + Specifies whether receive locations associated with this + orchestration should be automatically enabled. The default is + . + - - Specifies whether service instances of this orchestration that - were manually suspended previously should be automatically - resumed. The default is . - + + Specifies whether service instances of this orchestration that + were manually suspended previously should be automatically + resumed. The default is . + - - Specifies whether send ports and send port groups imported by - this orchestration should be automatically started. The default - is . - + + Specifies whether send ports and send port groups imported by + this orchestration should be automatically started. The default + is . + @@ -592,107 +592,107 @@ - - Specifies whether receive locations associated with this - orchestration should be automatically disabled. The default - is . - + + Specifies whether receive locations associated with this + orchestration should be automatically disabled. The default + is . + - - Specifies whether instances of this orchestration should be - automatically suspended. The default is . - + + Specifies whether instances of this orchestration should be + automatically suspended. The default is . + - - Enlists the orchestration by creating its activation subscription. - + + Enlists the orchestration by creating its activation subscription. + - - Specifies the BizTalk host on which to enlist the orchestration. - + + Specifies the BizTalk host on which to enlist the orchestration. + - - Unenlists the orchestration by removing its activation subscription. - + + Unenlists the orchestration by removing its activation subscription. + - - Specifies whether instances of this orchestration type should - be automatically terminated. The default is . - + + Specifies whether instances of this orchestration type should + be automatically terminated. The default is . + - - Allows BizTalk receive locations to be controlled. - - - - Enables the "HttpReceive" receive location on server - "SV-ARD-EAI". - - - - ]]> - - - - - Disables the "HttpReceive" receive location on server - "SV-ARD-EAI". - - - - ]]> - - + + Allows BizTalk receive locations to be controlled. + + + + Enables the "HttpReceive" receive location on server + "SV-ARD-EAI". + + + + ]]> + + + + + Disables the "HttpReceive" receive location on server + "SV-ARD-EAI". + + + + ]]> + + - - The name of the receive location on which the perform the action. - + + The name of the receive location on which the perform the action. + - - The name of the BizTalk server on which to perform the action. - + + The name of the BizTalk server on which to perform the action. + - - The action that should be performed on the receive location. - + + The action that should be performed on the receive location. + - - Defines the actions that can be performed on a BizTalk receive - location. - + + Defines the actions that can be performed on a BizTalk receive + location. + - - Enables the receive location. - + + Enables the receive location. + - - Disables the receive location. - + + Disables the receive location. + - - Allows stopping, starting and resetting of BizTalk in-process host - instances on the specified server. - + + Allows stopping, starting and resetting of BizTalk in-process host + instances on the specified server. + - - The name of the BizTalk server on which to perform the action. - + + The name of the BizTalk server on which to perform the action. + @@ -701,103 +701,103 @@ - - Defines the possible actions that can be performed on the BizTalk - in-process host instances. - + + Defines the possible actions that can be performed on the BizTalk + in-process host instances. + - - Stops all in-process host instances. - + + Stops all in-process host instances. + - - Starts all in-process host instances. - + + Starts all in-process host instances. + - - Stops and restarts all in-process host instances. - + + Stops and restarts all in-process host instances. + - - Allows BizTalk send ports to be controlled. - - - - Starts the "UmeHttpSendPort" send port on server - "SV-ARD-EAI". - - - - ]]> - - - - - Unenlists the "UmeHttpSendPort" send port on server - "SV-ARD-EAI". - - - - ]]> - - + + Allows BizTalk send ports to be controlled. + + + + Starts the "UmeHttpSendPort" send port on server + "SV-ARD-EAI". + + + + ]]> + + + + + Unenlists the "UmeHttpSendPort" send port on server + "SV-ARD-EAI". + + + + ]]> + + - - The name of the send port on which the perform the action. - + + The name of the send port on which the perform the action. + - - The name of the BizTalk server on which to perform the action. - + + The name of the BizTalk server on which to perform the action. + - - The action that should be performed on the send port. - + + The action that should be performed on the send port. + - - Defines the actions that can be performed on a BizTalk send port. - + + Defines the actions that can be performed on a BizTalk send port. + - - Starts the send port. - + + Starts the send port. + - - Stops the send port. - + + Stops the send port. + - - Stops and restarts the send port. - + + Stops and restarts the send port. + - - Enlists the send port. - + + Enlists the send port. + - - Unenlists the send port. - + + Unenlists the send port. + - - Removes all bindings for a given assembly from a BizTalk configuration - database. - + + Removes all bindings for a given assembly from a BizTalk configuration + database. + @@ -810,31 +810,31 @@ - - The path to the BizTalk assembly for which to remove all bindings. - + + The path to the BizTalk assembly for which to remove all bindings. + - - The name of the BizTalk server on which to perform the operation. - + + The name of the BizTalk server on which to perform the operation. + - - The assembly qualified name of the receive pipeline to set when - unbinding a receive pipeline. - + + The assembly qualified name of the receive pipeline to set when + unbinding a receive pipeline. + - - The assembly qualified name of the SEND pipeline to set when - unbinding a send pipeline. - + + The assembly qualified name of the SEND pipeline to set when + unbinding a send pipeline. + - - Removes a given assembly from a BizTalk configuration database. - + + Removes a given assembly from a BizTalk configuration database. + @@ -847,62 +847,62 @@ - - The path to the BizTalk assembly to remove. - + + The path to the BizTalk assembly to remove. + - - Determines whether to remove the assembly from the Global Assembly - Cache. The default is . - + + Determines whether to remove the assembly from the Global Assembly + Cache. The default is . + - - The path to the HTML log file to generate. - + + The path to the HTML log file to generate. + - - Base class for all the ClearCase tasks. - + + Base class for all the ClearCase tasks. + - - Base Constructor. - + + Base Constructor. + - - Execute the perforce command assembled by subclasses. - + + Execute the perforce command assembled by subclasses. + - - Derived classes should override this to provide command-specific - commandline arguments. - + + Derived classes should override this to provide command-specific + commandline arguments. + - - Overrides the base class. - + + Overrides the base class. + - - Displays a ClearCase config spec. - + + Displays a ClearCase config spec. + - - The view tag identifying the ClearCase view that will have its - config spec displayed. - + + The view tag identifying the ClearCase view that will have its + config spec displayed. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -932,10 +932,10 @@ - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + @@ -950,33 +950,33 @@ - - if warning messages should be suppressed. - The default is . - + + if warning messages should be suppressed. + The default is . + - - If , the modification time will be preserved. - Default is . - + + If , the modification time will be preserved. + Default is . + - - to keep a view-private copy of the file with - a .keep extension. Default is . - + + to keep a view-private copy of the file with + a .keep extension. Default is . + - - If , files may be checked in even if identical - to the original. Default is . - + + If , files may be checked in even if identical + to the original. Default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1008,44 +1008,44 @@ - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + - - to check the element out as reserved. - Default is . - + + to check the element out as reserved. + Default is . + - - Creates a writable file under a different filename. - + + Creates a writable file under a different filename. + - - If , checks out the file but does not create - an editable file containing its data. Default is . - + + If , checks out the file but does not create + an editable file containing its data. Default is . + - - Specify a branch to check out the file to. - + + Specify a branch to check out the file to. + - - If , checkouts of elements with a version - other than main latest will be allowed. Default is . - + + If , checkouts of elements with a version + other than main latest will be allowed. Default is . + - - if warning messages should be suppressed. - The default is . - + + if warning messages should be suppressed. + The default is . + @@ -1060,15 +1060,15 @@ - - If , the modification time will be preserved. - Default is . - + + If , the modification time will be preserved. + Default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1092,10 +1092,10 @@ - - If an existing lock can be replaced. - Default is . - + + If an existing lock can be replaced. + Default is . + @@ -1124,49 +1124,49 @@ - - Specifies the object pathname to be locked. - + + Specifies the object pathname to be locked. + - - Specifies the object(s) to be locked. - + + Specifies the object(s) to be locked. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Creates elements in a ClearCase VOB. - - - - This task uses the cleartool mkelem command to create ClearCase elements. - - - - - Performs a ClearCase mkelem on the file c:/views/viewdir/afile with element type text_file. - It checks in the file after creation and adds Some comment text as a comment. - - - - ]]> - - + + Creates elements in a ClearCase VOB. + + + + This task uses the cleartool mkelem command to create ClearCase elements. + + + + + Performs a ClearCase mkelem on the file c:/views/viewdir/afile with element type text_file. + It checks in the file after creation and adds Some comment text as a comment. + + + + ]]> + + - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + @@ -1181,50 +1181,50 @@ - - If , warning will be suppressed. - The default is . - + + If , warning will be suppressed. + The default is . + - - Perform a checkout after element creation. - Default is . - + + Perform a checkout after element creation. + Default is . + - - Checkin element after creation. - Default is . - + + Checkin element after creation. + Default is . + - - If , the modification time will be preserved. - Default is . - + + If , the modification time will be preserved. + Default is . + - - Assign mastership of the main branch to the current site. - Default is . - + + Assign mastership of the main branch to the current site. + Default is . + - - Element type to use during element creation. - + + Element type to use during element creation. + - - Create elements from the view-private parent directories. - Default is . - + + Create elements from the view-private parent directories. + Default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1255,38 +1255,38 @@ - - Name of the label type - + + Name of the label type + - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + - - If , allow the replacement of a - label of the same type on the same branch. - The default is . - + + If , allow the replacement of a + label of the same type on the same branch. + The default is . + - - If , process each subdirectory recursively under the viewpath. - Default is . - + + If , process each subdirectory recursively under the viewpath. + Default is . + - - Identify a specific version to attach the label to. - + + Identify a specific version to attach the label to. + - - Path to the ClearCase view file or directory that the command will operate on. - + + Path to the ClearCase view file or directory that the command will operate on. + @@ -1301,14 +1301,14 @@ - - For any VOB symbolic links encountered, labels the corresponding target. - + + For any VOB symbolic links encountered, labels the corresponding target. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1336,46 +1336,46 @@ - - Name of the label type to create. - + + Name of the label type to create. + - - Name of the VOB. Must be a valid path to somewhere on a VOB. - + + Name of the VOB. Must be a valid path to somewhere on a VOB. + - - If , allow an existing label definition to be replaced. - The default is . - + + If , allow an existing label definition to be replaced. + The default is . + - - Creates a label type that is global to the VOB or to VOB's that use this VOB. - Either global or ordinary can be specified, not both. - The default is . - + + Creates a label type that is global to the VOB or to VOB's that use this VOB. + Either global or ordinary can be specified, not both. + The default is . + - - Creates a label type that can be used only in the current VOB. - Either global or ordinary can be specified, not both. - Although by default, if global is also or not specified ordinary is the default behaviour. - + + Creates a label type that can be used only in the current VOB. + Either global or ordinary can be specified, not both. + Although by default, if global is also or not specified ordinary is the default behaviour. + - - If the label type is allowed to be used once per branch in a given element's version tree. - The default is . - + + If the label type is allowed to be used once per branch in a given element's version tree. + The default is . + - - Sets the way mastership is checked by ClearCase. See ClearCase documentation for details. - The default is . - + + Sets the way mastership is checked by ClearCase. See ClearCase documentation for details. + The default is . + @@ -1390,9 +1390,9 @@ - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1421,14 +1421,14 @@ - - The kind of type to remove. - + + The kind of type to remove. + - - The name of the object to remove. - + + The name of the object to remove. + @@ -1439,10 +1439,10 @@ - - Removes all instances of a type and the type object itself. - The default is . - + + Removes all instances of a type and the type object itself. + The default is . + @@ -1457,9 +1457,9 @@ - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1486,21 +1486,21 @@ - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + - - If , a view-private copy of the file with a - .keep extension will be kept. Default is . - + + If , a view-private copy of the file with a + .keep extension will be kept. Default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + @@ -1536,76 +1536,76 @@ - - Specifies the object pathname to be unlocked. - + + Specifies the object pathname to be unlocked. + - - Specifies the object(s) to be unlocked. - + + Specifies the object(s) to be unlocked. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Updates a ClearCase view. - - - - This task uses the cleartool update command to update a ClearCase view. - - - - - Performs a ClearCase update on the snapshot view directory c:/views/viewdir. - A graphical dialog will be displayed. - The output will be logged to log.log and it will overwrite any hijacked files. - The modified time will be set to the current time. - - - - ]]> - - + + Updates a ClearCase view. + + + + This task uses the cleartool update command to update a ClearCase view. + + + + + Performs a ClearCase update on the snapshot view directory c:/views/viewdir. + A graphical dialog will be displayed. + The output will be logged to log.log and it will overwrite any hijacked files. + The modified time will be set to the current time. + + + + ]]> + + - - Path to the ClearCase view file or directory that the command will - operate on. - + + Path to the ClearCase view file or directory that the command will + operate on. + - - Displays a graphical dialog during the update. - The default is . - + + Displays a graphical dialog during the update. + The default is . + - - Specifies a log file for ClearCase to write to. - + + Specifies a log file for ClearCase to write to. + - - If , hijacked files will be overwritten. - The default is . - + + If , hijacked files will be overwritten. + The default is . + - - If , hijacked files will be renamed with a .keep extension. - The default is . - + + If , hijacked files will be renamed with a .keep extension. + The default is . + @@ -1622,64 +1622,64 @@ - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Searches files for a regular-expression and produces an XML report of - the matches. - - - - Extract all TODO:, UNDONE: or HACK:- - comment-tags from C# source files and write them to a file - out.xml. (A xslt-stylesheet could then transform it to - a nice html-page for your project-homepage, but that is beyond - the scope of this example.) - - - Path, File and LineNumber are automatically - generated elements. - - - - - - - - ]]> - - - The resulting XML file for a comment-tag - 'TODO: [md, 14-02-2004] comment this method' - will look like - - - - - - TODO - comment this method - C:\MyProjects\MyPath - MyFile.cs - 146 - md - 14-02-2004 - - ... - - ]]> - - + + Searches files for a regular-expression and produces an XML report of + the matches. + + + + Extract all TODO:, UNDONE: or HACK:- + comment-tags from C# source files and write them to a file + out.xml. (A xslt-stylesheet could then transform it to + a nice html-page for your project-homepage, but that is beyond + the scope of this example.) + + + Path, File and LineNumber are automatically + generated elements. + + + + + + + + ]]> + + + The resulting XML file for a comment-tag + 'TODO: [md, 14-02-2004] comment this method' + will look like + + + + + + TODO + comment this method + C:\MyProjects\MyPath + MyFile.cs + 146 + md + 14-02-2004 + + ... + + ]]> + + - - Performs the regex-search. - + + Performs the regex-search. + @@ -1696,19 +1696,19 @@ The collection of matches to write. - - Specifies the name of the output file. - + + Specifies the name of the output file. + - - Specifies the regular-expression to search for. - + + Specifies the regular-expression to search for. + - - The set of files in which the expression is searched. - + + The set of files in which the expression is searched. + @@ -1718,9 +1718,9 @@ - - The string to count in - + + The string to count in + @@ -1739,14 +1739,14 @@ for which lines are counted. - - Counts the line-numbers until the position - is reached. - - Index into the string given during construction - - The number of lines. - + + Counts the line-numbers until the position + is reached. + + Index into the string given during construction + + The number of lines. + @@ -1765,10 +1765,10 @@ - - Encapsulation of a match of a regular-expression with the - associated named capture-groups. - + + Encapsulation of a match of a regular-expression with the + associated named capture-groups. + @@ -1783,9 +1783,9 @@ The to write to. - - Gets or sets the value for a capture group. - + + Gets or sets the value for a capture group. + @@ -1806,14 +1806,14 @@ Collection of instances to add. - - Gets the th match stored in this collection. - + + Gets the th match stored in this collection. + - - Encapsulation of a search pattern. - + + Encapsulation of a search pattern. + @@ -1838,146 +1838,146 @@ - - Extracts the matches of this pattern from . - - The name of the file associated with . - The source string - - A collection of found matches. - + + Extracts the matches of this pattern from . + + The name of the file associated with . + The source string + + A collection of found matches. + - - The base abstract class for all MKS Tasks. - - - Provides the core attributes, and functionality for opening an item - in a MKS database. - + + The base abstract class for all MKS Tasks. + + + Provides the core attributes, and functionality for opening an item + in a MKS database. + - - Opens the MKS database and sets the reference to the specified - item and version. - + + Opens the MKS database and sets the reference to the specified + item and version. + - - The password to use to login to the MKS database. - + + The password to use to login to the MKS database. + - - The name of the user needed to access the MKS database. - + + The name of the user needed to access the MKS database. + - - The name of the host MKS server to connect to - + + The name of the host MKS server to connect to + - - The port number on which the host server is accepting requests - + + The port number on which the host server is accepting requests + - - Checkpoints a project in an MKS Source Integrity database. - - - Checkpoint a project in an MKS database. - - ]]> - + + Checkpoints a project in an MKS Source Integrity database. + + + Checkpoint a project in an MKS database. + + ]]> + - - The label to apply to the checkpoint. - + + The label to apply to the checkpoint. + - - The project to checkpoint. - + + The project to checkpoint. + - - Apply label to all members. The default is . - + + Apply label to all members. The default is . + - - The description of the checkpoint. - + + The description of the checkpoint. + - - Retrieves an item or project from MKS Source Integrity. - - - Synchronise sandbox with MKS project. - - ]]> - + + Retrieves an item or project from MKS Source Integrity. + + + Synchronise sandbox with MKS project. + + ]]> + - - The path to the local working directory. - + + The path to the local working directory. + - - The project to get from MKS. - + + The project to get from MKS. + - - Generates an XML file containing the differences between the sandbox and - the project in the MKS database. - - - Get changes to a project in an MKS database. - - ]]> - + + Generates an XML file containing the differences between the sandbox and + the project in the MKS database. + + + Get changes to a project in an MKS database. + + ]]> + - - The project to retrieve the changes for. - + + The project to retrieve the changes for. + - - The file where the output will be stored in XML format. - + + The file where the output will be stored in XML format. + @@ -1985,436 +1985,436 @@ - - Determines if the supplied version string is valid. A valid version string should look like: - 1 - 1.1 - 1.1.1 - 1.1.1.1 - - The version string to verify. - + + Determines if the supplied version string is valid. A valid version string should look like: + 1 + 1.1 + 1.1.1 + 1.1.1.1 + + The version string to verify. + - - Sets the sequence number of files to match their - storage order in the cabinet file, after some - files have had their filenames changed to go in - their own component. - - The MSI database. - The last file's sequence number. + + Sets the sequence number of files to match their + storage order in the cabinet file, after some + files have had their filenames changed to go in + their own component. + + The MSI database. + The last file's sequence number. - - Cleans the output directory after a build. - - The path to the cabinet file. - The path to temporary files. + + Cleans the output directory after a build. + + The path to the cabinet file. + The path to temporary files. - - Loads records for the Properties table. - - The MSI database. + + Loads records for the Properties table. + + The MSI database. - - Loads records for the Directories table. - - The MSI database. + + Loads records for the Directories table. + + The MSI database. - - Adds a directory record to the directories table. - - The MSI database. - The MSI database view. - The parent directory. - This directory's Schema object. - The tree depth of this directory. + + Adds a directory record to the directories table. + + The MSI database. + The MSI database view. + The parent directory. + This directory's Schema object. + The tree depth of this directory. - - Retrieves the relative path of a file based on - the component it belongs to and its entry in - the MSI directory table. - - The MSI database. - The Name of the Folder - The Parent of the Folder - The Relative Filesystem Path of the Folder - The Path to the Folder from previous calls. - The MSI database view. + + Retrieves the relative path of a file based on + the component it belongs to and its entry in + the MSI directory table. + + The MSI database. + The Name of the Folder + The Parent of the Folder + The Relative Filesystem Path of the Folder + The Path to the Folder from previous calls. + The MSI database view. - - If the specified path is longer than 40 characters, 37 are returned plus ... - - A shortened path - + + If the specified path is longer than 40 characters, 37 are returned plus ... + + A shortened path + - - Retrieves a DOS 8.3 filename for a file. - - The file to shorten. - The new shortened file. + + Retrieves a DOS 8.3 filename for a file. + + The file to shorten. + The new shortened file. - - Retrieves a DOS 8.3 filename for a directory. - - The path to shorten. - The new shortened path. + + Retrieves a DOS 8.3 filename for a directory. + + The path to shorten. + The new shortened path. - - Retrieves a DOS 8.3 filename for a complete directory. - - The path to shorten. - The new shortened path. + + Retrieves a DOS 8.3 filename for a complete directory. + + The path to shorten. + The new shortened path. - - Recursively expands properties of all attributes of - a nodelist and their children. - - The nodes to recurse. + + Recursively expands properties of all attributes of + a nodelist and their children. + + The nodes to recurse. - - Converts the Byte array in a public key - token of an assembly to a string MSI expects. - - The array of bytes. - The string containing the array. + + Converts the Byte array in a public key + token of an assembly to a string MSI expects. + + The array of bytes. + The string containing the array. - - Loads TypeLibs for the TypeLib table. - - The MSI database. + + Loads TypeLibs for the TypeLib table. + + The MSI database. - - Loads environment variables for the Environment table. - - The MSI database. + + Loads environment variables for the Environment table. + + The MSI database. - - Loads records for the Registry table. - - The MSI database. + + Loads records for the Registry table. + + The MSI database. - - Loads records for the RegLocator table - - The MSI database. + + Loads records for the RegLocator table + + The MSI database. - - Loads records for the CompLocator table - - The MSI database. + + Loads records for the CompLocator table + + The MSI database. - - Loads records for the IniLocator table - - The MSI database. + + Loads records for the IniLocator table + + The MSI database. - - Loads records for the DrLocator table - - The MSI database. - + + Loads records for the DrLocator table + + The MSI database. + - - Loads records for the RegLocator table - - The MSI database. + + Loads records for the RegLocator table + + The MSI database. - - Gets the name of the registry root id by it's name. - - Name of the registry root - + + Gets the name of the registry root id by it's name. + + Name of the registry root + - - Loads records for the AppSearch table - - The MSI database. + + Loads records for the AppSearch table + + The MSI database. - - Loads records for the Icon table. - - The MSI database. + + Loads records for the Icon table. + + The MSI database. - - Loads records for the Shortcut table. - - The MSI database. + + Loads records for the Shortcut table. + + The MSI database. - - Adds custom table(s) to the msi database - - The MSI database. + + Adds custom table(s) to the msi database + + The MSI database. - - Adds table data to the msi database table structure - - The MSI database. - The current table name - Xml node representing the current table - List of column objects for the current table (Containing: column name, id, type). + + Adds table data to the msi database table structure + + The MSI database. + The current table name + Xml node representing the current table + List of column objects for the current table (Containing: column name, id, type). - - Loads records for the Binary table. This table stores items - such as bitmaps, animations, and icons. The binary table is - also used to store data for custom actions. - - The MSI database. + + Loads records for the Binary table. This table stores items + such as bitmaps, animations, and icons. The binary table is + also used to store data for custom actions. + + The MSI database. - - Loads records for the Dialog table. - - The MSI database. + + Loads records for the Dialog table. + + The MSI database. - - Loads records for the Control table. - - The MSI database. + + Loads records for the Control table. + + The MSI database. - - Loads records for the ControlCondtion table. - - The MSI database. + + Loads records for the ControlCondtion table. + + The MSI database. - - Loads records for the ControlEvent table. - - The MSI database. + + Loads records for the ControlEvent table. + + The MSI database. - - Loads records for the CustomAction table - - The MSI database. + + Loads records for the CustomAction table + + The MSI database. - - Loads records for the ActionText table. Allows users to specify descriptions/templates for actions. - - The MSI database. + + Loads records for the ActionText table. Allows users to specify descriptions/templates for actions. + + The MSI database. - - Loads records for the _AppMappings table. - - The MSI database. + + Loads records for the _AppMappings table. + + The MSI database. - - Loads records for the _UrlToDir table. - "Load the url properties to convert - url properties to a properties object" ?? - - The MSI database. + + Loads records for the _UrlToDir table. + "Load the url properties to convert + url properties to a properties object" ?? + + The MSI database. - - Loads records for the _VDirToUrl table. - Used for converting a vdir to an url - - The MSI database. + + Loads records for the _VDirToUrl table. + Used for converting a vdir to an url + + The MSI database. - - Loads records for the _AppRootCreate table. - Used for making a virtual directory a virtual application - - The MSI database. + + Loads records for the _AppRootCreate table. + Used for making a virtual directory a virtual application + + The MSI database. - - Loads records for the _IISProperties table. - - The MSI database. + + Loads records for the _IISProperties table. + + The MSI database. - - Enumerates the registry to see if an assembly has been registered - for COM interop, and if so adds these registry keys to the Registry - table, ProgIds to the ProgId table, classes to the Classes table, - and a TypeLib to the TypeLib table. - - The MSI database. - The Assembly filename. - The Assembly to check. - The name of the containing component. - The name of the containing component's assembly GUID. - View containing the Class table. - View containing the ProgId table. + + Enumerates the registry to see if an assembly has been registered + for COM interop, and if so adds these registry keys to the Registry + table, ProgIds to the ProgId table, classes to the Classes table, + and a TypeLib to the TypeLib table. + + The MSI database. + The Assembly filename. + The Assembly to check. + The name of the containing component. + The name of the containing component's assembly GUID. + View containing the Class table. + View containing the ProgId table. - - Loads properties for the Summary Information Stream. - - The MSI database. + + Loads properties for the Summary Information Stream. + + The MSI database. - - Creates a .cab file with all source files included. - - The MSI database. + + Creates a .cab file with all source files included. + + The MSI database. - - Loads records for the sequence tables. - - The MSI database. + + Loads records for the sequence tables. + + The MSI database. - - Adds a file record to the Files table. - - The MSI database. - The MSI database view. - The Component's XML Element. - The MSI database view. - The directory of this file's component. - The name of this file's component. - The installation sequence number of this file. - View containing the MsiAssembly table. - View containing the MsiAssemblyName table. - View containing the Components table. - View containing the FeatureComponents table. - View containing the Class table. - View containing the ProgId table. - View containing the SelfReg table. - ModuleComponent table. + + Adds a file record to the Files table. + + The MSI database. + The MSI database view. + The Component's XML Element. + The MSI database view. + The directory of this file's component. + The name of this file's component. + The installation sequence number of this file. + View containing the MsiAssembly table. + View containing the MsiAssemblyName table. + View containing the Components table. + View containing the FeatureComponents table. + View containing the Class table. + View containing the ProgId table. + View containing the SelfReg table. + ModuleComponent table. - - Loads records for the Components table. - - The MSI database. - The sequence number of the last file in the .cab + + Loads records for the Components table. + + The MSI database. + The sequence number of the last file in the .cab - - Executes the Task. - - None. + + Executes the Task. + + None. - - .NET wrapper for a Windows Installer database - + + .NET wrapper for a Windows Installer database + - - Drops empty tables. - + + Drops empty tables. + - - Drops the empty tables. - - Determines if this is a merge module or not - If it is a merge module, the FeatureComponents table should not be dropped. + + Drops the empty tables. + + Determines if this is a merge module or not + If it is a merge module, the FeatureComponents table should not be dropped. - - Checks to see if the specified table is empty. - - Name of the table to check existance. - True if empy and False if full. + + Checks to see if the specified table is empty. + + Name of the table to check existance. + True if empy and False if full. - - Checks to see if the specified table exists in the database - already. - - Name of the table to check existance. - True if successful. + + Checks to see if the specified table exists in the database + already. + + Name of the table to check existance. + True if successful. - - Helper class used to avoid errors when instantiating - WindowsInstaller.Installer. - + + Helper class used to avoid errors when instantiating + WindowsInstaller.Installer. + - - Use to read and manipulate existing records. - + + Use to read and manipulate existing records. + - - Creates a new reader for the entries in the view - - Database view to read entries from. Must be Execute()'ed already. + + Creates a new reader for the entries in the view + + Database view to read entries from. Must be Execute()'ed already. - - Moves to the next record - - False iff no more records + + Moves to the next record + + False iff no more records - - Deletes the current record. Needs no Commit(). - + + Deletes the current record. Needs no Commit(). + - - Set the value of a field in the current record. Remember to Commit() - - Zero-based index of the field to set - New value + + Set the value of a field in the current record. Remember to Commit() + + Zero-based index of the field to set + New value - - Get the string value of a field in the current record. - - Zero-based index of the field to get + + Get the string value of a field in the current record. + + Zero-based index of the field to get - - Commits changes to the current record. - + + Commits changes to the current record. + - - A simple class for a single search clause. - TODO: more comparison types, use of the Composite pattern, etc. - + + A simple class for a single search clause. + TODO: more comparison types, use of the Composite pattern, etc. + - - Represents a single table in a Windows Installer archive - + + Represents a single table in a Windows Installer archive + - - Base class for msi/msm installer tasks - + + Base class for msi/msm installer tasks + @@ -2423,23 +2423,23 @@ - - Initializes the task and verifies parameters. - + + Initializes the task and verifies parameters. + - - Occurs when a validation error is raised. - - The object that sent the event. - Validation arguments passed in. + + Occurs when a validation error is raised. + + The object that sent the event. + Validation arguments passed in. - - Recursively expands properties of all attributes of - a nodelist and their children. - - The nodes to recurse. + + Recursively expands properties of all attributes of + a nodelist and their children. + + The nodes to recurse. @@ -2449,3171 +2449,145 @@ The object from the Schema wrapper after is called. - - The name of the file that will be generated when the task completes - execution (eg. MyInstall.msi or MyMergeModule.msm). - + + The name of the file that will be generated when the task completes + execution (eg. MyInstall.msi or MyMergeModule.msm). + - - A directory relative to the NAnt script in which the msi task resides - from which to retrieve files that will be installed by the msi - database. All files that will be included in your installation need - to be located directly within or in subdirectories of this directory. - + + A directory relative to the NAnt script in which the msi task resides + from which to retrieve files that will be installed by the msi + database. All files that will be included in your installation need + to be located directly within or in subdirectories of this directory. + - - A installer file to use as the starting database in which all files - and entries will be made, and then copied to the filename specified - by the output parameter. Install templates are included with the - install tasks, you only need to supply this value if you want to - override the default template. - + + A installer file to use as the starting database in which all files + and entries will be made, and then copied to the filename specified + by the output parameter. Install templates are included with the + install tasks, you only need to supply this value if you want to + override the default template. + - - A .mst file to use as the starting database containing strings - displayed to the user when errors occur during installation. - A .mst template is included with the msi task, you only need to - supply this value if you want to override the default error - template and cannot perform something through the features of the - msi task. - + + A .mst file to use as the starting database containing strings + displayed to the user when errors occur during installation. + A .mst template is included with the msi task, you only need to + supply this value if you want to override the default error + template and cannot perform something through the features of the + msi task. + - - Causes the generated msi database file to contain debug messages for - errors created by inconsistencies in creation of the database. This - makes the file slightly larger and should be avoided when generating - a production release of your software. - + + Causes the generated msi database file to contain debug messages for + errors created by inconsistencies in creation of the database. This + makes the file slightly larger and should be avoided when generating + a production release of your software. + - - - Sets various properties in the SummaryInformation stream - (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_information_stream.asp) - - - All of the sub-elements are optional. - -

Nested Elements:

-

<title>

-
    - Briefly describes the type of installer package. Phrases such as "Installation Database" or - "Transform" or "Patch" may be used for this property. -
    Default value: Value of the ProductName property, if defined. -
-

</title>

-

<subject>

-
    - A short description of the product to be installed. This value is typically set from the installer - property ProductName -
    Default value: Value of the ProductName property, if defined. -
-

</subject>

-

<author>

-
    - The manufacturer of the installation database. This value is typically set from the installer - property Manufacturer. -
    Default value: Value of the Manufacturer property, if defined. -
-

</author>

-

<keywords>

-
    - Used by file browsers to hold keywords that permit the database file to be found in a keyword search. - The set of keywords typically includes "Installer" as well as product-specific keywords, and may be - localized. -
    Default value: Value of the Keywords property, if defined. -
-

</keywords>

-

<comments>

-
    - A general description/purpose of the installer database. -
    Default value: Value of the Comments property, if defined. -
-

</comments>

-

<template>

-
    - - Indicates the platform and language versions that are supported by the database. The Template Summary - Property of a patch package is a semicolon-delimited list of the product codes that can accept the - patch. - - - See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/template_summary_property.asp for more information. - -
-

</template>

-

<revisionnumber>

-
    - Contains the package code (GUID) for the installer package. The package code is a unique identifier - of the installer package. Note: Default behavior - a new GUID is generated every time -
-

</revisionnumber>

-

<creatingapplication>

-
    - The name of the application used to author the database. Note: Default value is NAnt. -
-

</creatingapplication>

-

Examples

- - Define specific summary information. - - <summaryinformation> - <title>Installation Database</title> - <subject>${install.productname}</subject> - <author>${install.manufacturer}</author> - <keywords>MSI, database, NAnt, Installer</keywords> - <comments>This installer database contains the logic and data required to install NAnt</comments> - <template>;1033</template> - <creatingapplication>NAnt - http://nant.sf.net </creatingapplication> - </summaryinformation> - - - + + + Sets various properties in the SummaryInformation stream + (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_information_stream.asp) + + + All of the sub-elements are optional. + +

Nested Elements:

+

<title>

+
    + Briefly describes the type of installer package. Phrases such as "Installation Database" or + "Transform" or "Patch" may be used for this property. +
    Default value: Value of the ProductName property, if defined. +
+

</title>

+

<subject>

+
    + A short description of the product to be installed. This value is typically set from the installer + property ProductName +
    Default value: Value of the ProductName property, if defined. +
+

</subject>

+

<author>

+
    + The manufacturer of the installation database. This value is typically set from the installer + property Manufacturer. +
    Default value: Value of the Manufacturer property, if defined. +
+

</author>

+

<keywords>

+
    + Used by file browsers to hold keywords that permit the database file to be found in a keyword search. + The set of keywords typically includes "Installer" as well as product-specific keywords, and may be + localized. +
    Default value: Value of the Keywords property, if defined. +
+

</keywords>

+

<comments>

+
    + A general description/purpose of the installer database. +
    Default value: Value of the Comments property, if defined. +
+

</comments>

+

<template>

+
    + + Indicates the platform and language versions that are supported by the database. The Template Summary + Property of a patch package is a semicolon-delimited list of the product codes that can accept the + patch. + + + See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/template_summary_property.asp for more information. + +
+

</template>

+

<revisionnumber>

+
    + Contains the package code (GUID) for the installer package. The package code is a unique identifier + of the installer package. Note: Default behavior - a new GUID is generated every time +
+

</revisionnumber>

+

<creatingapplication>

+
    + The name of the application used to author the database. Note: Default value is NAnt. +
+

</creatingapplication>

+

Examples

+ + Define specific summary information. + + <summaryinformation> + <title>Installation Database</title> + <subject>${install.productname}</subject> + <author>${install.manufacturer}</author> + <keywords>MSI, database, NAnt, Installer</keywords> + <comments>This installer database contains the logic and data required to install NAnt</comments> + <template>;1033</template> + <creatingapplication>NAnt - http://nant.sf.net </creatingapplication> + </summaryinformation> + + + - - - Name/value pairs which will be set in the PROPERTY table of the - installer database. - - - The properties element contains within it one to any number of property elements.
- Public property names cannot contain lowercase letters.
- Private property names must contain some lowercase letters.
- Property names prefixed with % represent system and user environment variables. These are - never entered into the Property - table. The permanent settings of environment variables can only be modified using the Environment Table. - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the property. - True - - - value - string - The value of the property. This value can contain references to other, predefined properties to build a compound property. - True - - -

Examples

- - Define the required properties. - - <properties> - <property name="ProductName" value="My Product" /> - <property name="ProductVersion" value="1.0.0" /> - <property name="Manufacturer" value="ACME Inc." /> - <property name="ProductCode" value="{29D8F096-3371-4cba-87E1-A8C6511F7B4C}" /> - <property name="UpgradeCode" value="{69E66919-0DE1-4280-B4C1-94049F76BA1A}" /> - </properties> - - - - - - - - Contains within it one to any number of app, registry, ini, or dirfile elements. - These elements are used to search for an existing filesystem directory, file, or - Windows Registry setting. A property in the installer database is - then set with the value obtained from the search. - -

<app>

- - More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/complocator_table.asp - - - - Attribute - Type - Description - Required - - - componentid - string - The component ID of the component whose key path is to be used for the search. - True - - - type - msi:MSILocatorTypeDirFile - Valid input: file or directory - True - - - setproperty - string - A name used to refer to the property within the Msi database. Set at install time. - True - - -

</app>

-

<registry>

- - More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/reglocator_table.asp - - - - Attribute - Type - Description - Required - - - type - msi:MSILocatorTypeDirFileReg64 - Valid input: registry, file, directory, 64bit - True - - - path - string - Depending on the type specified: - - Path is a directory. - Path is a registry key. - - - True - - - root - msi:MSIRegistryKeyRoot - Valid input: - - dependent - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1. - machine represents HKEY_LOCAL_MACHINE - classes represents HKEY_CLASSES_ROOT - user represents HKEY_CURRENT_USER - users represents HKEY_USERS - - - True - - -
    -

    Nested Elements:

    -

    <value>

    -

    Parameters

    - - - Attribute - Type - Description - Required - - - name - string - Depending on the type specified: - - Key path is a file name. - Key path is a registry value. - - - False - - - setproperty - string - A name used to refer to the property within the Msi database. Set at install time. - True - - -

    </value>

    -
-

</registry>

-

<ini>

- - More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/inilocator_table.asp - - - - Attribute - Type - Description - Required - - - filename - string - The .ini file name. (The .ini file must be present in the default Microsoft Windows directory.) - - True - - - section - string - Section name within the .ini file. - - True - - - key - string - Key value within the section. - - True - - - field - msi:nonNegativeInt - The field in the .ini line. If Field is Null or 0, then the entire line is read. - This must be a non-negative number. - - False - - - type - msi:MSILocatorTypeDirFileRaw - Valid input: file ,directory, or raw - True - - - setproperty - string - A name used to refer to the property within the Msi database. Set at install time. - True - - -

</ini>

-

<dirfile>

- - More information on these attributes can be found at: - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/drlocator_table.asp - and - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/signature_table.asp - - - - Attribute - Type - Description - Required - - - parent - string - An identifier to RegLocator, IniLocator, or CompLocator tables. - If it does not expand to a full path, then all the fixed drives of the user's system are searched by using the Path. -
In order to determine what the key is for a table, prefix the property name assigned - to that locator with SIG_ - - False - - - path - string - the path on the user's system. This is a either a full path or a relative subpath - below the directory specified in the Parent column. - - False - - - depth - msi:nonNegativeInt - The depth below the path that the installer searches for the file or directory. - - False - - - setproperty - string - A name used to refer to the property within the Msi database. Set at install time. - True - - -
    -

    Nested Elements:

    -

    <file>

    -

    Parameters

    - - - Attribute - Type - Description - Required - - - name - string - The name of the file. - True - - - minversion - string - The minimum version of the file, with a language comparison. If this field is - specified, then the file must have a version that is at least equal to MinVersion. - If the file has an equal version to the MinVersion field value but the language - specified in the Languages column differs, the file does not satisfy the signature - filter criteria. - False - - - maxversion - string - The maximum version of the file. If this field is specified, then the file - must have a version that is at most equal to MaxVersion. - False - - - minsize - msi:nonNegativeInt - The minimum size of the file. If this field is specified, then the file - under inspection must have a size that is at least equal to MinSize. This must - be a non-negative number. - False - - - maxsize - msi:nonNegativeInt - The maximum size of the file. If this field is specified, then the file - under inspection must have a size that is at most equal to MaxSize. This must - be a non-negative number. - False - - - mindate - msi:nonNegativeInt - The minimum modification date and time of the file. If this field is - specified, then the file under inspection must have a modification date and time - that is at least equal to MinDate. This must be a non-negative number. - False - - - maxdate - msi:nonNegativeInt - The maximum creation date of the file. If this field is specified, then the - file under inspection must have a creation date that is at most equal to MaxDate. - This must be a non-negative number. - False - - - languages - string - The languages supported by the file. - False - - -

    </file>

    -
-

</dirfile>

-

Examples

- - Get the path of the web directory and the version of IIS. Create new properties in the Msi file with those values. - - <search> - <registry type="registry" path="Software\Microsoft\InetStp" root="machine" > - <value name="PathWWWRoot" setproperty="IISWWWROOT" /> - </registry> - <registry type="registry" path="SYSTEM\CurrentControlSet\Services\W3SVC\Parameters" root="machine" > - <value name="MajorVersion" setproperty="IISVERSION" /> - </registry> - </search> - - - - Shows two ways to get the default key value for the specified key. Create new properties in the Msi file with those values. - - <search> - <registry type="registry" path="Software\Microsoft\MessengerService" root="machine" > - <value setproperty="MSGSRVNAME" /> - <value name="" setproperty="MSGSRVNAME2" /> - </registry> - </search> - - - - - - - - Contains within it one to any number of launchcondition elements. - Launch conditions are conditions that all must be satisfied for the - installation to begin. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to identify the launch condition. - True - - - condition - string - Expression that must evaluate to True for installation to begin. - True - - -

Nested Elements:

-

<description>

-
    - Localizable text to display when the condition fails and the installation must be terminated. -
-

</description>

-

Examples

- - Create a check to make sure that IIS 5.x is installed. - - <launchconditions> - <launchcondition name="CheckIIS" condition="(IISVERSION = &quot;#5&quot;)" > - <description> - This setup requires Internet information Server 5.x. Please install Internet Information Server and run this setup again. - </description> - </launchcondition> - </launchconditions> - - - - - - - - Creates custom tables not directly managed by default features of - the installer task. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A unique name used to identify the table. - True - - -

Nested Elements:

-

<columns>

-
    -

    <column>

    -
      - Defines the columns making up the table -

      Parameters

      - - - Attribute - Type - Description - Required - - - name - string - A unique name used to define the column. - True - - - nullable - bool - When set to true, allows the column to accept null values; false does not allow null values. - True - - - category - msi:MSITableColumnCategoryType - Valid input: - - Text - UpperCase - LowerCase - Integer - DoubleInteger - Time/Date - Identifier - Property - Filename - WildCardFilename - Path - Paths - AnyPath - DefaultDir - RegPath - Formatted - Template - Condition - GUID - Version - Language - Binary - Cabinet - Shortcut - - More information here: http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp - - False - - - type - string - Overrides the category specification. An example of valid input would be: S255 - False - - - key - bool - When set to true, the column is used to form the primary key for the table; false specifies that the column is not used to form the primary key. - False - - - minvalue - int - This field applies to columns having numeric value. The field contains the minimum permissible value. This can be the minimum value for an integer or the minimum value for a date or version string. - False - - - maxvalue - int - This field applies to columns having numeric value. The field is the maximum permissible value. This may be the maximum value for an integer or the maximum value for a date or version string. - False - - - keytable - string - This field applies to columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. This can be a list of tables separated by semicolons. - False - - - keycolumn - int - This field applies to table columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. The permissible range of the KeyColumn field is 1-32. - False - - - set - string - This is a list of permissible values for this field separated by semicolons. This field is usually used for enums. - False - - - description - string - A description of the data that is stored in the column. - False - - -
    -

    </column>

    -
-

</columns>

-

<rows>

-
    -

    <row>

    -
      - Defines the data for a row in the table -

      <columns>

      -
        -

        <column>

        -
          - Defines data for a specific cell in the row -

          Parameters

          - - - Attribute - Type - Description - Required - - - name - string - Name of the column to populate. - True - - - value - string - Value to populate the cell with. - True - - -
        -

        </column>

        -
      -

      </columns>

      -
    -

    </row>

    -
-

</rows>

-

Examples

- - - Build the IniFile table. Since the WriteIniValues and RemoveIniValues actions exist in the template, they will use this table. - - - <tables> - <table name="IniFile"> - <columns> - <column name="IniFile" nullable="false" category="Identifier" key="true" description="The key for this table." /> - <column name="FileName" nullable="false" category="Text" description="The localizable name of the .ini file in which to write the information. " /> - <column name="DirProperty" nullable="true" category="Identifier" description="Name of a property having a value that resolves to the full path of the folder containing the .ini file. " /> - <column name="Section" nullable="false" category="Formatted" description="The localizable .ini file section." /> - <column name="Key" nullable="false" category="Formatted" description="The localizable .ini file key within the section" /> - <column name="Value" nullable="false" category="Formatted" description="The localizable value to be written. " /> - <column name="Action" nullable="false" category="Integer" description="The type of modification to be made. " /> - <column name="Component_" nullable="false" category="Identifier" description="External key into the first column of the Component table referencing the component that controls the installation of the .ini value. " /> - </columns> - <rows> - <row> - <columns> - <column name="IniFile" value="MyInternetShortcut" /> - <column name="FileName" value="MyInternetAddr.url" /> - <column name="DirProperty" value="D__MYDIR" /> - <column name="Section" value="InternetShortcut" /> - <column name="Key" value="URL" /> - <column name="Value" value="[TARGETURL]" /> - <column name="Action" value="0" /> - <column name="Component_" value="C__Documentation" /> - </columns> - </row> - </rows> - </table> - </tables> - - - - - - - - Specifies the directory layout for the product. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the directory. - True - - - foldername - string - The directory's name (localizable)under the parent directory. - True - - - root - string - A reference to the directory's parent directory. This can be a property name or one of the predefined directories included with the default template: - - AdminToolsFolder - AppDataFolder - CommonAppDataFolder - CommonFiles64Folder - CommonFilesFolder - DesktopFolder - FavoritesFolder - FontsFolder - LocalAppDataFolder - MyPicturesFolder - PersonalFolder - ProgramFilesFolder - ProgramMenuFolder - ProgramFiles64Folder - SendToFolder - StartMenuFolder - StartupFolder - System16Folder - System64Folder - SystemFolder - TARGETDIR - TempFolder - TemplateFolder - WindowsFolder - WindowsVolume - - - True - - -

Nested Elements:

-

<directory>

-
    - Sub directories. Note, this element can contain nested <directory/> sub elements. -

    Parameters

    - - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the directory. - True - - - foldername - string - The directory's name (localizable)under the parent directory. - True - - -
-

</directory>

-

Examples

- - Define a sample directory structure. - - <directories> - <directory name="D__ACME" foldername="ACME" root="TARGETDIR" > - <directory name="D__ACME_MyProduct" foldername="My Product" /> - </directory> - </directories> - - - - - - - - Used to modify the environment variables of the target computer at - runtime. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - The localizable name of the environment variable. The key values are written or removed depending upon - which of the characters in the following table are prefixed to the name. There is no effect in the ordering of - the symbols used in a prefix. - - - Prefix - Description - - - = - Create the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation. - - - + - Create the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists. - - - - - Remove the environment variable when the component is removed. This symbol can be combined with any prefix. - - - ! - Remove the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty. - - - * - This prefix is used with Microsoft® Windows® NT/Windows® 2000 to indicate that the name refers to a system environment variable. If no asterisk is present, the installer writes the variable to the user's environment. Microsoft Windows 95/98 ignores the asterisk and add the environment variable to autoexec.bat. This symbol can be combined with any prefix. A package that is used for per-machine installations should write environment variables to the machine's environment by including * in the Name column. For more information, see http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp - - - =- - The environment variable is set on install and removed on uninstall. This is the usual behavior. - - - !- - Removes an environment variable during an install or uninstall. - - - More information can be found here: http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp - - True - - - append - string - Localizable value that is to be set as a formatted string - True - - - component - string - Refrence to a component. Allows the variabled to be modified when the component is un/installed. - True - - -

Examples

- - Append the installation path to the user PATH variable. - - <environment> - <variable name="PATH" append="'[TARGETDIR]'" component="C__MainFiles" /> - </environment> - - - - - - - - Groups sets of files into named sets, these can be used to install - and perform operations on a set of files as one entity. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the component. - True - - - id - string - A string GUID unique to this component, version, and language.
Note that the letters of these GUIDs must be - uppercase. Utilities such as GUIDGEN can generate GUIDs containing lowercase letters. The lowercase letters must be - changed to uppercase to make these valid component code GUIDs. - - True - - - attr - int - This column contains a bit flag that specifies options for remote execution. Add the indicated bit to the total value in the column to include an option. - - - Value - Description - - - 0 - Component cannot be run from source.
- Set this bit for all components belonging to a feature to prevent the feature from being run-from-network or - run-from-source. Note that if a feature has no components, the feature always shows run-from-source and - run-from-my-computer as valid options. - - - - 1 - Component can only be run from source.
- Set this bit for all components belonging to a feature to prevent the feature from being run-from-my-computer. - Note that if a feature has no components, the feature always shows run-from-source and run-from-my-computer as - valid options. - - - - 2 - Component can run locally or from source. - - - 4 - If this bit is set, the value in the key element is used as a key into the Registry table.
- If the Value field of the corresponding record in the Registry table is null, the Name field in that record must - not contain "+", "-", or "*". For more information, see the description of the Name field in Registry table.
- Setting this bit is recommended for registry entries written to the HKCU hive. This ensures the installer writes - the necessary HKCU registry entries when there are multiple users on the same machine. - - - - 16 - If this bit is set, the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings. - - - - 32 - If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table. - - - 64 - If this bit is set, the installer reevaluates the value of the statement in the Condition column - upon a reinstall. If the value was previously False and has changed to True, the installer installs the component. - If the value was previously True and has changed to False, the installer removes the component even if the component - has other products as clients.
This bit should only be set for transitive components. See Using Transitive - Components. - - - - 128 - If this bit is set, the installer does not install or reinstall the component if a key path file or - a key path registry entry for the component already exists. The application does register itself as a client of - the component.
- Use this flag only for components that are being registered by the Registry table. - - - - 256 - Set this bit to mark this as a 64-bit component. This attribute facilitates the installation of - packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered - as a 32-bit component. - - - - - True - - - directory - string - Refrence to a directory. Defines the directory location for where the files assigned to the component are to be placed. - True - - - feature - string - Refrence to a feature. Maps a feature to the component. Used to determine if the component is to be installed or not. - True - - - condition - string - A conditional statement that can control whether a component is installed. If the condition is null or evaluates to - true, then the component is enabled. If the condition evaluates to False, then the component is disabled and is not - installed. - False - - - fileattr - int - Integer containing bit flags representing file attributes.
- The following table shows the definition of the bit field. - - - Value - Description - - - 1 - Read-Only - - - 2 - Hidden - - - 4 - System - - - 512 - The file is vital for the proper operation of the component to which it belongs - - - 1024 - The file contains a valid checksum. A checksum is required to repair a file that has become corrupted. - - - 4096 - This bit must only be added by a patch and if the file is being added by the patch. - - - 8192 - The file's source type is uncompressed. If set, ignore the Word Count Summary Property. - If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression - state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed - and msidbFileAttributesCompressed. - - - 16384 - The file's source type is compressed. If set, ignore the Word Count Summary Property. - If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of - the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and - msidbFileAttributesCompressed. - - - - False - - - checkinterop - bool - Used to determine if file(s) in the fileset are interop file(s). If true, extra information will be added in the install - package to register each interop file. If false, the file(s) will not be not be checked and the extra registration information - will not be added to the msi. - False - - - installassembliestogac - bool - Used to determine if assemblies should be installed to the Global Assembly Cache. - If true, all assemblies in the fileset will be added to the GAC. If false, the assemblies will be installed - to the specified directory (as a normal file would). Note: If an assembly is specified to be installed into the GAC, it will not - also be installed to the directory specified. - False - - - keepsubdirs - bool - Used to determine if directories in the fileset should be built. - If true, all subdirectories of the fileset basedir will be built. If false the directories structure will be - flattened. The default is false. - False - - -

Nested Elements:

-

<keyfile>

-
    - This value points to a file or folder belonging to the component that the installer uses to detect the component. Two components cannot share the same key path value. -

    Parameters

    - - - Attribute - Type - Description - Required - - - file - string - Name of the key (file) to use. Also, this could be an id of a registry key value. - True - - -
-

</keyfile>

-

<fileset>

-
    - Specifies the files to include with the component -
-

</fileset>

-

<forceid>

-
    - Used to force specific attributes on a per file basis -

    Parameters

    - - - Attribute - Type - Description - Required - - - file - string - Name of the file, in the fileset, to override. - True - - - id - string - Unique GUID to assign to the file. - True - - - attr - int - Integer containing bit flags representing file attributes.
    - The following table shows the definition of the bit field. - - - Value - Description - - - 1 - Read-Only - - - 2 - Hidden - - - 4 - System - - - 512 - The file is vital for the proper operation of the component to which it belongs - - - 1024 - The file contains a valid checksum. A checksum is required to repair a file that has become corrupted. - - - 4096 - This bit must only be added by a patch and if the file is being added by the patch. - - - 8192 - The file's source type is uncompressed. If set, ignore the Word Count Summary Property. - If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression - state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed - and msidbFileAttributesCompressed. - - - 16384 - The file's source type is compressed. If set, ignore the Word Count Summary Property. - If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of - the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and - msidbFileAttributesCompressed. - - -     - False -     - - version - string - This field is the version string for a versioned file. This field is blank for non-versioned files. - False - - - language - string - A list of decimal language IDs separated by commas. - False - - - checkinterop - bool - Used to determine if file is an interop file. If true, extra information will be added in the install - package to register the interop file. If false, the file will not be not be checked and the extra registration information - will not be added to the msi. - False - - - installtogac - bool - If true, and if the file is an assembly, it will be installed to the GAC. If false, the file - will be installed to the directory specified by the component. Note: If an assembly is specified to - be installed into the GAC, it will not also be installed to the directory specified. - False - -     -
-

</forceid>

-

Examples

- - Define a sample component structure. - - <components> - <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" > - <key file="default.aspx" /> - <fileset basedir="${install.dir}"> - <include name="*.*" /> - </fileset> - </component> - </components> - - - - Install files to TARGETDIR and assemblies to the GAC (Global Assembly Cache). Do not install MyOtherAssembly.dll to the GAC, but rather install it with the other files (to TARGETDIR) - - <components> - <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" installassembliestogac="true" > - <key file="MyAssemblyName.xml" /> - <fileset basedir="${install.dir}"> - <include name="*.*" /> - </fileset> - <forceid file="MyOtherAssembly.dll" id="_4EB7CCB23D394958988ED817DA00B9D1" installtogac="false" /> - </component> - </components> - - - - Assign a registry entry to a specific component. - - <components> - <component name="C__RegistryEntry" id="{06C654AA-273D-4E39-885C-3E5225D9F336}" attr="4" directory="TARGETDIR" feature="F__DefaultFeature" > - <key file="R__822EC365A8754FACBF6C713BFE4E57F0" /> - </component> - </components> - . - . - . - <registry> - <key path="SOFTWARE\MyCompany\MyProduct\" root="machine" component="C__RegistryEntry"> - <value id="R__822EC365A8754FACBF6C713BFE4E57F0" name="MyKeyName" value="MyKeyValue" /> - </key> - </registry> - - - - - - - - Creates custom dialogs that can gather information not handled by - the default installer template. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the dialog. - True - - - hcenter - int - Horizontal position of the dialog box. The range is 0 to 100, with 0 at the left edge of the screen and 100 at the right edge. - True - - - vcenter - int - Vertical position of the dialog box. The range is 0 to 100, with 0 at the top edge of the screen and 100 at the bottom edge. - True - - - width - int - Width of the rectangular boundary of the dialog box. This number must be non-negative. - True - - - height - int - Height of the rectangular boundary of the dialog box. This number must be non-negative. - True - - - attr - int - A 32-bit word that specifies the attribute flags to be applied to this dialog box. This number must be non-negative. - - - Value - Description - - - 1 - Visible - - - 2 - Modal - - - 4 - Minimize - - - 8 - SysModal - - - 16 - KeepModeless - - - 32 - TrackDiskSpace - - - 64 - UseCustomPalette - - - 128 - RTLRO - - - 256 - RightAligned - - - 512 - LeftScroll - - - 896 - BiDi - - - 65536 - Error - - - More information here: http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp - - True - - - title - string - A localizable text string specifying the title to be displayed in the title bar of the dialog box. - True - - - firstcontrol - string - An external key to the second column of the Control table. Combining this field with the Dialog field identifies a - unique control in the Control table. This defines the control that takes the focus when the dialog box is created. This - column is ignored in an Error dialog box.
- Because static text cannot take the focus, a Text control that describes an Edit, PathEdit, ListView, ComboBox or - VolumeSelectCombo control must be made the first control in the dialog box to ensure compatibility with screen readers. - - True - - - defaultcontrol - string - An external key to the second column of the Control table. Combining this field with the Dialog field results in - a primary key into the Control table that defines the default control. Hitting the Return key is equivalent to clicking - on the default control. If this column is left blank, then there is no default control. This column is ignored in the - Error dialog box. - - True - - - cancelcontrol - string - An external key to the second column of the Control table. Combining this field with the Dialog field results in - a primary key of the Control table that defines the cancel control. Hitting the ESC key or clicking the Close button in - the dialog box is equivalent to clicking on the cancel control. This column is ignored in an Error dialog box.
- The cancel control is hidden during rollback or the removal of backed up files. The protected UI handler hides the control - upon receiving a INSTALLMESSAGE_COMMONDATA message. - - True - - -

Examples

- - Add a web folder dialog: - - <dialogs> - <dialog name="WebFolderDlg" hcenter="50" vcenter="50" width="370" height="270" attr="39" title="[ProductName] [Setup]" firstcontrol="Next" defaultcontrol="Next" cancelcontrol="Cancel" /> - </dialogs> - - - - - - - - Creates user interface controls displayed on custom dialogs. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes. - True - - - dialog - string - Refrence to a dialog. Used to associate the control with the dialog. - True - - - type - string - The type of the control. - - - Control name - Description - - - Billboard - Displays billboards based on progress messages. - - - Bitmap - Displays a static picture of a bitmap. - - - CheckBox - A two-state check box. - - - ComboBox - A drop-down list with an edit field. - - - DirectoryCombo - Select all except the last segment of the path. - - - DirectoryList - Displays folders below the main part of path. - - - Edit - A regular edit field for any string or integer. - - - GroupBox - Displays a rectangle that groups other controls together. - - - Icon - Displays a static picture of an icon. - - - Line - Displays a horizontal line. - - - ListBox - A drop-down list without an edit field. - - - ListView - Displays a column of values with icons for selection. - - - MaskedEdit - An edit field with a mask in the text field. - - - PathEdit - Displays folder name or entire path in an edit field. - - - ProgressBar - Bar graph that changes length as it receives progress messages. - - - PushButton - Displays a basic push button. - - - RadioButtonGroup - A group of radio buttons. - - - ScrollableText - Displays a long string of text. - - - SelectionTree - Displays information from the Feature table and enables the user to change their selection state. - - - Text - Displays static text. - - - VolumeCostList - Displays costing information on different volumes. - - - VolumeSelectCombo - Selects volume from an alphabetical list. - - - More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp - True - - - x - int - Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. - True - - - y - int - Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. - True - - - width - int - Width of the rectangular boundary of the control. This must be a non-negative number. - True - - - height - int - Height of the rectangular boundary of the control. This must be a non-negative number. - True - - - attr - int - A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see Control Attributes. - True - - - property - string - The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls. - False - - - text - string - A localizable string used to set the initial text contained in a control. The string can also contain embedded properties. - False - - - nextcontrol - string - The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. - False - - - help - string - Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present. - False - - - remove - bool - If true, the control is removed. If false, the control is added. - False - - -

Examples

- - Remove the Browse button from the customize dialog and add controls for a web dialog - - <controls> - <!-- Remove the Browse button from customize dialog --> - <control dialog="CustomizeDlg" name="Browse" type="PushButton" - x="304" y="200" width="56" height="17" attr="3" remove="true" /> - <control dialog="CustomizeDlg" name="Tree" type="SelectionTree" - x="25" y="85" width="175" height="95" attr="7" remove="true" /> - <!-- Re add the tree control with the proper next control --> - <control dialog="CustomizeDlg" name="Tree" type="SelectionTree" - x="25" y="85" width="175" height="95" attr="7" - property="_BrowseProperty" text="Tree of selections" nextcontrol="Reset" /> - <!-- Adds the controls associated with the webfolder dialog --> - <control dialog="WebFolderDlg" name="BannerBitmap" type="Bitmap" - x="0" y="0" width="374" height="44" attr="1" - text="[BannerBitmap]" nextcontrol="VDirLabel" /> - <control dialog="WebFolderDlg" name="Title" type="Text" - x="15" y="6" width="200" height="15" attr="196611" - text="[DlgTitleFont]Virtual Directory Information" /> - <control dialog="WebFolderDlg" name="Description" type="Text" - x="25" y="23" width="280" height="15" attr="196611" - text="Please enter your virtual directory and port information." /> - <control dialog="WebFolderDlg" name="BannerLine" type="Line" - x="0" y="44" width="374" height="0" attr="1" /> - <control dialog="WebFolderDlg" name="VDirLabel" type="Text" - x="18" y="73" width="348" height="15" attr="3" - text="&Virtual directory:" - nextcontrol="Edit_VDir" /> - <control dialog="WebFolderDlg" name="Edit_VDir" type="Edit" - x="18" y="85" width="252" height="18" attr="7" - property="TARGETVDIR" - text="[TARGETVDIR]" - nextcontrol="PortLabel" /> - <control dialog="WebFolderDlg" name="PortLabel" type="Text" - x="18" y="110" width="348" height="15" attr="3" - text="&Port:" - nextcontrol="Edit_Port" /> - <control dialog="WebFolderDlg" name="Edit_Port" type="Edit" - x="18" y="122" width="48" height="18" attr="7" - property="TARGETPORT" - text="[TARGETPORT]" - nextcontrol="Back" /> - <control dialog="WebFolderDlg" name="BottomLine" type="Line" - x="0" y="234" width="374" height="0" attr="1" /> - <control dialog="WebFolderDlg" name="Back" type="PushButton" - x="180" y="243" width="56" height="17" attr="3" - text="[ButtonText_Back]" nextcontrol="Next" /> - <control dialog="WebFolderDlg" name="Next" type="PushButton" - x="236" y="243" width="56" height="17" attr="3" - text="[ButtonText_Next]" nextcontrol="Cancel" /> - <control dialog="WebFolderDlg" name="Cancel" type="PushButton" - x="304" y="243" width="56" height="17" attr="3" - text="[ButtonText_Cancel]" nextcontrol="BannerBitmap" /> - </controls> - - - - - - - - Used to validate and perform operations as the result of information - entered by the user into controls on custom dialogs. - -

Parameters

- - - Attribute - Type - Description - Required - - - dialog - string - Refrence to a dialog. Used to associate the control with the dialog. - True - - - control - string - Refrence to a control. Maps to a control for the specified dialog. - True - - - action - string - The action that is to be taken on the control. The possible actions are shown in the following table. - - - Value - Description - - - Default - Set control as the default. - - - Disable - Disable the control. - - - Enable - Enable the control. - - - Hide - Hide the control. - - - Show - Display the control. - - - - True - - - condition - string - A conditional statement that specifies under which conditions the action should be triggered. If this statement does not evaluate to TRUE, the action does not take place. If it is set to 1, the action is always applied. - True - - - remove - bool - If true, the control condition is removed. If false, the control condition is added. - False - - -

Examples

- - Remove the control condition for the Browse button from the customize dialog and add control conditions for a web dialog - - <controlconditions> - <!-- Remove control condition for Browse button on customizeDlg --> - <controlcondition dialog="CustomizeDlg" control="Browse" action="Hide" - condition="Installed" remove="true" /> - <!-- Add control conditions for the web folder dialog --> - <controlcondition dialog="WebFolderDlg" control="Back" action="Disable" - condition="ShowUserRegistrationDlg=""" /> - <controlcondition dialog="WebFolderDlg" control="Back" action="Enable" - condition="ShowUserRegistrationDlg<>""" /> - </controlconditions> - - - - - - - - Used to route the flow of the installation process as the result of - events raised by the user interacting with controls on dialogs. - -

Parameters

- - - Attribute - Type - Description - Required - - - dialog - string - Refrence to a dialog. Used to associate the control with the dialog. - True - - - control - string - Refrence to a control. Maps to a control for the specified dialog. - True - - - name - string - An identifier that specifies the type of event that should take place when the user interacts with the control - specified by Dialog_ and Control_. For a list of possible values see ControlEvent Overview.
- To set a property with a control, put [Property_Name] in this field and the new value in the argument field. Put { } - into the argument field to enter the null value. - - True - - - argument - string - A value used as a modifier when triggering a particular event. - True - - - condition - string - A conditional statement that determines whether the installer activates the event in the Event column. The installer - triggers the event if the conditional statement in the Condition field evaluates to True. Therefore put a 1 in this column - to ensure that the installer triggers the event. The installer does not trigger the event if the Condition field contains - a statement that evaluates to False. The installer does not trigger an event with a blank in the Condition field unless no - other events of the control evaluate to True. If none of the Condition fields for the control named in the Control_ field - evaluate to True, the installer triggers the one event having a blank Condition field, and if more than one Condition field - is blank it triggers the one event of these with the largest value in the Ordering field. - False - - - order - int - An integer used to order several events tied to the same control. This must be a non-negative number. - False - - - remove - bool - If true, the control condition is removed. If false, the control condition is added. - False - - -

Examples

- - Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog - - - <controlevents> - <!-- Remove the old control events --> - <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" - argument="SetupTypeDlg" condition="ProductID" remove="true" /> - <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" - argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg <> 1" remove="true" /> - <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" - argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg = 1" remove="true" /> - <!-- Remove control events for Browse button on CustomizeDlg --> - <controlevent dialog="CustomizeDlg" control="Browse" name="SelectionBrowse" - argument="BrowseDlg" condition="1" remove="true" /> - <!-- Add new control events for the web dialog --> - <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" - argument="WebFolderDlg" condition="ProductID" /> - <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" - argument="WebFolderDlg" condition="ShowWebFolderDlg <> 1" /> - <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" - argument="WebFolderDlg" condition="ShowWebFolderDlg = 1" /> - <controlevent dialog="WebFolderDlg" control="Cancel" name="SpawnDialog" - argument="CancelDlg" order="0" /> - <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" - argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg<>1" - order="0" /> - <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" - argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg=1" - order="0" /> - <!-- Virtual Directory Control Events --> - <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" - argument="WEBCA_CreateURLs" condition="1" order="0" /> - <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" - argument="WEBCA_EvaluateURLsMB" condition="1" order="1" /> - <controlevent dialog="WebFolderDlg" control="Next" name="SetTargetPath" - argument="TARGETDIR" condition="1" order="2" /> - <controlevent dialog="WebFolderDlg" control="Next" name="NewDialog" - argument="SetupTypeDlg" condition="1" order="3" /> - </controlevents> - - - - - - - - Makes modifications to the Windows Registry of the target computer - at runtime. - -

Parameters

- - - Attribute - Type - Description - Required - - - component - string - Refrence to a component. The component that controls the installation of the registry value. - True - - - root - msi:MSIRegistryKeyRoot - Valid input: - - dependent - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1. - machine represents HKEY_LOCAL_MACHINE - classes represents HKEY_CLASSES_ROOT - user represents HKEY_CURRENT_USER - users represents HKEY_USERS - - - True - - - path - string - Registry key. - True - - -

Nested Elements:

-

<value>

-
    - Specifies the registry value to add to the target machine. - - - Attribute - Type - Description - Required - - - name - string - The registry value name (localizable). If this is Null, then the data entered into the Value column are - written to the default registry key.
    - If the Value column is Null, then the strings shown in the following table in the Name column have special - significance. - - - String - Description - - - + - The key is to be created, if absent, when the component is installed. - - - - - The key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled. - - - * - The key is to be created, if absent, when the component is installed. Additionally, the key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled. - - -     - False -     - - value - string - The localizable registry value. The field is Formatted. If the value is attached to one of the following prefixes (i.e. #%value) then the value is interpreted as described in the table. Note that each prefix begins with a number sign (#). If the value begins with two or more consecutive number signs (#), the first # is ignored and value is interpreted and stored as a string. - - - Prefix - Description - - - #x - The value is interpreted and stored as a hexadecimal value (REG_BINARY). - - - #% - The value is interpreted and stored as an expandable string (REG_EXPAND_SZ). - - - # - The value is interpreted and stored as an integer (REG_DWORD). - - - - If the value contains the sequence tilde [~], then the value is interpreted as a Null-delimited list of strings (REG_MULTI_SZ). For example, to specify a list containing the three strings a, b and c, use "a[~]b[~]c." - The sequence [~] within the value separates the individual strings and is interpreted and stored as a Null character. - If a [~] precedes the string list, the strings are to be appended to any existing registry value strings. If an appending string already occurs in the registry value, the original occurrence of the string is removed. - If a [~] follows the end of the string list, the strings are to be prepended to any existing registry value strings. If a prepending string already occurs in the registry value, the original occurrence of the string is removed. - If a [~] is at both the beginning and the end or at neither the beginning nor the end of the string list, the strings are to replace any existing registry value strings. - Otherwise, the value is interpreted and stored as a string (REG_SZ). - - - False - - - dword - string - A dword value to input, if the value attribute is null. This removes the requirement of adding "#" before the value. - False - - - id - string - Primary key used to identify a registry record. - False - -     -
-

</value>

-

Examples

- - Add the a couple registry entries on the target machine. - - <registry> - <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > - <value name="ProductVersion" value="1.0.0" /> - <value name="ProductDir" value="[TARGETDIR]" /> - <value name="VirtualDir" value="[TARGETVDIR]" /> - </key> - </registry> - - - - Add a default key value to the specified registry key path - - <registry> - <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > - <value value="1.0.0" /> - </key> - </registry> - - - - Another way to add a default key value to the specified registry key path - - <registry> - <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > - <value name="" value="1.0.0" /> - </key> - </registry> - - - - Specify hexadecimal value (REG_BINARY) for the default key - - <registry> - <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > - <value> - 1a,81,0a,03,01,00,06,00,00,00,d3,15,fd,00,01,00,00,00,00,00,01, - 00,00,00,00,00,00,00,00,00,00,00,b0,90,ce,09,01,00,00,00,00,00,ff,ff,ff,00, - 00,00,00,00,00,00,00,00,6d,7a,0a,03,01,00,00,00,00,00,00,00,38,40,00,00,00, - 00,00,00,00,00,00,00,00,00,90,01,00,00,00,00,00,01,00,00,00,00,0f,00,00,00, - f0,ff,ff,ff,54,69,6d,65,73,20,4e,65,77,20,52,6f,6d,61,6e,f4,6f,d4,08,02,00 - </value> - </key> - </registry> - - - - - - - - Stores icons to be used with shortcuts, file extensions, CLSIDs or - similar uses. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Name of the icon file. - True - - - value - string - The binary icon data in PE (.dll or .exe) or icon (.ico) format. - True - - -

Examples

- - Add a compiled help icon to the msi database; To be used with a shortcut. - - <icons> - <icon name="CHMICON" value="${resource.dir}\chm.ico" /> - </icons> - - - - - - - - Creates shortcuts on the target computer. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Unique name identifying the shortcut. - True - - - directory - string - Reference to a directory. The location of where the shortcut should be created. - True - - - filename - string - The localizable name of the shortcut to be created. - True - - - component - string - Reference to a component. The installer uses the installation state of this specified component to determine whether the shortcut is created or deleted. This component must have a valid key path for the shortcut to be installed. If the Target column contains the name of a feature, the file launched by the shortcut is the key file of the component listed in this column. - True - - - target - string - The shortcut target. The installer evaluates this field as a Formatted string. The field should contains a property identifier enclosed by square brackets ([ ]), that is expanded into the file or a folder pointed to by the shortcut. - True - - - arguments - string - The command-line arguments for the shortcut.
Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved if the property already has the intended value when the component owning the shortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the file MyDoc.doc and the component that owns the shortcut. - - False - - - hotkey - string - The hotkey for the shortcut. The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags. This must be a non-negative number. Authors of installation packages are generally recommend not to set this option, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for users using hotkeys for accessibility. - False - - - icon - string - Reference to an icon. - False - - - iconindex - int - The icon index for the shortcut. This must be a non-negative number. - False - - - showcmd - int - The Show command for the application window.
The following values may be used. The values are as defined for the Windows API function ShowWindow. - - - Value - Description - - - 1 - SW_SHOWNORMAL - - - 3 - SW_SHOWMAXIMIZED - - - 7 - SW_SHOWMINNOACTIVE - - - - False - - - wkdir - string - The name of the property that has the path of the working directory for the shortcut. - False - - -

Nested Elements:

-

<description>

-
    - The localizable description of the shortcut. -
-

</description>

-

Examples

- - Add a compiled help icon to the msi database; To be used with a shortcut. - - <shortcuts> - <shortcut name="HelpFiles" directory="D__PROGRAMMENU_ACME_MYPRODUCT" filename="Help File" component="C__MainFiles" target="[$C__MainFiles]\Help.chm" icon="CHMICON" iconindex="0" showcmd="3" > - <description>My Product help documentation</description> - </shortcut> - </shortcuts> - - - - - - - - Stores the binary data for items such as bitmaps, animations, and - icons. The binary table is also used to store data for custom - actions. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A unique key that identifies the particular binary data. If the binary data is for a control, the key appears in the Text column of the associated control in the Control table. This key must be unique among all controls requiring binary data. - True - - - value - string - The binary file to add. - True - - -

Examples

- - Add the custom action dll to create/modify virtual directories - - <binaries> - <binary name="MSVBDPCADLL" value="${resource.dir}\MSVBDPCA.DLL" /> - </binaries> - - - - - - - - Used to configure executables that may be run during steps in the - installation process to do things outside the bounds of MSI - technology's feature set. This is the main spot you can extend MSI - technology to perform custom processes via compiled code. - -

Parameters

- - - Attribute - Type - Description - Required - - - action - string - Name of the action. The action normally appears in a sequence table unless it is called by another custom action. If the name matches any built-in action, then the custom action is never called. - True - - - type - string - A field of flag bits specifying the basic type of custom action and options. See Summary List of All Custom Action Types for a list of the basic types. See Custom Action Return Processing Options, Custom Action Execution Scheduling Options, Custom Action Hidden Target Option, and Custom Action In-Script Execution Options. - True - - - source - string - A property name or external key into another table. For a discussion of the possible custom action sources, see Custom Action Sources and the Summary List of All Custom Action Types. For example, the Source column may contain an external key into the first column of one of the following tables containing the source of the custom action code.
- Directory table for calling existing executables.
- File table for calling executables and DLLs that have just been installed.
- Binary table for calling executables, DLLs, and data stored in the database.
- Property table for calling executables whose paths are held by a property. - - True - - - target - string - An execution parameter that depends on the basic type of custom action. See the Summary List of All Custom Action Types for a description of what should be entered in this field for each type of custom action. For example, this field may contain the following depending on the custom action. - - - Target - Custom Action - - - Entry point (required) - Calling a DLL. - - - Executable name with arguments (required) - Calling an existing executable. - - - Command line arguments (optional) - Calling an executable just installed. - - - Target file name (required) - Creating a file from custom data. - - - Null - Executing script code. - - - - True - - -

Examples

- - Add some custom actions related to the virtual directory dialog and custom action. - - <customactions> - <!-- Custom actions creating entry points into the custom action dll specified in the binary table --> - <customaction action="WEBCA_GatherWebFolderProperties" type="1" source="MSVBDPCADLL" target="GatherWebFolderProperties" /> - <customaction action="WEBCA_ApplyWebFolderProperties" type="1537" source="MSVBDPCADLL" target="ApplyWebFolderProperties" /> - <customaction action="WEBCA_RollbackApplyWebFolderProperties" type="1281" source="MSVBDPCADLL" target="RollbackApplyWebFolderProperties" /> - <customaction action="WEBCA_CreateURLs" type="1" source="MSVBDPCADLL" target="CreateURLs" /> - <customaction action="WEBCA_EvaluateURLs" type="1" source="MSVBDPCADLL" target="EvaluateURLs" /> - <customaction action="WEBCA_EvaluateURLsNoFail" type="1" source="MSVBDPCADLL" target="EvaluateURLsNoFail" /> - <customaction action="WEBCA_EvaluateURLsMB" type="1" source="MSVBDPCADLL" target="EvaluateURLsMB" /> - <customaction action="WEBCA_CreateAppRoots" type="1" source="MSVBDPCADLL" target="CreateAppRoots" /> - - <!-- Custom actions to set default control values in the webfolder dialog --> - <customaction action="WEBCA_TARGETVDIR" type="307" source="TARGETVDIR" target="Default VDir" /> - <customaction action="WEBCA_TARGETPORT" type="307" source="TARGETPORT" target="80" /> - </customactions> - - - - - - - - Used to modify the sequence of tasks/events that execute during the - overall installation process. - -

Parameters

- - - Attribute - Type - Description - Required - - - type - msi:MSISequenceTable - Valid inputs: - - installexecute represents InstallExecuteSequence Table. - installui represents InstallUISequence Table - adminexecute represents AdminExecuteSequence Table - adminui represents AdminUISequence Table - advtexecute represents AdvtUISequence Table - - - True - - - action - string - Name of the action to execute. This is either a built-in action or a custom action. - True - - - value - int - Number that determines the sequence position in which this action is to be executed.
- A positive value represents the sequence position. A Null value indicates that the action is not executed. The following - negative values indicate that this action is to be executed if the installer returns the associated termination flag. No - more than one action may have a negative value entered in the Sequence field. - - - Value - Description - - - -1 - Successful completion. - - - -2 - User terminates install. - - - -3 - Fatal exit terminates. - - - -4 - Install is suspended. - - - - True - - - condition - string - This field contains a conditional expression. If the expression evaluates to False, then the action is skipped. If the expression syntax is invalid, then the sequence terminates, returning iesBadActionData. - False - - -

Examples

- - Add the sequences to support virtual directories - - <sequences> - <sequence type="installexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> - <sequence type="installexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> - <sequence type="installexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_GatherWebFolderProperties" value="3701" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_ApplyWebFolderProperties" value="3701" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_RollbackApplyWebFolderProperties" value="3701" condition="NOT Installed" /> - <sequence type="installexecute" action="WEBCA_CreateAppRoots" value="3701" condition="NOT Installed" /> - <sequence type="installui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> - <sequence type="installui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> - <sequence type="installui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> - <sequence type="installui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> - <sequence type="adminexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> - <sequence type="adminexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> - <sequence type="adminexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> - <sequence type="adminexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /> - <sequence type="adminui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> - <sequence type="adminui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> - <sequence type="adminui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> - <sequence type="adminui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> - </sequences> - - - - - - - - Creates text to be displayed in a progress dialog box and written - to the log for actions that take a long time to execute. The text - displayed consists of the action description and optionally formatted - data from the action. The entries in the ActionText table typically - refer to actions in sequence tables. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Unique name identifying the action. - True - - - template - string - A localized format template is used to format action data records for display during action execution. If no template is supplied, then the action data will not be displayed. - False - - -

Nested Elements:

-

<description>

-
    - Localized description displayed in the progress dialog box or written to the log when the action is executing. -
-

</description>

-

Examples

- - Add the related action text for the web folder actions. - - <actiontext> - <action name="WEBCA_GatherWebFolderProperties" > - <description>Gathering web folder properties</description> - </action> - <action name="WEBCA_ApplyWebFolderProperties" > - <description>Applying web folder properties</description> - </action> - <action name="WEBCA_RollbackApplyWebFolderProperties" > - <description>Removing web folder properties</description> - </action> - <action name="WEBCA_CreateURLs" > - <description>Creating URLs</description> - </action> - <action name="WEBCA_EvaluateURLs" > - <description>Evaluating URLs</description> - </action> - <action name="WEBCA_EvaluateURLsNoFail" > - <description>Evaluating URLs and do not fail if URL is invalid</description> - </action> - <action name="WEBCA_EvaluateURLsMB" > - <description>Evaluating URLs</description> - </action> - <action name="WEBCA_CreateAppRoots" > - <description>Creating application roots</description> - </action> - <action name="WEBCA_TARGETVDIR" > - <description>Set TARGETVDIR property to the specified virtual dir</description> - </action> - <action name="WEBCA_TARGETPORT" > - <description>Set TARGETPORT property to the specified virtual dir port</description> - </action> - </actiontext> - - - - - - - - Adds Verbs and a handler for the specified file type. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - directory - string - Refrence to a directory. The directory to add the specific verb/handler to IIS for the specified file type. - True - - - extension - string - File name extension to specifically handle - False - - - exepath - string - Path to the Internet Server API (ISAPI) or Common Gateway Interface (CGI) program to run to process a request. - False - - - verbs - string - Internet Information Services verbs that are allowed for the executable file. Only verbs entered in this field will be allowed. - False - - -

Examples

- - Add the aspx app mapping - - <appmappings> - <appmapping directory="D__ACME_MyProduct" extension=".aspx" exepath="[DOTNETFOLDER]aspnet_isapi.dll" verbs="GET,HEAD,POST,DEBUG" /> - </appmappings> - - - - - - - - Determines the local path equivalent for a url and stores this - information in a property. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - The name of the URLProperty to convert - True - - - property - string - The name of the property to store the directory information. - True - - -

Examples

- - Convert the TARGETURL property to a directory and store that information in TARGETDIR - - <urlproperties> - <urlproperty name="TARGETURL" property="TARGETDIR" /> - </urlproperties> - - - - - - - - Creates a URLProperty representing the virtual directory and port. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Property containing the virtual directory - True - - - portproperty - string - Property containing the network port number to use. - True - - - urlproperty - string - URLProperty to store the url in - True - - -

Examples

- - Convert the virtual directory and port to a url and store the value in a property. - - <vdirproperties> - <vdirproperty name="TARGETVDIR" portproperty="TARGETPORT" urlproperty="TARGETURL" /> - </vdirproperties> - - - - - - - - Create a Web application definition and marks it as running in-process - or out-of-process. If an application already exists at the specified - path, you can use this method to reconfigure the application from - in-process to out-of-process, or the reverse. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - component - string - Reference to a component. Determines when the approot will be created. - True - - - urlproperty - string - URLProperty with stored url - True - - - inprocflag - int - Specifies whether the application being created is to run in-process (0), out-of-process (1), or in a pooled process (2). If the application already exists and is running, changing the value of this flag will cause the application definition to be deleted and a new application created to run in the specified process space. - True - - -

Examples

- - Convert the virtual directory and port to a url and store the value in a property. - - <approots> - <approot component="C__MainFiles" urlproperty="TARGETURL" inprocflag="2" /> - </approots> - - - - - - - - Specifies directory security in IIS. Can also configure the default - documents supported by each directory. - - This not an officially Microsoft supported table. -

Parameters

- - - Attribute - Type - Description - Required - - - directory - string - Reference to a directory. This is the directory that gets modified with the specific attributes. - True - - - attr - int - Attributes to set for the directory. - - - Value - Flag Name - Description - - - 1 - AccessRead - The file or the contents of the folder may be read through Microsoft Internet Explorer. - - - 2 - AccessWrite - Users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. Write can be implemented only with a browser that supports the PUT feature of the HTTP 1.1 protocol standard. - - - 4 - AccessExecute - The file or the contents of the folder may be executed, regardless of file type. - - - 8 - AccessSSL - File access requires SSL file permission processing, with or without a client certificate. - - - 16 - AccessSource - Users are allowed to access source code if either Read or Write permissions are set. Source code includes scripts in Microsoft ® Active Server Pages (ASP) applications. - - - 32 - AccessSSLNegotiateCert - SSL file access processing requests a certificate from the client. A value of false indicates that access continues if the client does not have a certificate. Some versions of Internet Explorer will close the connection if the server requests a certificate and a certificate is not available (even if AccessSSLRequireCert is also set to true). - - - 64 - AccessSSLRequireCert - SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. AccessSSLNegotiateCert must also be set to true when using AccessSSLRequireCert. - - - 128 - AccessSSLMapCert - SSL file permission processing maps a client certificate to a Microsoft Windows ® operating system user-account. The AccessSSLNegotiateCert property must also be set to true for the mapping to occur. - - - 256 - AccessSSL128 - File access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate. - - - 512 - AccessScript - The file or the contents of the folder may be executed if they are script files or static content. A value of false only allows static files, such as HTML files, to be served. - - - 1024 - AccessNoRemoteWrite - Remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests. - - - 4096 - AccessNoRemoteRead - Remote requests to view files are denied; only requests from the same computer as the IIS server succeed if the AccessRead property is set to true. You cannot set AccessNoRemoteRead to false to enable remote requests, and set AccessRead to false to disable local requests. - - - 8192 - AccessNoRemoteExecute - Remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if the AccessExecute property is set to true. You cannot set AccessNoRemoteExecute to false to enable remote requests, and set AccessExecute to false to disable local requests. - - - 16384 - AccessNoRemoteScript - Requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests. - - - 32768 - AccessNoPhysicalDir - Access to the physical path is not allowed. - - - - True - - - defaultdoc - string - Adds a filename to the Default Documents to process. Add multiple separated with a comma (Eg. "Default.aspx,Default.htm") - False - - -

Examples

- - Specify permissions for the directory structure. - - <iisproperties> - <iisproperty directory="TARGETDIR" attr="626" defaultdoc="Default.aspx" /> - <iisproperty directory="D__BIN" attr="112" /> - <iisproperty directory="D__SomeSubDir" attr="114" /> - </iisproperties> - - - - - - - Summary description for MsiTaskInfo. - - - - - Loads the banner image. - - The MSI database. - - - - Loads the background image. - - The MSI database. - - - - Loads the license file. - - The MSI database. - - - - Loads records for the Media table. - - The MSI database. - The sequence number of the last file in the .cab. - - - - Loads records for the Features table. - - The MSI database. - - - - Adds a feature record to the Features table. - - The MSI database Feature table. - The MSI database Condition table. - The name of this feature's parent. - The MSI database. - This Feature's Schema element. - The tree depth of this feature. - The tree order of this feature. - - - - Loads records for the LaunchCondition table - - The MSI database. - - - - Merges Merge Modules into the MSI Database. - - The MSI Database. - The path to temporary files. - - - - Creates a Windows Installer (also known as Microsoft Installer, or MSI) - setup database for installing software on the Windows Platform. - - - - Requires cabarc.exe in the path. This tool is part of the - Microsoft Cabinet SDK. - - - Requires mergemod.dll version 2.0 or greater. This dll is part of the - Microsoft Platform SDK. - - - See the Roadmap to Windows Installer Documentation - at Microsoft's MSDN website for more information. - - - - - - Initializes task and verifies parameters. - - - - - Executes the task. - - - - - An .rtf (rich text format) file containing the license agreement - for your software. The contents of this file will be displayed to - the user when setup runs and must be accepted to continue. - - - - - A .bmp (bitmap) file 495x60 pixels in size that will be displayed - as the banner (top) image of the installation user interface. - - - - - A .bmp (bitmap) file 495x315 pixels in size that will be displayed - as the background image of the installation user interface. - - - - - - Groups sets of components into named sets, these can be used to - layout the tree control that allows users to select and deselect - features of your software product when a custom installation is - selected at runtime. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - A name used to refer to the feature. - True - - - display - int - The number in this field specifies the order in which the feature is to be displayed in the user interface. - The value also determines if the feature is initially displayed expanded or collapsed.
- If the value is null or zero, the record is not displayed. If the value is odd, the feature node is expanded initially. - If the value is even, the feature node is collapsed initially. - - True - - - title - string - Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog. - False - - - typical - bool - Determines if the feature should be included in a "typical" install. This is useful for when the user selects to just install the typical features. - False - - - directory - string - Refrence to a directory. Specify a corresponding directory to go with the feature. - False - - - attr - int - Any combination of the following: - - - Value - Description - - - 0 - Components of this feature that are not marked for installation from source are installed locally. - - - 1 - Components of this feature not marked for local installation are installed to run from the source CD-ROM or server. - - - 2 - Set this attribute and the state of the feature is the same as the state of the feature's parent. - - - 4 - Set this attribute and the feature state is Advertise. - - - 8 - Note that this bit works only with features that are listed by the ADVERTISE property.
Set this attribute to prevent the feature from being advertised. - - - 16 - Set this attribute and the user interface does not display an option to change the feature state to Absent. Setting this attribute forces the feature to the installation state, whether or not the feature is visible in the UI. - - - 32 - Set this attribute and advertising is disabled for the feature if the operating system shell does not support Windows Installer descriptors. - - - More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp - - False - - -

Nested Elements:

-

<feature>

-
    - Nested feature elements are supported. -
-

</feature>

-

<description>

-
    - Longer string of text describing the feature. This localizable string is displayed by the Text control of the Selection Dialog. -
-

</description>

-

<conditions>

-
    -

    <condition>

    -
      - - - Attribute - Type - Description - Required - - - expression - string - If this conditional expression evaluates to TRUE, then the Level column in the Feature table is set to the - conditional install level.
      - The expression in the Condition column should not contain reference to the installed state of any feature or component. - This is because the expressions in the Condition column are evaluated before the installer evaluates the installed - states of features and components. Any expression in the Condition table that attempts to check the installed state - of a feature or component always evaluates to false.
      - For information on the syntax of conditional statements, see Conditional Statement Syntax. -       - True -       - - level - int - The installer sets the install level of this feature to the level specified in this column if the expression in - the Condition column evaluates to TRUE. Set this value to 0 to have the component not install if the condition is not met.
      - For any installation, there is a defined install level, which is an integral value from 1 to 32,767. The initial value - is determined by the InstallLevel property, which is set in the Property table.
      - A feature is installed only if the feature level value is less than or equal to the current install level. The user - interface can be authored such that once the installation is initialized, the installer allows the user to modify the - install level of any feature in the Feature table. For example, an author can define install level values that represent - specific installation options, such as Complete, Typical, or Minimum, and then create a dialog box that uses - SetInstallLevel ControlEvents to enable the user to select one of these states. Depending on the state the user selects, - the dialog box sets the install level property to the corresponding value. If the author assigns Typical a level of 100 - and the user selects Typical, only those features with a level of 100 or less are installed. In addition, the Custom - option could lead to another dialog box containing a Selection Tree control. The Selection Tree would then allow the user - to individually change whether each feature is installed.       - True -       -       -
    -

    </condition>

    -
-

</conditions>

-

Examples

- - Define a sample features structure. - - <features> - <feature name="F__Default" title="My Product" display="1" typical="true" directory="TARGETDIR"> - <description>My Product from ACME, Inc. </description> - <feature name="F__MainFiles" display="0" typical="true" /> - </feature> - <feature name="F__Help" title="My Product Help Files" display="1" typical="false" directory="D__ACME_MyProduct_Help" /> - </features> - - - - - - Includes pre-packaged installation components (.msm files) as part - of the msi database. This feature allows reuse of installation - components that use MSI technology from other setup vendors or as - created by the . + Name/value pairs which will be set in the PROPERTY table of the + installer database. + + + The properties element contains within it one to any number of property elements.
+ Public property names cannot contain lowercase letters.
+ Private property names must contain some lowercase letters.
+ Property names prefixed with % represent system and user environment variables. These are + never entered into the Property + table. The permanent settings of environment variables can only be modified using the Environment Table. + More information is available here.

Parameters

@@ -5624,62 +2598,3088 @@ Required - feature + name string - Refrence to a feature. Used to associate the merge module with the feature (and the feature's directory) for when to install the components in the merge module. + A name used to refer to the property. + True + + + value + string + The value of the property. This value can contain references to other, predefined properties to build a compound property. True -

Nested Elements:

-

<modules>

-
    - Specifies the merge module(s) to include with the specified feature. -
-

</modules>

-

<configurationitems>

-
    -

    <configurationitem>

    -
      - Specifies the value for a configurable item -

      Parameters

      - - - Attribute - Type - Description - Required - - - module - string - Merge module filename to limit the configuration item to. If this is not set, the configuration item will be applied to all merge modules in the fileset. - True - - - name - string - Name of item for which data is to be set - True - - - value - string - Value of the configurable item - True - - -
    -

    </configurationitem>

    -
-

</configurationitems>

Examples

- Add the NAnt merge module to the install. + Define the required properties. - <mergemodules> - <merge feature="F__NAntMSM"> - <modules> - <include name="${nant.dir}\Install\NAnt.msm" /> + <properties> + <property name="ProductName" value="My Product" /> + <property name="ProductVersion" value="1.0.0" /> + <property name="Manufacturer" value="ACME Inc." /> + <property name="ProductCode" value="{29D8F096-3371-4cba-87E1-A8C6511F7B4C}" /> + <property name="UpgradeCode" value="{69E66919-0DE1-4280-B4C1-94049F76BA1A}" /> + </properties> + + + + + + + + Contains within it one to any number of app, registry, ini, or dirfile elements. + These elements are used to search for an existing filesystem directory, file, or + Windows Registry setting. A property in the installer database is + then set with the value obtained from the search. + +

<app>

+ + More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/complocator_table.asp + + + + Attribute + Type + Description + Required + + + componentid + string + The component ID of the component whose key path is to be used for the search. + True + + + type + msi:MSILocatorTypeDirFile + Valid input: file or directory + True + + + setproperty + string + A name used to refer to the property within the Msi database. Set at install time. + True + + +

</app>

+

<registry>

+ + More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/reglocator_table.asp + + + + Attribute + Type + Description + Required + + + type + msi:MSILocatorTypeDirFileReg64 + Valid input: registry, file, directory, 64bit + True + + + path + string + Depending on the type specified: + + Path is a directory. + Path is a registry key. + + + True + + + root + msi:MSIRegistryKeyRoot + Valid input: + + dependent - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1. + machine represents HKEY_LOCAL_MACHINE + classes represents HKEY_CLASSES_ROOT + user represents HKEY_CURRENT_USER + users represents HKEY_USERS + + + True + + +
    +

    Nested Elements:

    +

    <value>

    +

    Parameters

    + + + Attribute + Type + Description + Required + + + name + string + Depending on the type specified: + + Key path is a file name. + Key path is a registry value. + + + False + + + setproperty + string + A name used to refer to the property within the Msi database. Set at install time. + True + + +

    </value>

    +
+

</registry>

+

<ini>

+ + More information on these attributes can be found at: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/inilocator_table.asp + + + + Attribute + Type + Description + Required + + + filename + string + The .ini file name. (The .ini file must be present in the default Microsoft Windows directory.) + + True + + + section + string + Section name within the .ini file. + + True + + + key + string + Key value within the section. + + True + + + field + msi:nonNegativeInt + The field in the .ini line. If Field is Null or 0, then the entire line is read. + This must be a non-negative number. + + False + + + type + msi:MSILocatorTypeDirFileRaw + Valid input: file ,directory, or raw + True + + + setproperty + string + A name used to refer to the property within the Msi database. Set at install time. + True + + +

</ini>

+

<dirfile>

+ + More information on these attributes can be found at: + http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/drlocator_table.asp + and + http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/signature_table.asp + + + + Attribute + Type + Description + Required + + + parent + string + An identifier to RegLocator, IniLocator, or CompLocator tables. + If it does not expand to a full path, then all the fixed drives of the user's system are searched by using the Path. +
In order to determine what the key is for a table, prefix the property name assigned + to that locator with SIG_ + + False + + + path + string + the path on the user's system. This is a either a full path or a relative subpath + below the directory specified in the Parent column. + + False + + + depth + msi:nonNegativeInt + The depth below the path that the installer searches for the file or directory. + + False + + + setproperty + string + A name used to refer to the property within the Msi database. Set at install time. + True + + +
    +

    Nested Elements:

    +

    <file>

    +

    Parameters

    + + + Attribute + Type + Description + Required + + + name + string + The name of the file. + True + + + minversion + string + The minimum version of the file, with a language comparison. If this field is + specified, then the file must have a version that is at least equal to MinVersion. + If the file has an equal version to the MinVersion field value but the language + specified in the Languages column differs, the file does not satisfy the signature + filter criteria. + False + + + maxversion + string + The maximum version of the file. If this field is specified, then the file + must have a version that is at most equal to MaxVersion. + False + + + minsize + msi:nonNegativeInt + The minimum size of the file. If this field is specified, then the file + under inspection must have a size that is at least equal to MinSize. This must + be a non-negative number. + False + + + maxsize + msi:nonNegativeInt + The maximum size of the file. If this field is specified, then the file + under inspection must have a size that is at most equal to MaxSize. This must + be a non-negative number. + False + + + mindate + msi:nonNegativeInt + The minimum modification date and time of the file. If this field is + specified, then the file under inspection must have a modification date and time + that is at least equal to MinDate. This must be a non-negative number. + False + + + maxdate + msi:nonNegativeInt + The maximum creation date of the file. If this field is specified, then the + file under inspection must have a creation date that is at most equal to MaxDate. + This must be a non-negative number. + False + + + languages + string + The languages supported by the file. + False + + +

    </file>

    +
+

</dirfile>

+

Examples

+ + Get the path of the web directory and the version of IIS. Create new properties in the Msi file with those values. + + <search> + <registry type="registry" path="Software\Microsoft\InetStp" root="machine" > + <value name="PathWWWRoot" setproperty="IISWWWROOT" /> + </registry> + <registry type="registry" path="SYSTEM\CurrentControlSet\Services\W3SVC\Parameters" root="machine" > + <value name="MajorVersion" setproperty="IISVERSION" /> + </registry> + </search> + + + + Shows two ways to get the default key value for the specified key. Create new properties in the Msi file with those values. + + <search> + <registry type="registry" path="Software\Microsoft\MessengerService" root="machine" > + <value setproperty="MSGSRVNAME" /> + <value name="" setproperty="MSGSRVNAME2" /> + </registry> + </search> + + + + + + + + Contains within it one to any number of launchcondition elements. + Launch conditions are conditions that all must be satisfied for the + installation to begin. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to identify the launch condition. + True + + + condition + string + Expression that must evaluate to True for installation to begin. + True + + +

Nested Elements:

+

<description>

+
    + Localizable text to display when the condition fails and the installation must be terminated. +
+

</description>

+

Examples

+ + Create a check to make sure that IIS 5.x is installed. + + <launchconditions> + <launchcondition name="CheckIIS" condition="(IISVERSION = &quot;#5&quot;)" > + <description> + This setup requires Internet information Server 5.x. Please install Internet Information Server and run this setup again. + </description> + </launchcondition> + </launchconditions> + + + + + + + + Creates custom tables not directly managed by default features of + the installer task. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A unique name used to identify the table. + True + + +

Nested Elements:

+

<columns>

+
    +

    <column>

    +
      + Defines the columns making up the table +

      Parameters

      + + + Attribute + Type + Description + Required + + + name + string + A unique name used to define the column. + True + + + nullable + bool + When set to true, allows the column to accept null values; false does not allow null values. + True + + + category + msi:MSITableColumnCategoryType + Valid input: + + Text + UpperCase + LowerCase + Integer + DoubleInteger + Time/Date + Identifier + Property + Filename + WildCardFilename + Path + Paths + AnyPath + DefaultDir + RegPath + Formatted + Template + Condition + GUID + Version + Language + Binary + Cabinet + Shortcut + + More information here: http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp + + False + + + type + string + Overrides the category specification. An example of valid input would be: S255 + False + + + key + bool + When set to true, the column is used to form the primary key for the table; false specifies that the column is not used to form the primary key. + False + + + minvalue + int + This field applies to columns having numeric value. The field contains the minimum permissible value. This can be the minimum value for an integer or the minimum value for a date or version string. + False + + + maxvalue + int + This field applies to columns having numeric value. The field is the maximum permissible value. This may be the maximum value for an integer or the maximum value for a date or version string. + False + + + keytable + string + This field applies to columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. This can be a list of tables separated by semicolons. + False + + + keycolumn + int + This field applies to table columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. The permissible range of the KeyColumn field is 1-32. + False + + + set + string + This is a list of permissible values for this field separated by semicolons. This field is usually used for enums. + False + + + description + string + A description of the data that is stored in the column. + False + + +
    +

    </column>

    +
+

</columns>

+

<rows>

+
    +

    <row>

    +
      + Defines the data for a row in the table +

      <columns>

      +
        +

        <column>

        +
          + Defines data for a specific cell in the row +

          Parameters

          + + + Attribute + Type + Description + Required + + + name + string + Name of the column to populate. + True + + + value + string + Value to populate the cell with. + True + + +
        +

        </column>

        +
      +

      </columns>

      +
    +

    </row>

    +
+

</rows>

+

Examples

+ + + Build the IniFile table. Since the WriteIniValues and RemoveIniValues actions exist in the template, they will use this table. + + + <tables> + <table name="IniFile"> + <columns> + <column name="IniFile" nullable="false" category="Identifier" key="true" description="The key for this table." /> + <column name="FileName" nullable="false" category="Text" description="The localizable name of the .ini file in which to write the information. " /> + <column name="DirProperty" nullable="true" category="Identifier" description="Name of a property having a value that resolves to the full path of the folder containing the .ini file. " /> + <column name="Section" nullable="false" category="Formatted" description="The localizable .ini file section." /> + <column name="Key" nullable="false" category="Formatted" description="The localizable .ini file key within the section" /> + <column name="Value" nullable="false" category="Formatted" description="The localizable value to be written. " /> + <column name="Action" nullable="false" category="Integer" description="The type of modification to be made. " /> + <column name="Component_" nullable="false" category="Identifier" description="External key into the first column of the Component table referencing the component that controls the installation of the .ini value. " /> + </columns> + <rows> + <row> + <columns> + <column name="IniFile" value="MyInternetShortcut" /> + <column name="FileName" value="MyInternetAddr.url" /> + <column name="DirProperty" value="D__MYDIR" /> + <column name="Section" value="InternetShortcut" /> + <column name="Key" value="URL" /> + <column name="Value" value="[TARGETURL]" /> + <column name="Action" value="0" /> + <column name="Component_" value="C__Documentation" /> + </columns> + </row> + </rows> + </table> + </tables> + + + + + + + + Specifies the directory layout for the product. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the directory. + True + + + foldername + string + The directory's name (localizable)under the parent directory. + True + + + root + string + A reference to the directory's parent directory. This can be a property name or one of the predefined directories included with the default template: + + AdminToolsFolder + AppDataFolder + CommonAppDataFolder + CommonFiles64Folder + CommonFilesFolder + DesktopFolder + FavoritesFolder + FontsFolder + LocalAppDataFolder + MyPicturesFolder + PersonalFolder + ProgramFilesFolder + ProgramMenuFolder + ProgramFiles64Folder + SendToFolder + StartMenuFolder + StartupFolder + System16Folder + System64Folder + SystemFolder + TARGETDIR + TempFolder + TemplateFolder + WindowsFolder + WindowsVolume + + + True + + +

Nested Elements:

+

<directory>

+
    + Sub directories. Note, this element can contain nested <directory/> sub elements. +

    Parameters

    + + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the directory. + True + + + foldername + string + The directory's name (localizable)under the parent directory. + True + + +
+

</directory>

+

Examples

+ + Define a sample directory structure. + + <directories> + <directory name="D__ACME" foldername="ACME" root="TARGETDIR" > + <directory name="D__ACME_MyProduct" foldername="My Product" /> + </directory> + </directories> + + + + + + + + Used to modify the environment variables of the target computer at + runtime. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + The localizable name of the environment variable. The key values are written or removed depending upon + which of the characters in the following table are prefixed to the name. There is no effect in the ordering of + the symbols used in a prefix. + + + Prefix + Description + + + = + Create the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation. + + + + + Create the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists. + + + - + Remove the environment variable when the component is removed. This symbol can be combined with any prefix. + + + ! + Remove the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty. + + + * + This prefix is used with Microsoft® Windows® NT/Windows® 2000 to indicate that the name refers to a system environment variable. If no asterisk is present, the installer writes the variable to the user's environment. Microsoft Windows 95/98 ignores the asterisk and add the environment variable to autoexec.bat. This symbol can be combined with any prefix. A package that is used for per-machine installations should write environment variables to the machine's environment by including * in the Name column. For more information, see http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp + + + =- + The environment variable is set on install and removed on uninstall. This is the usual behavior. + + + !- + Removes an environment variable during an install or uninstall. + + + More information can be found here: http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp + + True + + + append + string + Localizable value that is to be set as a formatted string + True + + + component + string + Refrence to a component. Allows the variabled to be modified when the component is un/installed. + True + + +

Examples

+ + Append the installation path to the user PATH variable. + + <environment> + <variable name="PATH" append="'[TARGETDIR]'" component="C__MainFiles" /> + </environment> + + + + + + + + Groups sets of files into named sets, these can be used to install + and perform operations on a set of files as one entity. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the component. + True + + + id + string + A string GUID unique to this component, version, and language.
Note that the letters of these GUIDs must be + uppercase. Utilities such as GUIDGEN can generate GUIDs containing lowercase letters. The lowercase letters must be + changed to uppercase to make these valid component code GUIDs. + + True + + + attr + int + This column contains a bit flag that specifies options for remote execution. Add the indicated bit to the total value in the column to include an option. + + + Value + Description + + + 0 + Component cannot be run from source.
+ Set this bit for all components belonging to a feature to prevent the feature from being run-from-network or + run-from-source. Note that if a feature has no components, the feature always shows run-from-source and + run-from-my-computer as valid options. + + + + 1 + Component can only be run from source.
+ Set this bit for all components belonging to a feature to prevent the feature from being run-from-my-computer. + Note that if a feature has no components, the feature always shows run-from-source and run-from-my-computer as + valid options. + + + + 2 + Component can run locally or from source. + + + 4 + If this bit is set, the value in the key element is used as a key into the Registry table.
+ If the Value field of the corresponding record in the Registry table is null, the Name field in that record must + not contain "+", "-", or "*". For more information, see the description of the Name field in Registry table.
+ Setting this bit is recommended for registry entries written to the HKCU hive. This ensures the installer writes + the necessary HKCU registry entries when there are multiple users on the same machine. + + + + 16 + If this bit is set, the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings. + + + + 32 + If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table. + + + 64 + If this bit is set, the installer reevaluates the value of the statement in the Condition column + upon a reinstall. If the value was previously False and has changed to True, the installer installs the component. + If the value was previously True and has changed to False, the installer removes the component even if the component + has other products as clients.
This bit should only be set for transitive components. See Using Transitive + Components. + + + + 128 + If this bit is set, the installer does not install or reinstall the component if a key path file or + a key path registry entry for the component already exists. The application does register itself as a client of + the component.
+ Use this flag only for components that are being registered by the Registry table. + + + + 256 + Set this bit to mark this as a 64-bit component. This attribute facilitates the installation of + packages that include both 32-bit and 64-bit components. If this bit is not set, the component is registered + as a 32-bit component. + + + + + True + + + directory + string + Refrence to a directory. Defines the directory location for where the files assigned to the component are to be placed. + True + + + feature + string + Refrence to a feature. Maps a feature to the component. Used to determine if the component is to be installed or not. + True + + + condition + string + A conditional statement that can control whether a component is installed. If the condition is null or evaluates to + true, then the component is enabled. If the condition evaluates to False, then the component is disabled and is not + installed. + False + + + fileattr + int + Integer containing bit flags representing file attributes.
+ The following table shows the definition of the bit field. + + + Value + Description + + + 1 + Read-Only + + + 2 + Hidden + + + 4 + System + + + 512 + The file is vital for the proper operation of the component to which it belongs + + + 1024 + The file contains a valid checksum. A checksum is required to repair a file that has become corrupted. + + + 4096 + This bit must only be added by a patch and if the file is being added by the patch. + + + 8192 + The file's source type is uncompressed. If set, ignore the Word Count Summary Property. + If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression + state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed + and msidbFileAttributesCompressed. + + + 16384 + The file's source type is compressed. If set, ignore the Word Count Summary Property. + If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of + the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and + msidbFileAttributesCompressed. + + + + False + + + checkinterop + bool + Used to determine if file(s) in the fileset are interop file(s). If true, extra information will be added in the install + package to register each interop file. If false, the file(s) will not be not be checked and the extra registration information + will not be added to the msi. + False + + + installassembliestogac + bool + Used to determine if assemblies should be installed to the Global Assembly Cache. + If true, all assemblies in the fileset will be added to the GAC. If false, the assemblies will be installed + to the specified directory (as a normal file would). Note: If an assembly is specified to be installed into the GAC, it will not + also be installed to the directory specified. + False + + + keepsubdirs + bool + Used to determine if directories in the fileset should be built. + If true, all subdirectories of the fileset basedir will be built. If false the directories structure will be + flattened. The default is false. + False + + +

Nested Elements:

+

<keyfile>

+
    + This value points to a file or folder belonging to the component that the installer uses to detect the component. Two components cannot share the same key path value. +

    Parameters

    + + + Attribute + Type + Description + Required + + + file + string + Name of the key (file) to use. Also, this could be an id of a registry key value. + True + + +
+

</keyfile>

+

<fileset>

+
    + Specifies the files to include with the component +
+

</fileset>

+

<forceid>

+
    + Used to force specific attributes on a per file basis +

    Parameters

    + + + Attribute + Type + Description + Required + + + file + string + Name of the file, in the fileset, to override. + True + + + id + string + Unique GUID to assign to the file. + True + + + attr + int + Integer containing bit flags representing file attributes.
    + The following table shows the definition of the bit field. + + + Value + Description + + + 1 + Read-Only + + + 2 + Hidden + + + 4 + System + + + 512 + The file is vital for the proper operation of the component to which it belongs + + + 1024 + The file contains a valid checksum. A checksum is required to repair a file that has become corrupted. + + + 4096 + This bit must only be added by a patch and if the file is being added by the patch. + + + 8192 + The file's source type is uncompressed. If set, ignore the Word Count Summary Property. + If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression + state of the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed + and msidbFileAttributesCompressed. + + + 16384 + The file's source type is compressed. If set, ignore the Word Count Summary Property. + If neither msidbFileAttributesNoncompressed or msidbFileAttributesCompressed are set, the compression state of + the file is specified by the Word Count Summary Property. Do not set both msidbFileAttributesNoncompressed and + msidbFileAttributesCompressed. + + +     + False +     + + version + string + This field is the version string for a versioned file. This field is blank for non-versioned files. + False + + + language + string + A list of decimal language IDs separated by commas. + False + + + checkinterop + bool + Used to determine if file is an interop file. If true, extra information will be added in the install + package to register the interop file. If false, the file will not be not be checked and the extra registration information + will not be added to the msi. + False + + + installtogac + bool + If true, and if the file is an assembly, it will be installed to the GAC. If false, the file + will be installed to the directory specified by the component. Note: If an assembly is specified to + be installed into the GAC, it will not also be installed to the directory specified. + False + +     +
+

</forceid>

+

Examples

+ + Define a sample component structure. + + <components> + <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" > + <key file="default.aspx" /> + <fileset basedir="${install.dir}"> + <include name="*.*" /> + </fileset> + </component> + </components> + + + + Install files to TARGETDIR and assemblies to the GAC (Global Assembly Cache). Do not install MyOtherAssembly.dll to the GAC, but rather install it with the other files (to TARGETDIR) + + <components> + <component name="C__MainFiles" id="{26AA7144-E683-441D-9843-3C79AEC1C636}" attr="2" directory="TARGETDIR" feature="F__MainFiles" installassembliestogac="true" > + <key file="MyAssemblyName.xml" /> + <fileset basedir="${install.dir}"> + <include name="*.*" /> + </fileset> + <forceid file="MyOtherAssembly.dll" id="_4EB7CCB23D394958988ED817DA00B9D1" installtogac="false" /> + </component> + </components> + + + + Assign a registry entry to a specific component. + + <components> + <component name="C__RegistryEntry" id="{06C654AA-273D-4E39-885C-3E5225D9F336}" attr="4" directory="TARGETDIR" feature="F__DefaultFeature" > + <key file="R__822EC365A8754FACBF6C713BFE4E57F0" /> + </component> + </components> + . + . + . + <registry> + <key path="SOFTWARE\MyCompany\MyProduct\" root="machine" component="C__RegistryEntry"> + <value id="R__822EC365A8754FACBF6C713BFE4E57F0" name="MyKeyName" value="MyKeyValue" /> + </key> + </registry> + + + + + + + + Creates custom dialogs that can gather information not handled by + the default installer template. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the dialog. + True + + + hcenter + int + Horizontal position of the dialog box. The range is 0 to 100, with 0 at the left edge of the screen and 100 at the right edge. + True + + + vcenter + int + Vertical position of the dialog box. The range is 0 to 100, with 0 at the top edge of the screen and 100 at the bottom edge. + True + + + width + int + Width of the rectangular boundary of the dialog box. This number must be non-negative. + True + + + height + int + Height of the rectangular boundary of the dialog box. This number must be non-negative. + True + + + attr + int + A 32-bit word that specifies the attribute flags to be applied to this dialog box. This number must be non-negative. + + + Value + Description + + + 1 + Visible + + + 2 + Modal + + + 4 + Minimize + + + 8 + SysModal + + + 16 + KeepModeless + + + 32 + TrackDiskSpace + + + 64 + UseCustomPalette + + + 128 + RTLRO + + + 256 + RightAligned + + + 512 + LeftScroll + + + 896 + BiDi + + + 65536 + Error + + + More information here: http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp + + True + + + title + string + A localizable text string specifying the title to be displayed in the title bar of the dialog box. + True + + + firstcontrol + string + An external key to the second column of the Control table. Combining this field with the Dialog field identifies a + unique control in the Control table. This defines the control that takes the focus when the dialog box is created. This + column is ignored in an Error dialog box.
+ Because static text cannot take the focus, a Text control that describes an Edit, PathEdit, ListView, ComboBox or + VolumeSelectCombo control must be made the first control in the dialog box to ensure compatibility with screen readers. + + True + + + defaultcontrol + string + An external key to the second column of the Control table. Combining this field with the Dialog field results in + a primary key into the Control table that defines the default control. Hitting the Return key is equivalent to clicking + on the default control. If this column is left blank, then there is no default control. This column is ignored in the + Error dialog box. + + True + + + cancelcontrol + string + An external key to the second column of the Control table. Combining this field with the Dialog field results in + a primary key of the Control table that defines the cancel control. Hitting the ESC key or clicking the Close button in + the dialog box is equivalent to clicking on the cancel control. This column is ignored in an Error dialog box.
+ The cancel control is hidden during rollback or the removal of backed up files. The protected UI handler hides the control + upon receiving a INSTALLMESSAGE_COMMONDATA message. + + True + + +

Examples

+ + Add a web folder dialog: + + <dialogs> + <dialog name="WebFolderDlg" hcenter="50" vcenter="50" width="370" height="270" attr="39" title="[ProductName] [Setup]" firstcontrol="Next" defaultcontrol="Next" cancelcontrol="Cancel" /> + </dialogs> + + + + + + + + Creates user interface controls displayed on custom dialogs. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes. + True + + + dialog + string + Refrence to a dialog. Used to associate the control with the dialog. + True + + + type + string + The type of the control. + + + Control name + Description + + + Billboard + Displays billboards based on progress messages. + + + Bitmap + Displays a static picture of a bitmap. + + + CheckBox + A two-state check box. + + + ComboBox + A drop-down list with an edit field. + + + DirectoryCombo + Select all except the last segment of the path. + + + DirectoryList + Displays folders below the main part of path. + + + Edit + A regular edit field for any string or integer. + + + GroupBox + Displays a rectangle that groups other controls together. + + + Icon + Displays a static picture of an icon. + + + Line + Displays a horizontal line. + + + ListBox + A drop-down list without an edit field. + + + ListView + Displays a column of values with icons for selection. + + + MaskedEdit + An edit field with a mask in the text field. + + + PathEdit + Displays folder name or entire path in an edit field. + + + ProgressBar + Bar graph that changes length as it receives progress messages. + + + PushButton + Displays a basic push button. + + + RadioButtonGroup + A group of radio buttons. + + + ScrollableText + Displays a long string of text. + + + SelectionTree + Displays information from the Feature table and enables the user to change their selection state. + + + Text + Displays static text. + + + VolumeCostList + Displays costing information on different volumes. + + + VolumeSelectCombo + Selects volume from an alphabetical list. + + + More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp + True + + + x + int + Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. + True + + + y + int + Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. + True + + + width + int + Width of the rectangular boundary of the control. This must be a non-negative number. + True + + + height + int + Height of the rectangular boundary of the control. This must be a non-negative number. + True + + + attr + int + A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see Control Attributes. + True + + + property + string + The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls. + False + + + text + string + A localizable string used to set the initial text contained in a control. The string can also contain embedded properties. + False + + + nextcontrol + string + The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. + False + + + help + string + Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present. + False + + + remove + bool + If true, the control is removed. If false, the control is added. + False + + +

Examples

+ + Remove the Browse button from the customize dialog and add controls for a web dialog + + <controls> + <!-- Remove the Browse button from customize dialog --> + <control dialog="CustomizeDlg" name="Browse" type="PushButton" + x="304" y="200" width="56" height="17" attr="3" remove="true" /> + <control dialog="CustomizeDlg" name="Tree" type="SelectionTree" + x="25" y="85" width="175" height="95" attr="7" remove="true" /> + <!-- Re add the tree control with the proper next control --> + <control dialog="CustomizeDlg" name="Tree" type="SelectionTree" + x="25" y="85" width="175" height="95" attr="7" + property="_BrowseProperty" text="Tree of selections" nextcontrol="Reset" /> + <!-- Adds the controls associated with the webfolder dialog --> + <control dialog="WebFolderDlg" name="BannerBitmap" type="Bitmap" + x="0" y="0" width="374" height="44" attr="1" + text="[BannerBitmap]" nextcontrol="VDirLabel" /> + <control dialog="WebFolderDlg" name="Title" type="Text" + x="15" y="6" width="200" height="15" attr="196611" + text="[DlgTitleFont]Virtual Directory Information" /> + <control dialog="WebFolderDlg" name="Description" type="Text" + x="25" y="23" width="280" height="15" attr="196611" + text="Please enter your virtual directory and port information." /> + <control dialog="WebFolderDlg" name="BannerLine" type="Line" + x="0" y="44" width="374" height="0" attr="1" /> + <control dialog="WebFolderDlg" name="VDirLabel" type="Text" + x="18" y="73" width="348" height="15" attr="3" + text="&Virtual directory:" + nextcontrol="Edit_VDir" /> + <control dialog="WebFolderDlg" name="Edit_VDir" type="Edit" + x="18" y="85" width="252" height="18" attr="7" + property="TARGETVDIR" + text="[TARGETVDIR]" + nextcontrol="PortLabel" /> + <control dialog="WebFolderDlg" name="PortLabel" type="Text" + x="18" y="110" width="348" height="15" attr="3" + text="&Port:" + nextcontrol="Edit_Port" /> + <control dialog="WebFolderDlg" name="Edit_Port" type="Edit" + x="18" y="122" width="48" height="18" attr="7" + property="TARGETPORT" + text="[TARGETPORT]" + nextcontrol="Back" /> + <control dialog="WebFolderDlg" name="BottomLine" type="Line" + x="0" y="234" width="374" height="0" attr="1" /> + <control dialog="WebFolderDlg" name="Back" type="PushButton" + x="180" y="243" width="56" height="17" attr="3" + text="[ButtonText_Back]" nextcontrol="Next" /> + <control dialog="WebFolderDlg" name="Next" type="PushButton" + x="236" y="243" width="56" height="17" attr="3" + text="[ButtonText_Next]" nextcontrol="Cancel" /> + <control dialog="WebFolderDlg" name="Cancel" type="PushButton" + x="304" y="243" width="56" height="17" attr="3" + text="[ButtonText_Cancel]" nextcontrol="BannerBitmap" /> + </controls> + + + + + + + + Used to validate and perform operations as the result of information + entered by the user into controls on custom dialogs. + +

Parameters

+ + + Attribute + Type + Description + Required + + + dialog + string + Refrence to a dialog. Used to associate the control with the dialog. + True + + + control + string + Refrence to a control. Maps to a control for the specified dialog. + True + + + action + string + The action that is to be taken on the control. The possible actions are shown in the following table. + + + Value + Description + + + Default + Set control as the default. + + + Disable + Disable the control. + + + Enable + Enable the control. + + + Hide + Hide the control. + + + Show + Display the control. + + + + True + + + condition + string + A conditional statement that specifies under which conditions the action should be triggered. If this statement does not evaluate to TRUE, the action does not take place. If it is set to 1, the action is always applied. + True + + + remove + bool + If true, the control condition is removed. If false, the control condition is added. + False + + +

Examples

+ + Remove the control condition for the Browse button from the customize dialog and add control conditions for a web dialog + + <controlconditions> + <!-- Remove control condition for Browse button on customizeDlg --> + <controlcondition dialog="CustomizeDlg" control="Browse" action="Hide" + condition="Installed" remove="true" /> + <!-- Add control conditions for the web folder dialog --> + <controlcondition dialog="WebFolderDlg" control="Back" action="Disable" + condition="ShowUserRegistrationDlg=""" /> + <controlcondition dialog="WebFolderDlg" control="Back" action="Enable" + condition="ShowUserRegistrationDlg<>""" /> + </controlconditions> + + + + + + + + Used to route the flow of the installation process as the result of + events raised by the user interacting with controls on dialogs. + +

Parameters

+ + + Attribute + Type + Description + Required + + + dialog + string + Refrence to a dialog. Used to associate the control with the dialog. + True + + + control + string + Refrence to a control. Maps to a control for the specified dialog. + True + + + name + string + An identifier that specifies the type of event that should take place when the user interacts with the control + specified by Dialog_ and Control_. For a list of possible values see ControlEvent Overview.
+ To set a property with a control, put [Property_Name] in this field and the new value in the argument field. Put { } + into the argument field to enter the null value. + + True + + + argument + string + A value used as a modifier when triggering a particular event. + True + + + condition + string + A conditional statement that determines whether the installer activates the event in the Event column. The installer + triggers the event if the conditional statement in the Condition field evaluates to True. Therefore put a 1 in this column + to ensure that the installer triggers the event. The installer does not trigger the event if the Condition field contains + a statement that evaluates to False. The installer does not trigger an event with a blank in the Condition field unless no + other events of the control evaluate to True. If none of the Condition fields for the control named in the Control_ field + evaluate to True, the installer triggers the one event having a blank Condition field, and if more than one Condition field + is blank it triggers the one event of these with the largest value in the Ordering field. + False + + + order + int + An integer used to order several events tied to the same control. This must be a non-negative number. + False + + + remove + bool + If true, the control condition is removed. If false, the control condition is added. + False + + +

Examples

+ + Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog + + + <controlevents> + <!-- Remove the old control events --> + <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" + argument="SetupTypeDlg" condition="ProductID" remove="true" /> + <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" + argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg <> 1" remove="true" /> + <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" + argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg = 1" remove="true" /> + <!-- Remove control events for Browse button on CustomizeDlg --> + <controlevent dialog="CustomizeDlg" control="Browse" name="SelectionBrowse" + argument="BrowseDlg" condition="1" remove="true" /> + <!-- Add new control events for the web dialog --> + <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" + argument="WebFolderDlg" condition="ProductID" /> + <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" + argument="WebFolderDlg" condition="ShowWebFolderDlg <> 1" /> + <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" + argument="WebFolderDlg" condition="ShowWebFolderDlg = 1" /> + <controlevent dialog="WebFolderDlg" control="Cancel" name="SpawnDialog" + argument="CancelDlg" order="0" /> + <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" + argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg<>1" + order="0" /> + <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" + argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg=1" + order="0" /> + <!-- Virtual Directory Control Events --> + <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" + argument="WEBCA_CreateURLs" condition="1" order="0" /> + <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" + argument="WEBCA_EvaluateURLsMB" condition="1" order="1" /> + <controlevent dialog="WebFolderDlg" control="Next" name="SetTargetPath" + argument="TARGETDIR" condition="1" order="2" /> + <controlevent dialog="WebFolderDlg" control="Next" name="NewDialog" + argument="SetupTypeDlg" condition="1" order="3" /> + </controlevents> + + + + + + + + Makes modifications to the Windows Registry of the target computer + at runtime. + +

Parameters

+ + + Attribute + Type + Description + Required + + + component + string + Refrence to a component. The component that controls the installation of the registry value. + True + + + root + msi:MSIRegistryKeyRoot + Valid input: + + dependent - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1. + machine represents HKEY_LOCAL_MACHINE + classes represents HKEY_CLASSES_ROOT + user represents HKEY_CURRENT_USER + users represents HKEY_USERS + + + True + + + path + string + Registry key. + True + + +

Nested Elements:

+

<value>

+
    + Specifies the registry value to add to the target machine. + + + Attribute + Type + Description + Required + + + name + string + The registry value name (localizable). If this is Null, then the data entered into the Value column are + written to the default registry key.
    + If the Value column is Null, then the strings shown in the following table in the Name column have special + significance. + + + String + Description + + + + + The key is to be created, if absent, when the component is installed. + + + - + The key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled. + + + * + The key is to be created, if absent, when the component is installed. Additionally, the key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled. + + +     + False +     + + value + string + The localizable registry value. The field is Formatted. If the value is attached to one of the following prefixes (i.e. #%value) then the value is interpreted as described in the table. Note that each prefix begins with a number sign (#). If the value begins with two or more consecutive number signs (#), the first # is ignored and value is interpreted and stored as a string. + + + Prefix + Description + + + #x + The value is interpreted and stored as a hexadecimal value (REG_BINARY). + + + #% + The value is interpreted and stored as an expandable string (REG_EXPAND_SZ). + + + # + The value is interpreted and stored as an integer (REG_DWORD). + + + + If the value contains the sequence tilde [~], then the value is interpreted as a Null-delimited list of strings (REG_MULTI_SZ). For example, to specify a list containing the three strings a, b and c, use "a[~]b[~]c." + The sequence [~] within the value separates the individual strings and is interpreted and stored as a Null character. + If a [~] precedes the string list, the strings are to be appended to any existing registry value strings. If an appending string already occurs in the registry value, the original occurrence of the string is removed. + If a [~] follows the end of the string list, the strings are to be prepended to any existing registry value strings. If a prepending string already occurs in the registry value, the original occurrence of the string is removed. + If a [~] is at both the beginning and the end or at neither the beginning nor the end of the string list, the strings are to replace any existing registry value strings. + Otherwise, the value is interpreted and stored as a string (REG_SZ). + + + False + + + dword + string + A dword value to input, if the value attribute is null. This removes the requirement of adding "#" before the value. + False + + + id + string + Primary key used to identify a registry record. + False + +     +
+

</value>

+

Examples

+ + Add the a couple registry entries on the target machine. + + <registry> + <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > + <value name="ProductVersion" value="1.0.0" /> + <value name="ProductDir" value="[TARGETDIR]" /> + <value name="VirtualDir" value="[TARGETVDIR]" /> + </key> + </registry> + + + + Add a default key value to the specified registry key path + + <registry> + <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > + <value value="1.0.0" /> + </key> + </registry> + + + + Another way to add a default key value to the specified registry key path + + <registry> + <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > + <value name="" value="1.0.0" /> + </key> + </registry> + + + + Specify hexadecimal value (REG_BINARY) for the default key + + <registry> + <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" > + <value> + 1a,81,0a,03,01,00,06,00,00,00,d3,15,fd,00,01,00,00,00,00,00,01, + 00,00,00,00,00,00,00,00,00,00,00,b0,90,ce,09,01,00,00,00,00,00,ff,ff,ff,00, + 00,00,00,00,00,00,00,00,6d,7a,0a,03,01,00,00,00,00,00,00,00,38,40,00,00,00, + 00,00,00,00,00,00,00,00,00,90,01,00,00,00,00,00,01,00,00,00,00,0f,00,00,00, + f0,ff,ff,ff,54,69,6d,65,73,20,4e,65,77,20,52,6f,6d,61,6e,f4,6f,d4,08,02,00 + </value> + </key> + </registry> + + + + + + + + Stores icons to be used with shortcuts, file extensions, CLSIDs or + similar uses. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Name of the icon file. + True + + + value + string + The binary icon data in PE (.dll or .exe) or icon (.ico) format. + True + + +

Examples

+ + Add a compiled help icon to the msi database; To be used with a shortcut. + + <icons> + <icon name="CHMICON" value="${resource.dir}\chm.ico" /> + </icons> + + + + + + + + Creates shortcuts on the target computer. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Unique name identifying the shortcut. + True + + + directory + string + Reference to a directory. The location of where the shortcut should be created. + True + + + filename + string + The localizable name of the shortcut to be created. + True + + + component + string + Reference to a component. The installer uses the installation state of this specified component to determine whether the shortcut is created or deleted. This component must have a valid key path for the shortcut to be installed. If the Target column contains the name of a feature, the file launched by the shortcut is the key file of the component listed in this column. + True + + + target + string + The shortcut target. The installer evaluates this field as a Formatted string. The field should contains a property identifier enclosed by square brackets ([ ]), that is expanded into the file or a folder pointed to by the shortcut. + True + + + arguments + string + The command-line arguments for the shortcut.
Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved if the property already has the intended value when the component owning the shortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the file MyDoc.doc and the component that owns the shortcut. + + False + + + hotkey + string + The hotkey for the shortcut. The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags. This must be a non-negative number. Authors of installation packages are generally recommend not to set this option, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for users using hotkeys for accessibility. + False + + + icon + string + Reference to an icon. + False + + + iconindex + int + The icon index for the shortcut. This must be a non-negative number. + False + + + showcmd + int + The Show command for the application window.
The following values may be used. The values are as defined for the Windows API function ShowWindow. + + + Value + Description + + + 1 + SW_SHOWNORMAL + + + 3 + SW_SHOWMAXIMIZED + + + 7 + SW_SHOWMINNOACTIVE + + + + False + + + wkdir + string + The name of the property that has the path of the working directory for the shortcut. + False + + +

Nested Elements:

+

<description>

+
    + The localizable description of the shortcut. +
+

</description>

+

Examples

+ + Add a compiled help icon to the msi database; To be used with a shortcut. + + <shortcuts> + <shortcut name="HelpFiles" directory="D__PROGRAMMENU_ACME_MYPRODUCT" filename="Help File" component="C__MainFiles" target="[$C__MainFiles]\Help.chm" icon="CHMICON" iconindex="0" showcmd="3" > + <description>My Product help documentation</description> + </shortcut> + </shortcuts> + + + + + + + + Stores the binary data for items such as bitmaps, animations, and + icons. The binary table is also used to store data for custom + actions. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A unique key that identifies the particular binary data. If the binary data is for a control, the key appears in the Text column of the associated control in the Control table. This key must be unique among all controls requiring binary data. + True + + + value + string + The binary file to add. + True + + +

Examples

+ + Add the custom action dll to create/modify virtual directories + + <binaries> + <binary name="MSVBDPCADLL" value="${resource.dir}\MSVBDPCA.DLL" /> + </binaries> + + + + + + + + Used to configure executables that may be run during steps in the + installation process to do things outside the bounds of MSI + technology's feature set. This is the main spot you can extend MSI + technology to perform custom processes via compiled code. + +

Parameters

+ + + Attribute + Type + Description + Required + + + action + string + Name of the action. The action normally appears in a sequence table unless it is called by another custom action. If the name matches any built-in action, then the custom action is never called. + True + + + type + string + A field of flag bits specifying the basic type of custom action and options. See Summary List of All Custom Action Types for a list of the basic types. See Custom Action Return Processing Options, Custom Action Execution Scheduling Options, Custom Action Hidden Target Option, and Custom Action In-Script Execution Options. + True + + + source + string + A property name or external key into another table. For a discussion of the possible custom action sources, see Custom Action Sources and the Summary List of All Custom Action Types. For example, the Source column may contain an external key into the first column of one of the following tables containing the source of the custom action code.
+ Directory table for calling existing executables.
+ File table for calling executables and DLLs that have just been installed.
+ Binary table for calling executables, DLLs, and data stored in the database.
+ Property table for calling executables whose paths are held by a property. + + True + + + target + string + An execution parameter that depends on the basic type of custom action. See the Summary List of All Custom Action Types for a description of what should be entered in this field for each type of custom action. For example, this field may contain the following depending on the custom action. + + + Target + Custom Action + + + Entry point (required) + Calling a DLL. + + + Executable name with arguments (required) + Calling an existing executable. + + + Command line arguments (optional) + Calling an executable just installed. + + + Target file name (required) + Creating a file from custom data. + + + Null + Executing script code. + + + + True + + +

Examples

+ + Add some custom actions related to the virtual directory dialog and custom action. + + <customactions> + <!-- Custom actions creating entry points into the custom action dll specified in the binary table --> + <customaction action="WEBCA_GatherWebFolderProperties" type="1" source="MSVBDPCADLL" target="GatherWebFolderProperties" /> + <customaction action="WEBCA_ApplyWebFolderProperties" type="1537" source="MSVBDPCADLL" target="ApplyWebFolderProperties" /> + <customaction action="WEBCA_RollbackApplyWebFolderProperties" type="1281" source="MSVBDPCADLL" target="RollbackApplyWebFolderProperties" /> + <customaction action="WEBCA_CreateURLs" type="1" source="MSVBDPCADLL" target="CreateURLs" /> + <customaction action="WEBCA_EvaluateURLs" type="1" source="MSVBDPCADLL" target="EvaluateURLs" /> + <customaction action="WEBCA_EvaluateURLsNoFail" type="1" source="MSVBDPCADLL" target="EvaluateURLsNoFail" /> + <customaction action="WEBCA_EvaluateURLsMB" type="1" source="MSVBDPCADLL" target="EvaluateURLsMB" /> + <customaction action="WEBCA_CreateAppRoots" type="1" source="MSVBDPCADLL" target="CreateAppRoots" /> + + <!-- Custom actions to set default control values in the webfolder dialog --> + <customaction action="WEBCA_TARGETVDIR" type="307" source="TARGETVDIR" target="Default VDir" /> + <customaction action="WEBCA_TARGETPORT" type="307" source="TARGETPORT" target="80" /> + </customactions> + + + + + + + + Used to modify the sequence of tasks/events that execute during the + overall installation process. + +

Parameters

+ + + Attribute + Type + Description + Required + + + type + msi:MSISequenceTable + Valid inputs: + + installexecute represents InstallExecuteSequence Table. + installui represents InstallUISequence Table + adminexecute represents AdminExecuteSequence Table + adminui represents AdminUISequence Table + advtexecute represents AdvtUISequence Table + + + True + + + action + string + Name of the action to execute. This is either a built-in action or a custom action. + True + + + value + int + Number that determines the sequence position in which this action is to be executed.
+ A positive value represents the sequence position. A Null value indicates that the action is not executed. The following + negative values indicate that this action is to be executed if the installer returns the associated termination flag. No + more than one action may have a negative value entered in the Sequence field. + + + Value + Description + + + -1 + Successful completion. + + + -2 + User terminates install. + + + -3 + Fatal exit terminates. + + + -4 + Install is suspended. + + + + True + + + condition + string + This field contains a conditional expression. If the expression evaluates to False, then the action is skipped. If the expression syntax is invalid, then the sequence terminates, returning iesBadActionData. + False + + +

Examples

+ + Add the sequences to support virtual directories + + <sequences> + <sequence type="installexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> + <sequence type="installexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> + <sequence type="installexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_GatherWebFolderProperties" value="3701" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_ApplyWebFolderProperties" value="3701" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_RollbackApplyWebFolderProperties" value="3701" condition="NOT Installed" /> + <sequence type="installexecute" action="WEBCA_CreateAppRoots" value="3701" condition="NOT Installed" /> + <sequence type="installui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> + <sequence type="installui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> + <sequence type="installui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> + <sequence type="installui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> + <sequence type="adminexecute" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> + <sequence type="adminexecute" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> + <sequence type="adminexecute" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> + <sequence type="adminexecute" action="WEBCA_EvaluateURLs" value="753" condition="NOT Installed" /> + <sequence type="adminui" action="WEBCA_TARGETVDIR" value="750" condition="TARGETVDIR=&quot;&quot;" /> + <sequence type="adminui" action="WEBCA_TARGETPORT" value="750" condition="TARGETPORT=&quot;&quot;" /> + <sequence type="adminui" action="WEBCA_CreateURLs" value="752" condition="NOT Installed" /> + <sequence type="adminui" action="WEBCA_EvaluateURLsNoFail" value="753" condition="NOT Installed" /> + </sequences> + + + + + + + + Creates text to be displayed in a progress dialog box and written + to the log for actions that take a long time to execute. The text + displayed consists of the action description and optionally formatted + data from the action. The entries in the ActionText table typically + refer to actions in sequence tables. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Unique name identifying the action. + True + + + template + string + A localized format template is used to format action data records for display during action execution. If no template is supplied, then the action data will not be displayed. + False + + +

Nested Elements:

+

<description>

+
    + Localized description displayed in the progress dialog box or written to the log when the action is executing. +
+

</description>

+

Examples

+ + Add the related action text for the web folder actions. + + <actiontext> + <action name="WEBCA_GatherWebFolderProperties" > + <description>Gathering web folder properties</description> + </action> + <action name="WEBCA_ApplyWebFolderProperties" > + <description>Applying web folder properties</description> + </action> + <action name="WEBCA_RollbackApplyWebFolderProperties" > + <description>Removing web folder properties</description> + </action> + <action name="WEBCA_CreateURLs" > + <description>Creating URLs</description> + </action> + <action name="WEBCA_EvaluateURLs" > + <description>Evaluating URLs</description> + </action> + <action name="WEBCA_EvaluateURLsNoFail" > + <description>Evaluating URLs and do not fail if URL is invalid</description> + </action> + <action name="WEBCA_EvaluateURLsMB" > + <description>Evaluating URLs</description> + </action> + <action name="WEBCA_CreateAppRoots" > + <description>Creating application roots</description> + </action> + <action name="WEBCA_TARGETVDIR" > + <description>Set TARGETVDIR property to the specified virtual dir</description> + </action> + <action name="WEBCA_TARGETPORT" > + <description>Set TARGETPORT property to the specified virtual dir port</description> + </action> + </actiontext> + + + + + + + + Adds Verbs and a handler for the specified file type. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + directory + string + Refrence to a directory. The directory to add the specific verb/handler to IIS for the specified file type. + True + + + extension + string + File name extension to specifically handle + False + + + exepath + string + Path to the Internet Server API (ISAPI) or Common Gateway Interface (CGI) program to run to process a request. + False + + + verbs + string + Internet Information Services verbs that are allowed for the executable file. Only verbs entered in this field will be allowed. + False + + +

Examples

+ + Add the aspx app mapping + + <appmappings> + <appmapping directory="D__ACME_MyProduct" extension=".aspx" exepath="[DOTNETFOLDER]aspnet_isapi.dll" verbs="GET,HEAD,POST,DEBUG" /> + </appmappings> + + + + + + + + Determines the local path equivalent for a url and stores this + information in a property. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + The name of the URLProperty to convert + True + + + property + string + The name of the property to store the directory information. + True + + +

Examples

+ + Convert the TARGETURL property to a directory and store that information in TARGETDIR + + <urlproperties> + <urlproperty name="TARGETURL" property="TARGETDIR" /> + </urlproperties> + + + + + + + + Creates a URLProperty representing the virtual directory and port. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Property containing the virtual directory + True + + + portproperty + string + Property containing the network port number to use. + True + + + urlproperty + string + URLProperty to store the url in + True + + +

Examples

+ + Convert the virtual directory and port to a url and store the value in a property. + + <vdirproperties> + <vdirproperty name="TARGETVDIR" portproperty="TARGETPORT" urlproperty="TARGETURL" /> + </vdirproperties> + + + + + + + + Create a Web application definition and marks it as running in-process + or out-of-process. If an application already exists at the specified + path, you can use this method to reconfigure the application from + in-process to out-of-process, or the reverse. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + component + string + Reference to a component. Determines when the approot will be created. + True + + + urlproperty + string + URLProperty with stored url + True + + + inprocflag + int + Specifies whether the application being created is to run in-process (0), out-of-process (1), or in a pooled process (2). If the application already exists and is running, changing the value of this flag will cause the application definition to be deleted and a new application created to run in the specified process space. + True + + +

Examples

+ + Convert the virtual directory and port to a url and store the value in a property. + + <approots> + <approot component="C__MainFiles" urlproperty="TARGETURL" inprocflag="2" /> + </approots> + + + + + + + + Specifies directory security in IIS. Can also configure the default + documents supported by each directory. + + This not an officially Microsoft supported table. +

Parameters

+ + + Attribute + Type + Description + Required + + + directory + string + Reference to a directory. This is the directory that gets modified with the specific attributes. + True + + + attr + int + Attributes to set for the directory. + + + Value + Flag Name + Description + + + 1 + AccessRead + The file or the contents of the folder may be read through Microsoft Internet Explorer. + + + 2 + AccessWrite + Users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. Write can be implemented only with a browser that supports the PUT feature of the HTTP 1.1 protocol standard. + + + 4 + AccessExecute + The file or the contents of the folder may be executed, regardless of file type. + + + 8 + AccessSSL + File access requires SSL file permission processing, with or without a client certificate. + + + 16 + AccessSource + Users are allowed to access source code if either Read or Write permissions are set. Source code includes scripts in Microsoft ® Active Server Pages (ASP) applications. + + + 32 + AccessSSLNegotiateCert + SSL file access processing requests a certificate from the client. A value of false indicates that access continues if the client does not have a certificate. Some versions of Internet Explorer will close the connection if the server requests a certificate and a certificate is not available (even if AccessSSLRequireCert is also set to true). + + + 64 + AccessSSLRequireCert + SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. AccessSSLNegotiateCert must also be set to true when using AccessSSLRequireCert. + + + 128 + AccessSSLMapCert + SSL file permission processing maps a client certificate to a Microsoft Windows ® operating system user-account. The AccessSSLNegotiateCert property must also be set to true for the mapping to occur. + + + 256 + AccessSSL128 + File access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate. + + + 512 + AccessScript + The file or the contents of the folder may be executed if they are script files or static content. A value of false only allows static files, such as HTML files, to be served. + + + 1024 + AccessNoRemoteWrite + Remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests. + + + 4096 + AccessNoRemoteRead + Remote requests to view files are denied; only requests from the same computer as the IIS server succeed if the AccessRead property is set to true. You cannot set AccessNoRemoteRead to false to enable remote requests, and set AccessRead to false to disable local requests. + + + 8192 + AccessNoRemoteExecute + Remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if the AccessExecute property is set to true. You cannot set AccessNoRemoteExecute to false to enable remote requests, and set AccessExecute to false to disable local requests. + + + 16384 + AccessNoRemoteScript + Requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests. + + + 32768 + AccessNoPhysicalDir + Access to the physical path is not allowed. + + + + True + + + defaultdoc + string + Adds a filename to the Default Documents to process. Add multiple separated with a comma (Eg. "Default.aspx,Default.htm") + False + + +

Examples

+ + Specify permissions for the directory structure. + + <iisproperties> + <iisproperty directory="TARGETDIR" attr="626" defaultdoc="Default.aspx" /> + <iisproperty directory="D__BIN" attr="112" /> + <iisproperty directory="D__SomeSubDir" attr="114" /> + </iisproperties> + + + + + + + Summary description for MsiTaskInfo. + + + + + Loads the banner image. + + The MSI database. + + + + Loads the background image. + + The MSI database. + + + + Loads the license file. + + The MSI database. + + + + Loads records for the Media table. + + The MSI database. + The sequence number of the last file in the .cab. + + + + Loads records for the Features table. + + The MSI database. + + + + Adds a feature record to the Features table. + + The MSI database Feature table. + The MSI database Condition table. + The name of this feature's parent. + The MSI database. + This Feature's Schema element. + The tree depth of this feature. + The tree order of this feature. + + + + Loads records for the LaunchCondition table + + The MSI database. + + + + Merges Merge Modules into the MSI Database. + + The MSI Database. + The path to temporary files. + + + + Creates a Windows Installer (also known as Microsoft Installer, or MSI) + setup database for installing software on the Windows Platform. + + + + Requires cabarc.exe in the path. This tool is part of the + Microsoft Cabinet SDK. + + + Requires mergemod.dll version 2.0 or greater. This dll is part of the + Microsoft Platform SDK. + + + See the Roadmap to Windows Installer Documentation + at Microsoft's MSDN website for more information. + + + + + + Initializes task and verifies parameters. + + + + + Executes the task. + + + + + An .rtf (rich text format) file containing the license agreement + for your software. The contents of this file will be displayed to + the user when setup runs and must be accepted to continue. + + + + + A .bmp (bitmap) file 495x60 pixels in size that will be displayed + as the banner (top) image of the installation user interface. + + + + + A .bmp (bitmap) file 495x315 pixels in size that will be displayed + as the background image of the installation user interface. + + + + + + Groups sets of components into named sets, these can be used to + layout the tree control that allows users to select and deselect + features of your software product when a custom installation is + selected at runtime. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + A name used to refer to the feature. + True + + + display + int + The number in this field specifies the order in which the feature is to be displayed in the user interface. + The value also determines if the feature is initially displayed expanded or collapsed.
+ If the value is null or zero, the record is not displayed. If the value is odd, the feature node is expanded initially. + If the value is even, the feature node is collapsed initially. + + True + + + title + string + Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog. + False + + + typical + bool + Determines if the feature should be included in a "typical" install. This is useful for when the user selects to just install the typical features. + False + + + directory + string + Refrence to a directory. Specify a corresponding directory to go with the feature. + False + + + attr + int + Any combination of the following: + + + Value + Description + + + 0 + Components of this feature that are not marked for installation from source are installed locally. + + + 1 + Components of this feature not marked for local installation are installed to run from the source CD-ROM or server. + + + 2 + Set this attribute and the state of the feature is the same as the state of the feature's parent. + + + 4 + Set this attribute and the feature state is Advertise. + + + 8 + Note that this bit works only with features that are listed by the ADVERTISE property.
Set this attribute to prevent the feature from being advertised. + + + 16 + Set this attribute and the user interface does not display an option to change the feature state to Absent. Setting this attribute forces the feature to the installation state, whether or not the feature is visible in the UI. + + + 32 + Set this attribute and advertising is disabled for the feature if the operating system shell does not support Windows Installer descriptors. + + + More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp + + False + + +

Nested Elements:

+

<feature>

+
    + Nested feature elements are supported. +
+

</feature>

+

<description>

+
    + Longer string of text describing the feature. This localizable string is displayed by the Text control of the Selection Dialog. +
+

</description>

+

<conditions>

+
    +

    <condition>

    +
      + + + Attribute + Type + Description + Required + + + expression + string + If this conditional expression evaluates to TRUE, then the Level column in the Feature table is set to the + conditional install level.
      + The expression in the Condition column should not contain reference to the installed state of any feature or component. + This is because the expressions in the Condition column are evaluated before the installer evaluates the installed + states of features and components. Any expression in the Condition table that attempts to check the installed state + of a feature or component always evaluates to false.
      + For information on the syntax of conditional statements, see Conditional Statement Syntax. +       + True +       + + level + int + The installer sets the install level of this feature to the level specified in this column if the expression in + the Condition column evaluates to TRUE. Set this value to 0 to have the component not install if the condition is not met.
      + For any installation, there is a defined install level, which is an integral value from 1 to 32,767. The initial value + is determined by the InstallLevel property, which is set in the Property table.
      + A feature is installed only if the feature level value is less than or equal to the current install level. The user + interface can be authored such that once the installation is initialized, the installer allows the user to modify the + install level of any feature in the Feature table. For example, an author can define install level values that represent + specific installation options, such as Complete, Typical, or Minimum, and then create a dialog box that uses + SetInstallLevel ControlEvents to enable the user to select one of these states. Depending on the state the user selects, + the dialog box sets the install level property to the corresponding value. If the author assigns Typical a level of 100 + and the user selects Typical, only those features with a level of 100 or less are installed. In addition, the Custom + option could lead to another dialog box containing a Selection Tree control. The Selection Tree would then allow the user + to individually change whether each feature is installed.       + True +       +       +
    +

    </condition>

    +
+

</conditions>

+

Examples

+ + Define a sample features structure. + + <features> + <feature name="F__Default" title="My Product" display="1" typical="true" directory="TARGETDIR"> + <description>My Product from ACME, Inc. </description> + <feature name="F__MainFiles" display="0" typical="true" /> + </feature> + <feature name="F__Help" title="My Product Help Files" display="1" typical="false" directory="D__ACME_MyProduct_Help" /> + </features> + + + + + + + + Includes pre-packaged installation components (.msm files) as part + of the msi database. This feature allows reuse of installation + components that use MSI technology from other setup vendors or as + created by the . + +

Parameters

+ + + Attribute + Type + Description + Required + + + feature + string + Refrence to a feature. Used to associate the merge module with the feature (and the feature's directory) for when to install the components in the merge module. + True + + +

Nested Elements:

+

<modules>

+
    + Specifies the merge module(s) to include with the specified feature. +
+

</modules>

+

<configurationitems>

+
    +

    <configurationitem>

    +
      + Specifies the value for a configurable item +

      Parameters

      + + + Attribute + Type + Description + Required + + + module + string + Merge module filename to limit the configuration item to. If this is not set, the configuration item will be applied to all merge modules in the fileset. + True + + + name + string + Name of item for which data is to be set + True + + + value + string + Value of the configurable item + True + + +
    +

    </configurationitem>

    +
+

</configurationitems>

+

Examples

+ + Add the NAnt merge module to the install. + + <mergemodules> + <merge feature="F__NAntMSM"> + <modules> + <include name="${nant.dir}\Install\NAnt.msm" /> </modules> </merge> </mergemodules> @@ -5704,516 +5704,516 @@ - - Summary description for MsmTaskInfo. - + + Summary description for MsmTaskInfo. + - - Loads records for the ModuleSignature table. - - The MSM database. + + Loads records for the ModuleSignature table. + + The MSM database. - - Loads records for the ModuleDependency table. - - The MSM database. + + Loads records for the ModuleDependency table. + + The MSM database. - - Loads records for the ModuleExclusion table. - - The MSM database. + + Loads records for the ModuleExclusion table. + + The MSM database. - - Loads records for the ModuleInstallUISequence, ModuleInstallExecuteSequence, - ModuleAdminUISequence, ModuleAdminExecute, and ModuleAdvtExecuteSequence tables. - - The MSM database. + + Loads records for the ModuleInstallUISequence, ModuleInstallExecuteSequence, + ModuleAdminUISequence, ModuleAdminExecute, and ModuleAdvtExecuteSequence tables. + + The MSM database. - - Loads records for the ModuleIgnoreTable table. - - The MSM database. + + Loads records for the ModuleIgnoreTable table. + + The MSM database. - - Loads records for the ModuleSubstitution table. - - The MSM database. + + Loads records for the ModuleSubstitution table. + + The MSM database. - - Loads records for the ModuleConfiguration table. - - The MSM database. + + Loads records for the ModuleConfiguration table. + + The MSM database. - - Builds a Windows Installer Merge Module (MSM) database. - - - Requires cabarc.exe in the path. This tool is part of the - Microsoft Cabinet SDK. - + + Builds a Windows Installer Merge Module (MSM) database. + + + Requires cabarc.exe in the path. This tool is part of the + Microsoft Cabinet SDK. + - - Initializes task and verifies parameters. - + + Initializes task and verifies parameters. + - - Executes the task. - + + Executes the task. + - - Stores a unique identifier for a merge module. To be used as the merge module's ModuleSignature - + + Stores a unique identifier for a merge module. To be used as the merge module's ModuleSignature + - - Specifies the numeric language ID or IDs for a merge module. - + + Specifies the numeric language ID or IDs for a merge module. + - - Stores the version number of a merge module. - + + Stores the version number of a merge module. + - - - Lists other merge modules that are required for this merge module - to operate properly. - - - Contains any number of dependency elements. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - id - string - Identifier of the merge module required - True - - - language - string - Numeric language ID of the dependent merge module. Can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. If the field contains a group language ID, any merge module with having a language code in that group satisfies the dependency. If the RequiredLanguage is set to 0, any merge module filling the other requirements satisfies the dependency. - True - - - version - string - Version of the dependent merge module. If ommited, any version fills the dependency. - False - - -

Examples

- - Make sure that the NAnt merge module is included - - <moduledependencies> - <dependency id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" /> - </moduledependencies> - - - + + + Lists other merge modules that are required for this merge module + to operate properly. + + + Contains any number of dependency elements. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + id + string + Identifier of the merge module required + True + + + language + string + Numeric language ID of the dependent merge module. Can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. If the field contains a group language ID, any merge module with having a language code in that group satisfies the dependency. If the RequiredLanguage is set to 0, any merge module filling the other requirements satisfies the dependency. + True + + + version + string + Version of the dependent merge module. If ommited, any version fills the dependency. + False + + +

Examples

+ + Make sure that the NAnt merge module is included + + <moduledependencies> + <dependency id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" /> + </moduledependencies> + + + - - - Lists other merge modules that are incompatible in the same - installer database. - - - Contains any number of exclusion elements. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - id - string - Identifier of the merge module required - True - - - language - string - Numeric language ID of the merge module in ExcludedID. The ExcludedLanguage column can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. The ExcludedLanguage column can accept negative language IDs. The meaning of the value in the ExcludedLanguage column is as follows. - - - ExcludedLanguage - Description - - - > 0 - Exclude the language IDs specified by ExcludedLanguage. - - - = 0 - Exclude no language IDs. - - - < 0 - Exclude all language IDs except those specified by ExcludedLanguage. - - - - True - - - minversion - string - Minimum version excluded from a range. If ommitted, all versions before maxversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version. - False - - - maxversion - string - Maximum version excluded from a range. If ommitted, all versions after minversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version. - False - - -

Examples

- - Exclude the all NAnt merge modules created before version 0.85.0 - - <moduleexclusions> - <exclusion id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" maxversion="0.85.0" /> - </moduleexclusions> - - - + + + Lists other merge modules that are incompatible in the same + installer database. + + + Contains any number of exclusion elements. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + id + string + Identifier of the merge module required + True + + + language + string + Numeric language ID of the merge module in ExcludedID. The ExcludedLanguage column can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. The ExcludedLanguage column can accept negative language IDs. The meaning of the value in the ExcludedLanguage column is as follows. + + + ExcludedLanguage + Description + + + > 0 + Exclude the language IDs specified by ExcludedLanguage. + + + = 0 + Exclude no language IDs. + + + < 0 + Exclude all language IDs except those specified by ExcludedLanguage. + + + + True + + + minversion + string + Minimum version excluded from a range. If ommitted, all versions before maxversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version. + False + + + maxversion + string + Maximum version excluded from a range. If ommitted, all versions after minversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version. + False + + +

Examples

+ + Exclude the all NAnt merge modules created before version 0.85.0 + + <moduleexclusions> + <exclusion id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" maxversion="0.85.0" /> + </moduleexclusions> + + + - - - Used to modify the sequence of tasks/events that execute during the - overall installation process. - -

Parameters

- - - Attribute - Type - Description - Required - - - type - msi:MSISequenceTable - Valid inputs: - - installexecute represents ModuleInstallExecuteSequence Table. - installui represents ModuleInstallUISequence Table - adminexecute represents ModuleAdminExecuteSequence Table - adminui represents ModuleAdminUISequence Table - advtexecute represents ModuleAdvtUISequence Table - - - True - - - action - string - Action to insert into sequence. Refers to one of the installer standard actions, or an entry in the merge module's CustomAction table or Dialog table.
If a standard action is used in the Action column of a merge module sequence table, the BaseAction and After attributes must be ommitted. - True - - - sequence - int - The sequence number of a standard action. If a custom action or dialog is entered into the Action column of this row, this attribute must be ommitted
When using standard actions in merge module sequence tables, the value in the Sequence column should be the recommended action sequence number. If the sequence number in the merge module differs from that for the same action in the .msi file sequence table, the merge tool uses the sequence number from the .msi file. See the suggested sequences in Using a Sequence Table for the recommended sequence numbers of standard actions. - False - - - baseaction - string - Can contain a standard action, a custom action specified in the merge module's custom action table, or a dialog specified in the module's dialog table. Is a key into the Action column of this table. It cannot be a foreign key into another merge table or table in the .msi file. This means that every standard action, custom action, or dialog listed in the BaseAction column must also be listed in the Action column of another record in this table. - False - - - after - bool - Boolean for whether Action comes before or after BaseAction - - - Value - Description - - - True - Action to come after BaseAction - - - False - Action to come before BaseAction - - - - False - - - condition - string - A conditional statement that indicates if the action is be executed. - False - - - + + + Used to modify the sequence of tasks/events that execute during the + overall installation process. + +

Parameters

+ + + Attribute + Type + Description + Required + + + type + msi:MSISequenceTable + Valid inputs: + + installexecute represents ModuleInstallExecuteSequence Table. + installui represents ModuleInstallUISequence Table + adminexecute represents ModuleAdminExecuteSequence Table + adminui represents ModuleAdminUISequence Table + advtexecute represents ModuleAdvtUISequence Table + + + True + + + action + string + Action to insert into sequence. Refers to one of the installer standard actions, or an entry in the merge module's CustomAction table or Dialog table.
If a standard action is used in the Action column of a merge module sequence table, the BaseAction and After attributes must be ommitted. + True + + + sequence + int + The sequence number of a standard action. If a custom action or dialog is entered into the Action column of this row, this attribute must be ommitted
When using standard actions in merge module sequence tables, the value in the Sequence column should be the recommended action sequence number. If the sequence number in the merge module differs from that for the same action in the .msi file sequence table, the merge tool uses the sequence number from the .msi file. See the suggested sequences in Using a Sequence Table for the recommended sequence numbers of standard actions. + False + + + baseaction + string + Can contain a standard action, a custom action specified in the merge module's custom action table, or a dialog specified in the module's dialog table. Is a key into the Action column of this table. It cannot be a foreign key into another merge table or table in the .msi file. This means that every standard action, custom action, or dialog listed in the BaseAction column must also be listed in the Action column of another record in this table. + False + + + after + bool + Boolean for whether Action comes before or after BaseAction + + + Value + Description + + + True + Action to come after BaseAction + + + False + Action to come before BaseAction + + + + False + + + condition + string + A conditional statement that indicates if the action is be executed. + False + + + - - - If a table in the merge module is listed in the ModuleIgnoreTable - table, it is not merged into the .msi file. If the table already - exists in the .msi file, it is not modified by the merge. The tables - in the ModuleIgnoreTable can therefore contain data that is unneeded - after the merge. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - table - string - Name of the table in the merge module that is not to be merged into the .msi file. - True - - -

Examples

- - Ensure the module is compatible for users who have versions of Mergemod.dll earlier than 2.0 - - <moduleignoretables> - <table name="ModuleConfiguration" /> - <table name="ModuleSubstitution" /> - <table name="_ModuleConfigurationGroup" /> - </moduleignoretables> - - - + + + If a table in the merge module is listed in the ModuleIgnoreTable + table, it is not merged into the .msi file. If the table already + exists in the .msi file, it is not modified by the merge. The tables + in the ModuleIgnoreTable can therefore contain data that is unneeded + after the merge. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + table + string + Name of the table in the merge module that is not to be merged into the .msi file. + True + + +

Examples

+ + Ensure the module is compatible for users who have versions of Mergemod.dll earlier than 2.0 + + <moduleignoretables> + <table name="ModuleConfiguration" /> + <table name="ModuleSubstitution" /> + <table name="_ModuleConfigurationGroup" /> + </moduleignoretables> + + + - - - The ModuleSubstitution table specifies the configurable fields of a - module database and provides a template for the configuration of each - field. The user or merge tool may query this table to determine what - configuration operations are to take place. This table is not merged - into the target database. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - table - string - Name of the table being modified in the module database. - True - - - row - string - Specifies the primary keys of the target row in the table named in the Table column. Multiple primary keys are separated by semicolons. Target rows are selected for modification before any changes are made to the target table. If one record in the ModuleSubstitution table changes the primary key field of a target row, other records in the ModuleSubstitution table are applied based on the original primary key data, not the resulting of primary key substitutions. The order of row substitution is undefined.
Values in this column are always in CMSM special format. A literal semicolon (';') or equal sign ('=') can be added by prefixing the character with a backslash. '\'. A null value for a key is signified by a null, a leading semicolon, two consecutive semicolons, or a trailing semicolon, depending on whether the null value is a sole, first, middle, or final key column value. - True - - - column - string - Specifies the target column in the row named in the Row column. If multiple rows in the ModuleSubstitution table change different columns of the same target row, all the column substitutions are performed before the modified row is inserted into the database. The order of column substitution is undefined. - True - - - value - string - Contains a string that provides a formatting template for the data being substituted into the target field specified by Table, Row, and Column. When a substitution string of the form [=ItemA] is encountered, the string, including the bracket characters, is replaced by the value for the configurable "ItemA." The configurable item "ItemA" is specified in the Name column of the ModuleConfiguration table and its value is provided by the merge tool. If the merge tool declines to provide a value for any item in a replacement string, the default value specified in the DefaultValue column of the ModuleConfiguration Table is substituted. If a string references an item not in the ModuleConfiguration table, the merge fails. - - - This column uses CMSM special format. A literal semicolon (';') or equals sign ('=') can be added to the table by prefixing the character with a backslash. '\'. - - - The Value field may contain multiple substitution strings. For example, the configuration of items "Food1" and "Food2" in the string: "[=Food1] is good, but [=Food2] is better because [=Food2] is more nutritious." - - - Replacement strings must not be nested. The template "[=AB[=CDE]]" is invalid. - - - If the Value field evaluates to null, and the target field is not nullable, the merge fails and an error object of type msmErrorBadNullSubstitution is created and added to the error list. For details, see the error types described in get_Type Function. - - - If the Value field evaluates to the null GUID: {00000000-0000-0000-0000-000000000000}, the null GUID is replaced by the name of the feature before the row is merged into the module. For details, see Referencing Features in Merge Modules. - - - The template in the Value field is evaluated before being inserted into the target field. Substitution into a row is done before replacing any features. - - - If the Value column evaluates to a string of only integer characters (with an optional + or -), the string is converted into an integer before being substituted into an target field of the Integer Format Type. If the template evaluates to a string that does not consist only of integer characters (and an optional + or -) the result cannot be substituted into an integer target field. Attempting to insert a non-integer into an integer field causes the merge to fail and adds a msmErrorBadSubstitutionType error object to the error list. - - - If the target column specified in the Table and Column fields is a Text Format Type, and evaluation of the Value field results in an Integer Format Type, a decimal representation of the number is inserted into the target text field. - - - If the target field is an Integer Format Type, and the Value field consists of a non-delimited list of items in Bitfield Format, the value in the target field is combined using the bitwise AND operator with the inverse of the bitwise OR of all of the mask values from the items, then combined using the bitwise OR operator with each of the integer or bitfield items when masked by their corresponding mask values. Essentially, this explicitly sets the bits from the properties to the provided values but leaves all other bits in the cell alone. - - - If the Value field evaluates to a Key Format Type, and is a key into a table that uses multiple primary keys, the item name may be followed by a semicolon and an integer value that indicates the 1-based index into the set of values that together make a primary key. If no integer is specified, the value 1 is used. For example, the Control table has two primary key columns, Dialog_ and Control. The value of an item "Item1" that is a key into the Control table will be of the form "DialogName;ControlName", where DialogName is the value in the Dialog_ table and ControlName is the value in the Control column. To substitute just ControlName, the substitution string [=Item1;2] should be used. - - - - False - - - + + + The ModuleSubstitution table specifies the configurable fields of a + module database and provides a template for the configuration of each + field. The user or merge tool may query this table to determine what + configuration operations are to take place. This table is not merged + into the target database. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + table + string + Name of the table being modified in the module database. + True + + + row + string + Specifies the primary keys of the target row in the table named in the Table column. Multiple primary keys are separated by semicolons. Target rows are selected for modification before any changes are made to the target table. If one record in the ModuleSubstitution table changes the primary key field of a target row, other records in the ModuleSubstitution table are applied based on the original primary key data, not the resulting of primary key substitutions. The order of row substitution is undefined.
Values in this column are always in CMSM special format. A literal semicolon (';') or equal sign ('=') can be added by prefixing the character with a backslash. '\'. A null value for a key is signified by a null, a leading semicolon, two consecutive semicolons, or a trailing semicolon, depending on whether the null value is a sole, first, middle, or final key column value. + True + + + column + string + Specifies the target column in the row named in the Row column. If multiple rows in the ModuleSubstitution table change different columns of the same target row, all the column substitutions are performed before the modified row is inserted into the database. The order of column substitution is undefined. + True + + + value + string + Contains a string that provides a formatting template for the data being substituted into the target field specified by Table, Row, and Column. When a substitution string of the form [=ItemA] is encountered, the string, including the bracket characters, is replaced by the value for the configurable "ItemA." The configurable item "ItemA" is specified in the Name column of the ModuleConfiguration table and its value is provided by the merge tool. If the merge tool declines to provide a value for any item in a replacement string, the default value specified in the DefaultValue column of the ModuleConfiguration Table is substituted. If a string references an item not in the ModuleConfiguration table, the merge fails. + + + This column uses CMSM special format. A literal semicolon (';') or equals sign ('=') can be added to the table by prefixing the character with a backslash. '\'. + + + The Value field may contain multiple substitution strings. For example, the configuration of items "Food1" and "Food2" in the string: "[=Food1] is good, but [=Food2] is better because [=Food2] is more nutritious." + + + Replacement strings must not be nested. The template "[=AB[=CDE]]" is invalid. + + + If the Value field evaluates to null, and the target field is not nullable, the merge fails and an error object of type msmErrorBadNullSubstitution is created and added to the error list. For details, see the error types described in get_Type Function. + + + If the Value field evaluates to the null GUID: {00000000-0000-0000-0000-000000000000}, the null GUID is replaced by the name of the feature before the row is merged into the module. For details, see Referencing Features in Merge Modules. + + + The template in the Value field is evaluated before being inserted into the target field. Substitution into a row is done before replacing any features. + + + If the Value column evaluates to a string of only integer characters (with an optional + or -), the string is converted into an integer before being substituted into an target field of the Integer Format Type. If the template evaluates to a string that does not consist only of integer characters (and an optional + or -) the result cannot be substituted into an integer target field. Attempting to insert a non-integer into an integer field causes the merge to fail and adds a msmErrorBadSubstitutionType error object to the error list. + + + If the target column specified in the Table and Column fields is a Text Format Type, and evaluation of the Value field results in an Integer Format Type, a decimal representation of the number is inserted into the target text field. + + + If the target field is an Integer Format Type, and the Value field consists of a non-delimited list of items in Bitfield Format, the value in the target field is combined using the bitwise AND operator with the inverse of the bitwise OR of all of the mask values from the items, then combined using the bitwise OR operator with each of the integer or bitfield items when masked by their corresponding mask values. Essentially, this explicitly sets the bits from the properties to the provided values but leaves all other bits in the cell alone. + + + If the Value field evaluates to a Key Format Type, and is a key into a table that uses multiple primary keys, the item name may be followed by a semicolon and an integer value that indicates the 1-based index into the set of values that together make a primary key. If no integer is specified, the value 1 is used. For example, the Control table has two primary key columns, Dialog_ and Control. The value of an item "Item1" that is a key into the Control table will be of the form "DialogName;ControlName", where DialogName is the value in the Dialog_ table and ControlName is the value in the Control column. To substitute just ControlName, the substitution string [=Item1;2] should be used. + + + + False + + + - - - Identifies the configurable attributes of the module. This table is - not merged into the database. - - - More information is available here. - -

Parameters

- - - Attribute - Type - Description - Required - - - name - string - Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table. - True - - - format - msi:MSMModuleConfigurationFormat - Specifies the format of the data being changed - - text - key - integer - bitfield - - - True - - - type - string - Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute. - False - - - contextdata - string - Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes. - False - - - defaultvalue - string - Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally.
Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state. - False - - - attr - int - Bit field containing attributes for this configurable item. Null is equivalent to 0. - - - Value - Description - - - 1 - This attribute only applies to records that list a foreign key to a module table in their DefaultValue field. - - - 2 - When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types. - - - - False - - - displayname - string - Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI. - False - - - description - string - Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform. - False - - - helplocation - string - Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available. - False - - - helpkeyword - string - Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute. - False - - - + + + Identifies the configurable attributes of the module. This table is + not merged into the database. + + + More information is available here. + +

Parameters

+ + + Attribute + Type + Description + Required + + + name + string + Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table. + True + + + format + msi:MSMModuleConfigurationFormat + Specifies the format of the data being changed + + text + key + integer + bitfield + + + True + + + type + string + Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute. + False + + + contextdata + string + Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes. + False + + + defaultvalue + string + Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally.
Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state. + False + + + attr + int + Bit field containing attributes for this configurable item. Null is equivalent to 0. + + + Value + Description + + + 1 + This attribute only applies to records that list a foreign key to a module table in their DefaultValue field. + + + 2 + When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types. + + + + False + + + displayname + string + Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI. + False + + + description + string + Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform. + False + + + helplocation + string + Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available. + False + + + helpkeyword + string + Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute. + False + + + - - Maintains a forward reference to a .tlb file - in the same directory as an assembly .dll - that has been registered for COM interop. - + + Maintains a forward reference to a .tlb file + in the same directory as an assembly .dll + that has been registered for COM interop. + @@ -6226,106 +6226,106 @@ The name of the Assembly's component. - - Retrieves the name of the Assembly's component. - - The Assembly's component Name. + + Retrieves the name of the Assembly's component. + + The Assembly's component Name. - - Retrieves the typelibrary filename. - - The typelibrary filename. + + Retrieves the typelibrary filename. + + The typelibrary filename. - - Retrieves the typelibrary id. - - The typelibrary id. + + Retrieves the typelibrary id. + + The typelibrary id. - - Retrieves the name of the assembly. - - The name of the assembly. + + Retrieves the name of the assembly. + + The name of the assembly. - - Retrieves the feature containing the typelibrary's file. - - The feature containing the typelibrary's file. + + Retrieves the feature containing the typelibrary's file. + + The feature containing the typelibrary's file. - - A task that generates a summary HTML - from a set of NUnit xml report files. - - - - This task can generate a combined HTML report out of a set of NUnit - result files generated using the XML Result Formatter. - - - All the properties defined in the current project will be passed - down to the XSLT file as template parameters, so you can access - properties such as nant.project.name, nant.version, etc. - - - - - - - - - - ]]> - - + + A task that generates a summary HTML + from a set of NUnit xml report files. + + + + This task can generate a combined HTML report out of a set of NUnit + result files generated using the XML Result Formatter. + + + All the properties defined in the current project will be passed + down to the XSLT file as template parameters, so you can access + properties such as nant.project.name, nant.version, etc. + + + + + + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Load a stylesheet from the assemblies resource stream. - - File name of the file to extract. + + Load a stylesheet from the assemblies resource stream. + + File name of the file to extract. - - Load a stylesheet from the file system. - - The XSLT file to load. + + Load a stylesheet from the file system. + + The XSLT file to load. - - Initializes the XmlDocument instance - used to summarize the test results - - + + Initializes the XmlDocument instance + used to summarize the test results + + - - Builds an XsltArgumentList with all - the properties defined in the - current project as XSLT parameters. - - + + Builds an XsltArgumentList with all + the properties defined in the + current project as XSLT parameters. + + - - Run the transform and output to filename - - - + + Run the transform and output to filename + + + @@ -6334,30 +6334,30 @@ - - The output language. - + + The output language. + - - Open all description method. Default to "false". - + + Open all description method. Default to "false". + - - The directory where the files resulting from the transformation - should be written to. The default is the project's base directory. - + + The directory where the files resulting from the transformation + should be written to. The default is the project's base directory. + - - Set of XML files to use as input - + + Set of XML files to use as input + - - Set of summary XML files to use as input. - + + Set of summary XML files to use as input. + @@ -6366,43 +6366,43 @@ - - Custom XmlResolver used to load the - XSLT files out of this assembly resources. - + + Custom XmlResolver used to load the + XSLT files out of this assembly resources. + - - Loads the specified file from our internal resources if its there - - - - - + + Loads the specified file from our internal resources if its there + + + + + - - Open file(s) in a client workspace for addition to the depot. - - - - Add all cs files under the given directory into the "new" changelist - (will be created if it doesn't already exist). - - - - ]]> - - - - Add Test.txt into the default changelist. - - - ]]> - - + + Open file(s) in a client workspace for addition to the depot. + + + + Add all cs files under the given directory into the "new" changelist + (will be created if it doesn't already exist). + + + + ]]> + + + + Add Test.txt into the default changelist. + + + ]]> + + @@ -6421,76 +6421,76 @@ - - Execute the perforce command assembled by subclasses. - + + Execute the perforce command assembled by subclasses. + - - The p4 server and port to connect to. The default is "perforce:1666". - + + The p4 server and port to connect to. The default is "perforce:1666". + - - The p4 client spec to use. The default is the current client. - + + The p4 client spec to use. The default is the current client. + - - The p4 username. The default is the current user. - + + The p4 username. The default is the current user. + - - The client, branch or label view to operate upon. The default is - "//...". - + + The client, branch or label view to operate upon. The default is + "//...". + - - Prepends a descriptive field (for example, text:, info:, error:, exit:) - to each line of output produced by a Perforce command. This is most - often used when scripting. The default is . - + + Prepends a descriptive field (for example, text:, info:, error:, exit:) + to each line of output produced by a Perforce command. This is most + often used when scripting. The default is . + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + - - Override the ExeName paramater for p4.exe - + + Override the ExeName paramater for p4.exe + - - Derived classes should override this to provide command-specific - commandline arguments. - + + Derived classes should override this to provide command-specific + commandline arguments. + - - Build the command string for this particular command. - - - The command string for this particular command. - + + Build the command string for this particular command. + + + The command string for this particular command. + - - File(s) to add. File name can contain wildcard characters. (Note: - this is not using p4 wildcard syntax, but the OS wildcards). - + + File(s) to add. File name can contain wildcard characters. (Note: + this is not using p4 wildcard syntax, but the OS wildcards). + - - Changelist that files will be added into. Changelist will be created - if not already present. - + + Changelist that files will be added into. Changelist will be created + if not already present. + @@ -6499,906 +6499,906 @@ - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Create or delete a changelist specification. - - - Create a new changelist called "mynewchange". - - - ]]> - - - - Delete the changelist called "mynewchange". - - - ]]> - - + + Create or delete a changelist specification. + + + Create a new changelist called "mynewchange". + + + ]]> + + + + Delete the changelist called "mynewchange". + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to create or delete. - + + Changelist to create or delete. + - - If causes passed in changelist to be - deleted. The default is . - + + If causes passed in changelist to be + deleted. The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Add/modify/delete a client spec in perforce. - - - - Add a client (modify if already present and have sufficient rights). - - - - ]]> - - - - Delete a client. - - - ]]> - - + + Add/modify/delete a client spec in perforce. + + + + Add a client (modify if already present and have sufficient rights). + + + + ]]> + + + + Delete a client. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Name of client to create/delete. - + + Name of client to create/delete. + - - Root path for client spec. - + + Root path for client spec. + - - Delete the named client. The default is . - + + Delete the named client. The default is . + - - Force a delete even if files are open. The default is - . - + + Force a delete even if files are open. The default is + . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Open file(s) in a client workspace for deletion from the depot. - - - - Mark all cs files under the give view for deletion and place them in - the "Deleting" changelist. - - - - ]]> - - + + Open file(s) in a client workspace for deletion from the depot. + + + + Mark all cs files under the give view for deletion and place them in + the "Deleting" changelist. + + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to place the marked for deletion item into. - + + Changelist to place the marked for deletion item into. + - - The client, branch or label view to operate upon. - + + The client, branch or label view to operate upon. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Opens file(s) in a client workspace for edit. - - - - Open all files in the ProjectX Test folder for edit, and place into - the default changelist. - - - - ]]> - - - - - Open all *.txt files in the ProjectX Test folder for edit, and place - into the "testing" changelist. - - - - ]]> - - + + Opens file(s) in a client workspace for edit. + + + + Open all files in the ProjectX Test folder for edit, and place into + the default changelist. + + + + ]]> + + + + + Open all *.txt files in the ProjectX Test folder for edit, and place + into the "testing" changelist. + + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to place the opened files into. - + + Changelist to place the opened files into. + - - File Type settings. - + + File Type settings. + - - The client, branch or label view to operate upon. - + + The client, branch or label view to operate upon. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Returns information from the "p4 info" command back into variables for - use within the build process. - - - Fill the variables using the task. - - - - ]]> - - + + Returns information from the "p4 info" command back into variables for + use within the build process. + + + Fill the variables using the task. + + + + ]]> + + - - The name of the property to store the p4 user name in. - + + The name of the property to store the p4 user name in. + - - The name of the property to store the p4 client name in. - + + The name of the property to store the p4 client name in. + - - The name of the property to store the p4 host name in. - + + The name of the property to store the p4 host name in. + - - The name of the property to store the p4 client root in. - + + The name of the property to store the p4 client root in. + - - Create or edit a label specification and its view. - - - Create a new label called "SDK_V1.2". - - - ]]> - - - - Delete the previously created label. - - - ]]> - - + + Create or edit a label specification and its view. + + + Create a new label called "SDK_V1.2". + + + ]]> + + + + Delete the previously created label. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Name of label to create/delete. - + + Name of label to create/delete. + - - Delete the named label. The default is . - + + Delete the named label. The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Synchronize a label with the contents of the current client workspace. - - - Apply a previously created label to the specified view. - - - ]]> - - + + Synchronize a label with the contents of the current client workspace. + + + Apply a previously created label to the specified view. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Name of the label to sync the specified or default view with. - + + Name of the label to sync the specified or default view with. + - - Delete the view defined in the label, or matching the input view - from the label. The default is . - + + Delete the view defined in the label, or matching the input view + from the label. The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Fetch a specific file from a Perforce depot without needing a clientspec - to map it. - - - - - - ]]> - - + + Fetch a specific file from a Perforce depot without needing a clientspec + to map it. + + + + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - The depot or local filename (including optional path) of the file - to fetch. - + + The depot or local filename (including optional path) of the file + to fetch. + - - The local filename to write the fetched file to. - + + The local filename to write the fetched file to. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Move opened files between changelists or change the files’ type. - - - This task has two different but related uses: - Moving opened files between changelists (default or named). - Changing the type of an opened file. - - - - Move the specified files matching the view into the "New" changelist. - - - - ]]> - - - - - Modify the specified files matching the view to the given file type. - The change won't affect the repository until submitted. - - - - ]]> - - + + Move opened files between changelists or change the files’ type. + + + This task has two different but related uses: + Moving opened files between changelists (default or named). + Changing the type of an opened file. + + + + Move the specified files matching the view into the "New" changelist. + + + + ]]> + + + + + Modify the specified files matching the view to the given file type. + The change won't affect the repository until submitted. + + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - The client, branch or label view to operate upon. - + + The client, branch or label view to operate upon. + - - Changelist to place the reopened files into. - + + Changelist to place the reopened files into. + - - File Type settings. - + + File Type settings. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Discard changes made to open files. - - - Revert all txt files in a given changelist. - - - ]]> - - - - - Revert all unchanged files opened in the given changelist. - - - - ]]> - - - - Revert all unchanged files opened in any changelist. - - - ]]> - - + + Discard changes made to open files. + + + Revert all txt files in a given changelist. + + + ]]> + + + + + Revert all unchanged files opened in the given changelist. + + + + ]]> + + + + Revert all unchanged files opened in any changelist. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to perform the revert action on. optional. - + + Changelist to perform the revert action on. optional. + - - Revert all unchanged or missing files from the changelist. default is false. optional. - + + Revert all unchanged or missing files from the changelist. default is false. optional. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Set registry variables that perforce uses. - - - Note: the environment variables that p4 uses will be set, but will not - be validated. - - - Modify any of the three variables (at least one required). - - - ]]> - - + + Set registry variables that perforce uses. + + + Note: the environment variables that p4 uses will be set, but will not + be validated. + + + Modify any of the three variables (at least one required). + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Send changes made to open files to the depot. - - - - Submit changelist "Temp", but first revert all unchanged files in the - changelist. - - - - ]]> - - - - Submit changelist, but leave the files open afterwards. - - - ]]> - - + + Send changes made to open files to the depot. + + + + Submit changelist "Temp", but first revert all unchanged files in the + changelist. + + + + ]]> + + + + Submit changelist, but leave the files open afterwards. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - - Changelist to submit. - + + Changelist to submit. + - - Keep the files open after submitting. The default is - . - + + Keep the files open after submitting. The default is + . + - - Revert all unchanged or missing files from the changelist. - The default is . - + + Revert all unchanged or missing files from the changelist. + The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Synchronize client space to a Perforce depot view. - - - - Sync to head using P4USER, P4PORT and P4CLIENT settings specified. - - - - ]]> - - - - Sync to head using default p4 environment variables. - - - ]]> - - - - Force a re-sync to head, refreshing all files. - - - ]]> - - - - Sync to a label. - - - ]]> - - + + Synchronize client space to a Perforce depot view. + + + + Sync to head using P4USER, P4PORT and P4CLIENT settings specified. + + + + ]]> + + + + Sync to head using default p4 environment variables. + + + ]]> + + + + Force a re-sync to head, refreshing all files. + + + ]]> + + + + Sync to a label. + + + ]]> + + - - Builds the command string for this particular command. - - - The command string for this particular command. - + + Builds the command string for this particular command. + + + The command string for this particular command. + - Label to sync client to; optional. - + Label to sync client to; optional. + - - Force a refresh of files. The default is . - + + Force a refresh of files. The default is . + - - This is an override used by the base class to get command specific args. - + + This is an override used by the base class to get command specific args. + - - Static helper class for Perforce tasks. - + + Static helper class for Perforce tasks. + - - ask p4 for the user name - - + + ask p4 for the user name + + - - ask p4 for the client name - - + + ask p4 for the client name + + - - Get a changelist number based on on its name - - - - - - + + Get a changelist number based on on its name + + + + + + - - Get a changelist number based on on its name - - - - - + + Get a changelist number based on on its name + + + + + - - Create a new label - - - - + + Create a new label + + + + - - Create a new Client - - - - - + + Create a new Client + + + + + - - Create a new changelist - - - - Description of Changelist - + + Create a new changelist + + + + Description of Changelist + - - call the p4 process to - - - + + call the p4 process to + + + - - call the p4 process to - - - + + call the p4 process to + + + - - Execute a process and return its ourput - - - - - + + Execute a process and return its ourput + + + + + - - Execute a process and return its ourput - - - - - - + + Execute a process and return its ourput + + + + + + - - Execute a process by name - - - - - + + Execute a process by name + + + + + - - Adds files to a PVCS repository. - - - - This task uses the addfiles PCLI command to add files to a PVCS repository. - - - - - Adds File1.txt and File2.txt to the root level of the - project database specified by the project-database property. - - - - - - - - - ]]> - - - - - Adds File1.txt and File2.txt to the folder project - of the project database specified by the project-database - property. - - - - - - - - - ]]> - - - - - Adds another_file.txt and all files and folders at and below - C:\Data to the project database specified by the project-database - property. - - - - - - - - - ]]> - - - - - Adds all files at and below C:\Data\ to the project database specified by the project-database - property. Workfiles will be copied to the workfile location and will overwrite any existing files (as - dictated by the copymode attribute). The relevant revisions will be locked in PVCS. Added files - will be assigned the SYSTEST promotion group. - - - - - - - - ]]> - - + + Adds files to a PVCS repository. + + + + This task uses the addfiles PCLI command to add files to a PVCS repository. + + + + + Adds File1.txt and File2.txt to the root level of the + project database specified by the project-database property. + + + + + + + + + ]]> + + + + + Adds File1.txt and File2.txt to the folder project + of the project database specified by the project-database + property. + + + + + + + + + ]]> + + + + + Adds another_file.txt and all files and folders at and below + C:\Data to the project database specified by the project-database + property. + + + + + + + + + ]]> + + + + + Adds all files at and below C:\Data\ to the project database specified by the project-database + property. Workfiles will be copied to the workfile location and will overwrite any existing files (as + dictated by the copymode attribute). The relevant revisions will be locked in PVCS. Added files + will be assigned the SYSTEST promotion group. + + + + + + + + ]]> + + - - Base class for all PVCS project database tasks that operate against one or more entities. - + + Base class for all PVCS project database tasks that operate against one or more entities. + - - A base class for PVCS tasks that deal with project databases. - - - - This class can be used as a base class for PVCS tasks that operate against a project database. It provides - common attributes and functionality for such tasks. - - + + A base class for PVCS tasks that deal with project databases. + + + + This class can be used as a base class for PVCS tasks that operate against a project database. It provides + common attributes and functionality for such tasks. + + - - Base class functionality for all PVCS tasks. - + + Base class functionality for all PVCS tasks. + - - This is the PCLI process that is run by this task. - + + This is the PCLI process that is run by this task. + - - Starts the process that is wrapped by this PVCS task. - - - Provided only to seal the implementation of StartProcess(). - - The process that was started. + + Starts the process that is wrapped by this PVCS task. + + + Provided only to seal the implementation of StartProcess(). + + The process that was started. - - Executes the task. - - - Provided only to seal the implementation of ExecuteTask(). - + + Executes the task. + + + Provided only to seal the implementation of ExecuteTask(). + - - Prepares the process wrapped by this task for execution. - - The process to prepare for execution. + + Prepares the process wrapped by this task for execution. + + The process to prepare for execution. - - Allows tasks to add their task-specific arguments to the collection of arguments to be passed to the - PVCS command-line tool. - - The collection of arguments. + + Allows tasks to add their task-specific arguments to the collection of arguments to be passed to the + PVCS command-line tool. + + The collection of arguments. - - Constructs the program arguments that should be used when executing the wrapped PVCS process. - - A string containing the program arguments. + + Constructs the program arguments that should be used when executing the wrapped PVCS process. + + A string containing the program arguments. - - Gets or sets the location of the PVCS binary command-line tools. - - - - Generally, the PVCS command-line tools will be available on the current path. However, if this is not - the case then this property allows an exact location to be specified. If this property is not set, the - task will assume that the PVCS binaries are available on the current path. - - + + Gets or sets the location of the PVCS binary command-line tools. + + + + Generally, the PVCS command-line tools will be available on the current path. However, if this is not + the case then this property allows an exact location to be specified. If this property is not set, the + task will assume that the PVCS binaries are available on the current path. + + - - Gets or sets the process that is run as a result of running this task. - + + Gets or sets the process that is run as a result of running this task. + - - Gets the program arguments with which to run the wrapped PVCS process. - + + Gets the program arguments with which to run the wrapped PVCS process. + - - Gets the executable name for the command-line tool to run for the PVCS task. - + + Gets the executable name for the command-line tool to run for the PVCS task. + - - Gets the PCLI command name that corresponds to the operation the task performs. - - - - By default, this property will return the name of the task minus the starting "pvcs". Subclasses need - only override this property if there is a mismatch between the task name and the PCLI command name. - - + + Gets the PCLI command name that corresponds to the operation the task performs. + + + + By default, this property will return the name of the task minus the starting "pvcs". Subclasses need + only override this property if there is a mismatch between the task name and the PCLI command name. + + @@ -7428,86 +7428,86 @@ - - Gets or sets a value indicating whether the operation should include subprojects. - - - - This is equivalent to the -z command-line option. - - + + Gets or sets a value indicating whether the operation should include subprojects. + + + + This is equivalent to the -z command-line option. + + - - Gets a value indicating whether the specific task implementation supports the includesubprojects - task attribute. If not, an exception will be thrown if an attempt is made to set the attribute. - + + Gets a value indicating whether the specific task implementation supports the includesubprojects + task attribute. If not, an exception will be thrown if an attempt is made to set the attribute. + - - Gets or sets the password to use when connecting to the project database. - - - - This is equivalent to the password part of the -id command-line option. - - + + Gets or sets the password to use when connecting to the project database. + + + + This is equivalent to the password part of the -id command-line option. + + - - Gets or sets the user ID to use when connecting to the project database. - - - - This is equivalent to the user ID part of the -id command-line option. - - + + Gets or sets the user ID to use when connecting to the project database. + + + + This is equivalent to the user ID part of the -id command-line option. + + - - Gets or sets the workspace to use when connecting to the project database. - - - - This is equivalent to the -sp command-line option. - - + + Gets or sets the workspace to use when connecting to the project database. + + + + This is equivalent to the -sp command-line option. + + - - Gets or sets the project database to utilize during the operation. - - - - This is equivalent to the -pr command-line option. - - + + Gets or sets the project database to utilize during the operation. + + + + This is equivalent to the -pr command-line option. + + - - Gets or sets the project path to utilize during the operation. - - - - This is equivalent to the -pp command-line option. - - + + Gets or sets the project path to utilize during the operation. + + + + This is equivalent to the -pp command-line option. + + - - Constructs and initializes an instance of PVCSMultipleEntityTask. - + + Constructs and initializes an instance of PVCSMultipleEntityTask. + - - Gets or sets the entities involved in the operation. - + + Gets or sets the entities involved in the operation. + @@ -7534,89 +7534,89 @@ - - Constructs and initializes an instance of PVCSAddFilesTask. - + + Constructs and initializes an instance of PVCSAddFilesTask. + - - Gets or sets the archive description for versioned files. - - - - This is equivalent to the -t parameter to the pcli addfiles command. - - + + Gets or sets the archive description for versioned files. + + + + This is equivalent to the -t parameter to the pcli addfiles command. + + - - Gets or sets the copy mode for the operation. - + + Gets or sets the copy mode for the operation. + - - Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS. - - - - This is equivalent to the -d parameter to the pcli addfiles command. - - + + Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS. + + + + This is equivalent to the -d parameter to the pcli addfiles command. + + - - Gets or sets the description for versioned files. - - - - This is equivalent to the -m parameter to the pcli addfiles command. - - + + Gets or sets the description for versioned files. + + + + This is equivalent to the -m parameter to the pcli addfiles command. + + - - Gets or sets a value indicating whether versioned files should be locked after being added to PVCS. - - - - This is equivalent to the -l parameter to the pcli addfiles command. - - + + Gets or sets a value indicating whether versioned files should be locked after being added to PVCS. + + + + This is equivalent to the -l parameter to the pcli addfiles command. + + - - Gets or sets the promotion group to which added files will be assigned. Setting this attribute to an - empty string indicates the versioned files will not be assigned to any promotion group. - - - - This is equivalent to the -g parameter to the pcli addfiles command. - - + + Gets or sets the promotion group to which added files will be assigned. Setting this attribute to an + empty string indicates the versioned files will not be assigned to any promotion group. + + + + This is equivalent to the -g parameter to the pcli addfiles command. + + - - Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS - repository. - - - - This is equivalent to the -qw parameter to the pcli addfiles command. - - + + Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS + repository. + + + + This is equivalent to the -qw parameter to the pcli addfiles command. + + - - Gets or sets the version label to assign to the added versioned files. - - - - This is equivalent to the -v parameter to the pcli addfiles command. - - + + Gets or sets the version label to assign to the added versioned files. + + + + This is equivalent to the -v parameter to the pcli addfiles command. + + @@ -7624,52 +7624,52 @@ - - Indicates the default copy mode should be used. - + + Indicates the default copy mode should be used. + - - Indicates that workfiles should be copied to the project workfile location is it doesn't already exist. - + + Indicates that workfiles should be copied to the project workfile location is it doesn't already exist. + - - Indicates that workfiles should be copied to the project workfile location and overwrite any existing - workfile. - + + Indicates that workfiles should be copied to the project workfile location and overwrite any existing + workfile. + - - Adds a user to a PVCS project or project database. - - - - This task uses the adduser PCLI command to add the user to the PVCS project or database. - - - - - Adds a user with name kb and password *Muse* to the project database specified by the - project-database property. - - - - ]]> - - - - - Adds a user with name kb and password *Muse* to the project database specified by the - project-database property. The user's logon will expire on the 26th of October, 2005. - - - - ]]> - - + + Adds a user to a PVCS project or project database. + + + + This task uses the adduser PCLI command to add the user to the PVCS project or database. + + + + + Adds a user with name kb and password *Muse* to the project database specified by the + project-database property. + + + + ]]> + + + + + Adds a user with name kb and password *Muse* to the project database specified by the + project-database property. The user's logon will expire on the 26th of October, 2005. + + + + ]]> + + @@ -7681,71 +7681,71 @@ - - Constructs and initializes an instance of PVCSAddUserTask. - + + Constructs and initializes an instance of PVCSAddUserTask. + - - Gets or sets the expiration date for the new user. - - - - This is equivalent to the -e parameter to the pcli adduser command. - - + + Gets or sets the expiration date for the new user. + + + + This is equivalent to the -e parameter to the pcli adduser command. + + - - Gets or sets the password for the new user. - + + Gets or sets the password for the new user. + - - Gets or sets the user name for the new user. - + + Gets or sets the user name for the new user. + - - Assigns a promotion group to versioned files. - - - - This task uses the assigngroup PCLI command to assign the group to versioned files. - - - - - Assigns the SYSTEST promotion group to all entities with the DEV promotion group in the - folder project. - - - - ]]> - - - - - Assigns the SYSTEST promotion group to revision 1.2 of all entities. - - - - ]]> - - + + Assigns a promotion group to versioned files. + + + + This task uses the assigngroup PCLI command to assign the group to versioned files. + + + + + Assigns the SYSTEST promotion group to all entities with the DEV promotion group in the + folder project. + + + + ]]> + + + + + Assigns the SYSTEST promotion group to revision 1.2 of all entities. + + + + ]]> + + - - Base class for all PVCS project database tasks that operate against a single entity. - + + Base class for all PVCS project database tasks that operate against a single entity. + @@ -7754,9 +7754,9 @@ - - Gets or sets the entity involved in the operation. - + + Gets or sets the entity involved in the operation. + @@ -7771,85 +7771,85 @@ - - Constructs and initializes an instance of PVCSAssignGroupTask. - + + Constructs and initializes an instance of PVCSAssignGroupTask. + - - Gets or sets the promotion group to assign to the versioned files. - - - - This is equivalent to the -g parameter to the pcli assigngroup command. - - + + Gets or sets the promotion group to assign to the versioned files. + + + + This is equivalent to the -g parameter to the pcli assigngroup command. + + - - Gets or sets the promotion group for the versioned files to be assigned the promotion group. - - - - This is equivalent to the -r parameter to the pcli assigngroup command. - - + + Gets or sets the promotion group for the versioned files to be assigned the promotion group. + + + + This is equivalent to the -r parameter to the pcli assigngroup command. + + - - Gets or sets the revision for the versioned files to be assigned the promotion group. - - - - This is equivalent to the -r parameter to the pcli assigngroup command. - - - If this property has not yet been set, it will return Double.MaxValue. - - + + Gets or sets the revision for the versioned files to be assigned the promotion group. + + + + This is equivalent to the -r parameter to the pcli assigngroup command. + + + If this property has not yet been set, it will return Double.MaxValue. + + - - Gets or sets the version label for the versioned files to be assigned the promotion group. - - - - This is equivalent to the -r parameter to the pcli assigngroup command. - - + + Gets or sets the version label for the versioned files to be assigned the promotion group. + + + + This is equivalent to the -r parameter to the pcli assigngroup command. + + - - Changes the promotion group for specified versioned files. - - - - This task uses the changegroup PCLI command to change the group for versioned files. - - - - - Changes the promotion group for file.txt from SYSTEST to DEV. - - - - ]]> - - - - - Changes the promotion group for all files from DEV to PROD. - - - - ]]> - - + + Changes the promotion group for specified versioned files. + + + + This task uses the changegroup PCLI command to change the group for versioned files. + + + + + Changes the promotion group for file.txt from SYSTEST to DEV. + + + + ]]> + + + + + Changes the promotion group for all files from DEV to PROD. + + + + ]]> + + @@ -7861,24 +7861,24 @@ - - Gets or sets the promotion group to change from. - - - - This is equivalent to the -gf parameter to the pcli changegroup command. - - + + Gets or sets the promotion group to change from. + + + + This is equivalent to the -gf parameter to the pcli changegroup command. + + - - Gets or sets the promotion group to change to. - - - - This is equivalent to the -gt parameter to the pcli changegroup command. - - + + Gets or sets the promotion group to change to. + + + + This is equivalent to the -gt parameter to the pcli changegroup command. + + @@ -7930,48 +7930,48 @@ The value for the command, or null if no value applies. - - Constructs an instance of PVCSCommandArgument with the specified information. - - The command string. - The value for the command, or null if no value applies. - The position for the command. + + Constructs an instance of PVCSCommandArgument with the specified information. + + The command string. + The value for the command, or null if no value applies. + The position for the command. - - Compares two PVCS command arguments based on their position. - - The PVCS command argument to compare to this. - - Less than zero if this instance is less than . - Zero if this instance is equal to . - Greater than zero if this instance is greater than . - + + Compares two PVCS command arguments based on their position. + + The PVCS command argument to compare to this. + + Less than zero if this instance is less than . + Zero if this instance is equal to . + Greater than zero if this instance is greater than . + - - Converts this command argument to its string representation. - - The string representation of this command argument. + + Converts this command argument to its string representation. + + The string representation of this command argument. - - Escapes a string command line argument. - - - - This method attempts to deal with the mess of keeping both PCLI and the shell happy with string - arguments. It's not perfect yet (try an argument with several backslashes before a double quote). It - would be nice to have a regex to handle this but I wouldn't even bother until this logic is spot on. - - - The string argument to escape. - The escaped string argument. + + Escapes a string command line argument. + + + + This method attempts to deal with the mess of keeping both PCLI and the shell happy with string + arguments. It's not perfect yet (try an argument with several backslashes before a double quote). It + would be nice to have a regex to handle this but I wouldn't even bother until this logic is spot on. + + + The string argument to escape. + The escaped string argument. - - Gets a string that contains the command to pass to PVCS. - + + Gets a string that contains the command to pass to PVCS. + @@ -7984,9 +7984,9 @@ - - Gets the position for the command. - + + Gets the position for the command. + @@ -7997,35 +7997,35 @@ - - Adds a new command argument to this collection with the specified information. - - The command string for the new command. + + Adds a new command argument to this collection with the specified information. + + The command string for the new command. - - Adds a new command argument to this collection with the specified information. - - The command string for the new command. - - The command value for the new command, or null if no value applies. - + + Adds a new command argument to this collection with the specified information. + + The command string for the new command. + + The command value for the new command, or null if no value applies. + - - Adds a new command argument to this collection with the specified information. - - The command string for the new command. - - The command value for the new command, or null if no value applies. - - The position for the new command. + + Adds a new command argument to this collection with the specified information. + + The command string for the new command. + + The command value for the new command, or null if no value applies. + + The position for the new command. - - Adds all specified command arguments to this collection. - - The collection of command arguments to add. + + Adds all specified command arguments to this collection. + + The collection of command arguments to add. @@ -8081,15 +8081,15 @@ - - Arguments that should appear before the PCLI command argument. This is useful for arguments to PCLI - itself (as opposed to the PCLI command). - + + Arguments that should appear before the PCLI command argument. This is useful for arguments to PCLI + itself (as opposed to the PCLI command). + - - PCLI command arguments that should appear before other PCLI command arguments. - + + PCLI command arguments that should appear before other PCLI command arguments. + @@ -8098,30 +8098,30 @@ - - PCLI command arguments that should appear after other PCLI command arguments. - + + PCLI command arguments that should appear after other PCLI command arguments. + - - Creates a project in a PVCS repository. - - - - This task uses the createproject PCLI command to create the project in the PVCS repository. - - - - - Creates a project called Songs in the project database specified by the project-database - property. The workfile location for the project is set to C:\Work\Songs. - - - - ]]> - - + + Creates a project in a PVCS repository. + + + + This task uses the createproject PCLI command to create the project in the PVCS repository. + + + + + Creates a project called Songs in the project database specified by the project-database + property. The workfile location for the project is set to C:\Work\Songs. + + + + ]]> + + @@ -8130,49 +8130,49 @@ - - Gets or sets the workfile location for the created project. - - - - This is equivalent to the -w parameter to the pcli createproject command. - - + + Gets or sets the workfile location for the created project. + + + + This is equivalent to the -w parameter to the pcli createproject command. + + - - Removes a specified promotion group from versioned files. - - - - This task uses the deletegroup PCLI command to remove the promotion group from the versioned files. - - - - - Removes the DEV promotion group from App.ico in the project database specified by the - project-database property. - - - - ]]> - - - - - Removes the DEV promotion group all files in the project database specified by the - project-database property. - - - - ]]> - - + + Removes a specified promotion group from versioned files. + + + + This task uses the deletegroup PCLI command to remove the promotion group from the versioned files. + + + + + Removes the DEV promotion group from App.ico in the project database specified by the + project-database property. + + + + ]]> + + + + + Removes the DEV promotion group all files in the project database specified by the + project-database property. + + + + ]]> + + @@ -8181,55 +8181,55 @@ - - Gets or sets the promotion group to delete. - - - - This is equivalent to the -g parameter to the pcli deletegroup command. - - + + Gets or sets the promotion group to delete. + + + + This is equivalent to the -g parameter to the pcli deletegroup command. + + - - Removes a label from specified versioned files or projects. - - - - This task uses the deletelabel PCLI command to remove the version label from the versioned files. - - - - - Removes the label called My Label from the versioned file called App.ico from the project - database specified by the project-database property. - - - - - - - - ]]> - - - - - Removes the label called My Label from all files at and below both folder1 and folder2 - in the project database specified by the project-database property. - - - - - - - - - ]]> - - + + Removes a label from specified versioned files or projects. + + + + This task uses the deletelabel PCLI command to remove the version label from the versioned files. + + + + + Removes the label called My Label from the versioned file called App.ico from the project + database specified by the project-database property. + + + + + + + + ]]> + + + + + Removes the label called My Label from all files at and below both folder1 and folder2 + in the project database specified by the project-database property. + + + + + + + + + ]]> + + @@ -8238,85 +8238,85 @@ - - Gets or sets the version label to remove. - - - - This is equivalent to the -v parameter to the pcli deletelabel command. - - + + Gets or sets the version label to remove. + + + + This is equivalent to the -v parameter to the pcli deletelabel command. + + - - Deletes folder, projects, versioned items and workspaces in a PVCS repository. - - - - This task uses the delete PCLI command to delete the items. - - - - - Deletes the versioned file called App.ico from the project database specified by the - project-database property. - - - - - - - - ]]> - - - - - Deletes the files called file1.txt and file2.txt from the project called folder in the - project database specified by the project-database property. - - - - - - - - - ]]> - - + + Deletes folder, projects, versioned items and workspaces in a PVCS repository. + + + + This task uses the delete PCLI command to delete the items. + + + + + Deletes the versioned file called App.ico from the project database specified by the + project-database property. + + + + + + + + ]]> + + + + + Deletes the files called file1.txt and file2.txt from the project called folder in the + project database specified by the project-database property. + + + + + + + + + ]]> + + - - Deletes the specified users from the PVCS access control database. - - - - This task uses the deleteuser PCLI command to delete the users. - - - - - Deletes the users called kb, kv and tb from the project database specified by the - project-database property. - - - - - - - - - - ]]> - - + + Deletes the specified users from the PVCS access control database. + + + + This task uses the deleteuser PCLI command to delete the users. + + + + + Deletes the users called kb, kv and tb from the project database specified by the + project-database property. + + + + + + + + + + ]]> + + @@ -8325,59 +8325,59 @@ - - Gets files from a PVCS repository. - - - - This task uses the get PCLI command to get the versioned files from PVCS. - - - - - Gets the versioned file called App.ico from the project database specified by the - project-database property. - - - - - - - - ]]> - - - - - Gets the versioned file called App.ico from the project database specified by the - project-database property. The file is also locked. - - - - - - - - ]]> - - - - - Gets all revisions assigned the SYSTEST promotion group from the project database specified by the - project-database property. The workfiles are touched after the get operation. - - - - - - - - ]]> - - + + Gets files from a PVCS repository. + + + + This task uses the get PCLI command to get the versioned files from PVCS. + + + + + Gets the versioned file called App.ico from the project database specified by the + project-database property. + + + + + + + + ]]> + + + + + Gets the versioned file called App.ico from the project database specified by the + project-database property. The file is also locked. + + + + + + + + ]]> + + + + + Gets all revisions assigned the SYSTEST promotion group from the project database specified by the + project-database property. The workfiles are touched after the get operation. + + + + + + + + ]]> + + @@ -8413,170 +8413,170 @@ - - Constructs and initializes an instance of PVCSGetTask. - + + Constructs and initializes an instance of PVCSGetTask. + - - Gets or sets the base project path. - - - - This is equivalent to the -bp parameter to the pcli get command. - - + + Gets or sets the base project path. + + + + This is equivalent to the -bp parameter to the pcli get command. + + - - Gets or sets an alternative location for workfiles. - - - - This is equivalent to the -a parameter to the pcli get command. - - + + Gets or sets an alternative location for workfiles. + + + + This is equivalent to the -a parameter to the pcli get command. + + - - Gets or sets a value indicating whether revisions involved in the get operation should be locked. - - - - This is equivalent to the -l parameter to the pcli get command. - - + + Gets or sets a value indicating whether revisions involved in the get operation should be locked. + + + + This is equivalent to the -l parameter to the pcli get command. + + - - Gets or sets whether the workfiles should be made writable. - - - - This is equivalent to the -w parameter to the pcli get command. - - + + Gets or sets whether the workfiles should be made writable. + + + + This is equivalent to the -w parameter to the pcli get command. + + - - Gets or sets the maximum date and time of workfiles to retrieve. - - - - This is equivalent to the -d parameter to the pcli get command. - - - If this property has not yet been set, it will return DateTime.MaxValue. - - + + Gets or sets the maximum date and time of workfiles to retrieve. + + + + This is equivalent to the -d parameter to the pcli get command. + + + If this property has not yet been set, it will return DateTime.MaxValue. + + - - Gets or sets a value indicating whether the workfile location for files should be overridden. - - - - This is equivalent to the -o parameter to the pcli get command. - - + + Gets or sets a value indicating whether the workfile location for files should be overridden. + + + + This is equivalent to the -o parameter to the pcli get command. + + - - Gets or sets the promotion group to get. - - - - This is equivalent to the -g parameter to the pcli get command. - - + + Gets or sets the promotion group to get. + + + + This is equivalent to the -g parameter to the pcli get command. + + - - Gets or sets the revision to get against. - - - - This is equivalent to the -r parameter to the pcli get command. - - - If this property has not yet been set, it will return Double.MaxValue. - - + + Gets or sets the revision to get against. + + + + This is equivalent to the -r parameter to the pcli get command. + + + If this property has not yet been set, it will return Double.MaxValue. + + - - Gets or sets a value indicating whether workfiles should be touched after the get. - - - - This is equivalent to the -t parameter to the pcli get command. - - + + Gets or sets a value indicating whether workfiles should be touched after the get. + + + + This is equivalent to the -t parameter to the pcli get command. + + - - Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the - current workfile. - - - - This is equivalent to the -u parameter to the pcli get command (without specifying a - date or time). - - + + Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the + current workfile. + + + + This is equivalent to the -u parameter to the pcli get command (without specifying a + date or time). + + - - Gets or sets the version label to get against. - - - - This is equivalent to the -v parameter to the pcli get command. - - + + Gets or sets the version label to get against. + + + + This is equivalent to the -v parameter to the pcli get command. + + - - Assigns a version label to a revision of the specified versioned files. - - - - This task uses the label PCLI command to label the items. - - - - - Labels all files in the project database specified by the project-database property. The label - applied is Beta. - - - - - - - - ]]> - - - - - Labels revision 1.8 of App.ico as Dodgy in the project database specified by the - project-database property. - - - - - - - - ]]> - - + + Assigns a version label to a revision of the specified versioned files. + + + + This task uses the label PCLI command to label the items. + + + + + Labels all files in the project database specified by the project-database property. The label + applied is Beta. + + + + + + + + ]]> + + + + + Labels revision 1.8 of App.ico as Dodgy in the project database specified by the + project-database property. + + + + + + + + ]]> + + @@ -8588,84 +8588,84 @@ - - Constructs and initializes an instance of PVCSLabel. - + + Constructs and initializes an instance of PVCSLabel. + - - Gets or sets a value indicating whether the label should "float" to the newest revision. - - - - This is equivalent to the -f parameter to the pcli label command. - - + + Gets or sets a value indicating whether the label should "float" to the newest revision. + + + + This is equivalent to the -f parameter to the pcli label command. + + - - Gets or sets the revision to label. - - - - This is equivalent to the -r parameter to the pcli label command. - - - If this property has not yet been set, it will return Double.MaxValue. - - + + Gets or sets the revision to label. + + + + This is equivalent to the -r parameter to the pcli label command. + + + If this property has not yet been set, it will return Double.MaxValue. + + - - Gets or sets the version label to assign. - - - - This is equivalent to the -v parameter to the pcli label command. - - + + Gets or sets the version label to assign. + + + + This is equivalent to the -v parameter to the pcli label command. + + - - Locks a revision of the specified versioned files. - - - - This task uses the lock PCLI command to lock the versioned files. - - - - - Locks App.ico in the project database specified by the project-database property. - - - - - - - - ]]> - - - - - Locks all files at and below folder in the project database specified by the project-database - property. - - - - - - - - ]]> - - + + Locks a revision of the specified versioned files. + + + + This task uses the lock PCLI command to lock the versioned files. + + + + + Locks App.ico in the project database specified by the project-database property. + + + + + + + + ]]> + + + + + Locks all files at and below folder in the project database specified by the project-database + property. + + + + + + + + ]]> + + @@ -8686,111 +8686,111 @@ - - Constructs and initializes an instance of PVCSLock. - + + Constructs and initializes an instance of PVCSLock. + - - Gets or sets a value indicating whether locking files will take place if checking in those files would - result in a branch. - - - - This is equivalent to the -nb parameter to the pcli lock command. - - + + Gets or sets a value indicating whether locking files will take place if checking in those files would + result in a branch. + + + + This is equivalent to the -nb parameter to the pcli lock command. + + - - Gets or sets a value indicating whether already locked revisions will be locked. - - - - This is equivalent to the -nm parameter to the pcli lock command. - - + + Gets or sets a value indicating whether already locked revisions will be locked. + + + + This is equivalent to the -nm parameter to the pcli lock command. + + - - Gets or sets the promotion group to assign the locked revision. - - - - This is equivalent to the -g parameter to the pcli lock command. - - + + Gets or sets the promotion group to assign the locked revision. + + + + This is equivalent to the -g parameter to the pcli lock command. + + - - Gets or sets the revision to lock. - - - - This is equivalent to the -r parameter to the pcli lock command. - - - If this property has not yet been set, it will return Double.MaxValue. - - + + Gets or sets the revision to lock. + + + + This is equivalent to the -r parameter to the pcli lock command. + + + If this property has not yet been set, it will return Double.MaxValue. + + - - Gets or sets a value indicating whether revisions will be locked even if that will result in a branch - upon check in. - - - - This is equivalent to the -yb parameter to the pcli lock command. - - + + Gets or sets a value indicating whether revisions will be locked even if that will result in a branch + upon check in. + + + + This is equivalent to the -yb parameter to the pcli lock command. + + - - Gets or sets a value indicating whether revisions will be locked even if that will result in multiple - locks against the same revision. - - - - This is equivalent to the -ym parameter to the pcli lock command. - - + + Gets or sets a value indicating whether revisions will be locked even if that will result in multiple + locks against the same revision. + + + + This is equivalent to the -ym parameter to the pcli lock command. + + - - Promotes versioned files to the next promotion group. - - - - This task uses the promotegroup PCLI command to promote versioned files. - - - - - Promotes all files in the root of the project database specified by the project-database property. - The files are promoted from the DEV promotion group to the next. Promotion will not take place across - branches. - - - - ]]> - - - - - Promotes all files in the project database specified by the project-database property. The files are - promoted from the SYSTEST promotion group to the next. Promotion will take place across branches. - - - - ]]> - - + + Promotes versioned files to the next promotion group. + + + + This task uses the promotegroup PCLI command to promote versioned files. + + + + + Promotes all files in the root of the project database specified by the project-database property. + The files are promoted from the DEV promotion group to the next. Promotion will not take place across + branches. + + + + ]]> + + + + + Promotes all files in the project database specified by the project-database property. The files are + promoted from the SYSTEST promotion group to the next. Promotion will take place across branches. + + + + ]]> + + @@ -8802,83 +8802,83 @@ - - Gets or sets a value indicating whether the promotion may occur across branches. - - - - This is equivalent to the -nb and -yb parameters to the pcli promotegroup command. - - + + Gets or sets a value indicating whether the promotion may occur across branches. + + + + This is equivalent to the -nb and -yb parameters to the pcli promotegroup command. + + - - Gets or sets the promotion group to be promoted. - - - - This is equivalent to the -g parameter to the pcli promotegroup command. - - + + Gets or sets the promotion group to be promoted. + + + + This is equivalent to the -g parameter to the pcli promotegroup command. + + - - Puts files into a PVCS repository. - - - - This task uses the put PCLI command to put the files into PVCS. - - - - - Puts the file called App.ico into the project database specified by the project-database - property. The description for the change is Added more colour. - - - - - - - - ]]> - - - - - Puts all files into the project database specified by the project-database property. The description - for the changes is Major changes. Even if the workfiles have not been changed, they will result in a - new revision in PVCS. - - - - - - - - ]]> - - - - - Puts file.txt and all files in folder into the project database specified by the - project-database property. The description for the changes is Some changes. A new branch is - forcibly created via the forcebranch attribute. Leading and trailing whitespace is ignored when - determining whether the workfile has been altered. - - - - - - - - - ]]> - - + + Puts files into a PVCS repository. + + + + This task uses the put PCLI command to put the files into PVCS. + + + + + Puts the file called App.ico into the project database specified by the project-database + property. The description for the change is Added more colour. + + + + + + + + ]]> + + + + + Puts all files into the project database specified by the project-database property. The description + for the changes is Major changes. Even if the workfiles have not been changed, they will result in a + new revision in PVCS. + + + + + + + + ]]> + + + + + Puts file.txt and all files in folder into the project database specified by the + project-database property. The description for the changes is Some changes. A new branch is + forcibly created via the forcebranch attribute. Leading and trailing whitespace is ignored when + determining whether the workfile has been altered. + + + + + + + + + ]]> + + @@ -8926,42 +8926,42 @@ - - Constructs and initializes an instance of PVCSPut. - + + Constructs and initializes an instance of PVCSPut. + - - Gets or sets the base project path. - - - - This is equivalent to the -bp parameter to the pcli put command. - - + + Gets or sets the base project path. + + + + This is equivalent to the -bp parameter to the pcli put command. + + - - Gets or sets a value indicating whether unchanged workfiles should be checked in. - - - - This is equivalent to the -yf parameter to the pcli put command. - - + + Gets or sets a value indicating whether unchanged workfiles should be checked in. + + + + This is equivalent to the -yf parameter to the pcli put command. + + - - Gets or sets the description to be applied to the checked in revisions. - - - - This is equivalent to the -m parameter to the pcli put command. - - + + Gets or sets the description to be applied to the checked in revisions. + + + + This is equivalent to the -m parameter to the pcli put command. + + @@ -8975,78 +8975,78 @@ - - Gets or sets a value indicating whether a new branch will be created. - - - - This is equivalent to the -fb parameter to the pcli put command. - - + + Gets or sets a value indicating whether a new branch will be created. + + + + This is equivalent to the -fb parameter to the pcli put command. + + - - Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining - whether the revision has changed. - - - - This is equivalent to the -b parameter to the pcli put command. - - + + Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining + whether the revision has changed. + + + + This is equivalent to the -b parameter to the pcli put command. + + - - Gets or sets a value indicating whether the workfile should kept in its original state. - - - - This is equivalent to the -k parameter to the pcli put command. - - + + Gets or sets a value indicating whether the workfile should kept in its original state. + + + + This is equivalent to the -k parameter to the pcli put command. + + - - Gets or sets an alternative location for workfiles. - - - - This is equivalent to the -a parameter to the pcli put command. - - + + Gets or sets an alternative location for workfiles. + + + + This is equivalent to the -a parameter to the pcli put command. + + - - Gets or sets a value indicating the files should be locked after the put operation. - - - - This is equivalent to the -l parameter to the pcli put command. - - + + Gets or sets a value indicating the files should be locked after the put operation. + + + + This is equivalent to the -l parameter to the pcli put command. + + - - Gets or sets a value indicating whether the workfile location for files should be overridden. - - - - This is equivalent to the -o parameter to the pcli put command. - - + + Gets or sets a value indicating whether the workfile location for files should be overridden. + + + + This is equivalent to the -o parameter to the pcli put command. + + - - Gets or sets the promotion in use. If a promotion group is specified, this option identifies the - promotion group to which the revision is currently assigned. If no promotion group is specified (ie. - this property is set to an empty string), this option indicates that one is not identifying the - revision by promotion group. - - - - This is equivalent to the -g parameter to the pcli put command. - - + + Gets or sets the promotion in use. If a promotion group is specified, this option identifies the + promotion group to which the revision is currently assigned. If no promotion group is specified (ie. + this property is set to an empty string), this option indicates that one is not identifying the + revision by promotion group. + + + + This is equivalent to the -g parameter to the pcli put command. + + @@ -9060,75 +9060,75 @@ - - Gets or sets the revision number to use for the new revision. - - - - This is equivalent to the -r parameter to the pcli put command. - - + + Gets or sets the revision number to use for the new revision. + + + + This is equivalent to the -r parameter to the pcli put command. + + - - Gets or sets a value indicating whether the same description should be used for all versioned items. - This is true by default. - - - - This is equivalent to the -ym parameter to the pcli put command. - - + + Gets or sets a value indicating whether the same description should be used for all versioned items. + This is true by default. + + + + This is equivalent to the -ym parameter to the pcli put command. + + - - Gets or sets the version label to assign to the new revisions. - - - - This is equivalent to the -v parameter to the pcli put command. - - + + Gets or sets the version label to assign to the new revisions. + + + + This is equivalent to the -v parameter to the pcli put command. + + - - Renames a label in a PVCS repository. - - - - This task uses the renamelabel PCLI command to rename the label. - - - - - Renames the label on App.ico from Beater to Beta in the project database specified by - the project-database property. - - - - - - - - ]]> - - - - - Renames the label on all files from Alfa to Alpha in the project database specified by the - project-database property. - - - - - - - - ]]> - - + + Renames a label in a PVCS repository. + + + + This task uses the renamelabel PCLI command to rename the label. + + + + + Renames the label on App.ico from Beater to Beta in the project database specified by + the project-database property. + + + + + + + + ]]> + + + + + Renames the label on all files from Alfa to Alpha in the project database specified by the + project-database property. + + + + + + + + ]]> + + @@ -9140,63 +9140,63 @@ - - Gets or sets the existing label. - - - - This is equivalent to the -vf parameter to the pcli renamelabel command. - - + + Gets or sets the existing label. + + + + This is equivalent to the -vf parameter to the pcli renamelabel command. + + - - Gets or sets the new label. - - - - This is equivalent to the -vt parameter to the pcli renamelabel command. - - + + Gets or sets the new label. + + + + This is equivalent to the -vt parameter to the pcli renamelabel command. + + - - Unlocks revisions of versioned files in a PVCS repository. - - - - This task uses the unlock PCLI command to perform the unlock operation. - - - - - Unlocks App.ico in the project database specified by the project-database property. - - - - - - - - ]]> - - - - - Unlocks all files in the project specified by the project-database property. Locks by all users are - removed. - - - - - - - - ]]> - - + + Unlocks revisions of versioned files in a PVCS repository. + + + + This task uses the unlock PCLI command to perform the unlock operation. + + + + + Unlocks App.ico in the project database specified by the project-database property. + + + + + + + + ]]> + + + + + Unlocks all files in the project specified by the project-database property. Locks by all users are + removed. + + + + + + + + ]]> + + @@ -9208,32 +9208,32 @@ - - Constructs and initializes an instance of PVCSUnlock. - + + Constructs and initializes an instance of PVCSUnlock. + - - Gets or sets the revision number to use for the new revision. - - - - This is equivalent to the -r parameter to the pcli unlock command. - - + + Gets or sets the revision number to use for the new revision. + + + + This is equivalent to the -r parameter to the pcli unlock command. + + - - Gets or sets the unlock mode for the operation. - - - - This is equivalent to the -u parameter to the pcli unlock command. - - + + Gets or sets the unlock mode for the operation. + + + + This is equivalent to the -u parameter to the pcli unlock command. + + @@ -9247,51 +9247,51 @@ - - All locks held by the current user are removed. - + + All locks held by the current user are removed. + - - All locks held by a specified user are removed. - + + All locks held by a specified user are removed. + - - All locks held by all users are removed. - + + All locks held by all users are removed. + - - Used to add files to a Visual SourceSafe database. If the file is currently - in the SourceSafe database a message will be logged but files will continue to be added. - - - This version does not support recursive adds. Only adds in the root directory will be added to the - SourceSafe database. - - - - - - - - ]]> - + + Used to add files to a Visual SourceSafe database. If the file is currently + in the SourceSafe database a message will be logged but files will continue to be added. + + + This version does not support recursive adds. Only adds in the root directory will be added to the + SourceSafe database. + + + + + + + + ]]> + - - The base abstract class for all Visual Source Safe Tasks. - Provides the core attributes, and functionality for opening an item - in a Visual Source Safe database. - + + The base abstract class for all Visual Source Safe Tasks. + Provides the core attributes, and functionality for opening an item + in a Visual Source Safe database. + - - Opens the Source Safe database and sets the reference to the specified - item and version. - + + Opens the Source Safe database and sets the reference to the specified + item and version. + @@ -9305,20 +9305,20 @@ - - The path to the folder that contains "srcsafe.ini". - + + The path to the folder that contains "srcsafe.ini". + - - The Visual SourceSafe project or file path you wish the perform the - action on (starting with "$/"). - + + The Visual SourceSafe project or file path you wish the perform the + action on (starting with "$/"). + - - The password to use to login to the SourceSafe database. - + + The password to use to login to the SourceSafe database. + @@ -9337,220 +9337,220 @@ - - A version of the path to reference. Accepts multiple forms, - including the label, version number, or date of the version. - If omitted, the latest version is used. - + + A version of the path to reference. Accepts multiple forms, + including the label, version number, or date of the version. + If omitted, the latest version is used. + - - Main task execution method - + + Main task execution method + - - Create project hierarchy in vss - - - + + Create project hierarchy in vss + + + - - Places a comment on all files added into the SourceSafe repository. - + + Places a comment on all files added into the SourceSafe repository. + - - List of files that should be added to SourceSafe. - + + List of files that should be added to SourceSafe. + - - Defines how the local timestamp of files retrieved from a SourceSafe - database should be set. - + + Defines how the local timestamp of files retrieved from a SourceSafe + database should be set. + - - The timestamp of the local file is set to the current date and time. - + + The timestamp of the local file is set to the current date and time. + - - The timestamp of the local file is set to the file's last - modification date and time. - + + The timestamp of the local file is set to the file's last + modification date and time. + - - The timestamp of the local file is set to the date and time that - the file was last checked in to the database. - + + The timestamp of the local file is set to the date and time that + the file was last checked in to the database. + - - Used to checkin files into Visual Source Safe. - - - Checkin all files from an absolute directory to a local sourcesafe database. - - ]]> - - - Checkin a file from a relative directory to a remote sourcesafe database. - - ]]> - + + Used to checkin files into Visual Source Safe. + + + Checkin all files from an absolute directory to a local sourcesafe database. + + ]]> + + + Checkin a file from a relative directory to a remote sourcesafe database. + + ]]> + - - The comment for the new version. - + + The comment for the new version. + - - The path to the local working directory. - + + The path to the local working directory. + - - Determines whether to perform a recursive checkin. - The default is . - + + Determines whether to perform a recursive checkin. + The default is . + - - Determines whether to leave the file(s) as writable. - The default is . - + + Determines whether to leave the file(s) as writable. + The default is . + - - Task used to checkout files from Visual Source Safe. - - - Checkout the latest files from a local sourcesafe database. - - ]]> - - - Checkout a file from a remote sourcesafe database. Put it in a relative directory. - - ]]> - + + Task used to checkout files from Visual Source Safe. + + + Checkout the latest files from a local sourcesafe database. + + ]]> + + + Checkout a file from a remote sourcesafe database. Put it in a relative directory. + + ]]> + - - The path to the local working directory. - + + The path to the local working directory. + - - Determines whether to perform a recursive checkout. - The default is . - + + Determines whether to perform a recursive checkout. + The default is . + - - Determines whether to leave the file(s) as writable. - The default is . - + + Determines whether to leave the file(s) as writable. + The default is . + - - Set the behavior for timestamps of local files. The default is - . - + + Set the behavior for timestamps of local files. The default is + . + - - Used to delete or Destroy files or projects in Visual Source Safe. - - - Delete a project from a local sourcesafe database. - - ]]> - - - Delete a file from the remote sourcesafe database. - - ]]> - - - Destroy a project from a local sourcesafe database. - - ]]> - - - Destroy a file from the remote sourcesafe database. - - ]]> - + + Used to delete or Destroy files or projects in Visual Source Safe. + + + Delete a project from a local sourcesafe database. + + ]]> + + + Delete a file from the remote sourcesafe database. + + ]]> + + + Destroy a project from a local sourcesafe database. + + ]]> + + + Destroy a file from the remote sourcesafe database. + + ]]> + @@ -9559,129 +9559,129 @@ - - Determines whether or not the item is Destroyed. - The default is . - + + Determines whether or not the item is Destroyed. + The default is . + - - Used to generate differences in a vss database. It will show all changes to a project - after the specified label. - - - This only shows differences between the current version and the version specified. - - - - ]]> - + + Used to generate differences in a vss database. It will show all changes to a project + after the specified label. + + + This only shows differences between the current version and the version specified. + + + + ]]> + - - The value of the label to compare to. Required. - + + The value of the label to compare to. Required. + - - The output file to generate (xml) - + + The output file to generate (xml) + - - Used to retrieve an item or project from a Visual Source Safe database. - - - Get the latest files from a local sourcesafe database. - - ]]> - - - Get the latest version of a file from a remote sourcesafe database. Put it in a relative directory. - - ]]> - - - Get the latest version of a file from a remote sourcesafe database. Remove any deleted files from local image. - - ]]> - + + Used to retrieve an item or project from a Visual Source Safe database. + + + Get the latest files from a local sourcesafe database. + + ]]> + + + Get the latest version of a file from a remote sourcesafe database. Put it in a relative directory. + + ]]> + + + Get the latest version of a file from a remote sourcesafe database. Remove any deleted files from local image. + + ]]> + - - Checks to see if we should remove local copies of deleted files, and starts - the scan. - + + Checks to see if we should remove local copies of deleted files, and starts + the scan. + - - Scans the Project Item for deleted files and removes their local - copies from the local image of the project. Obeys the recursive setting - (and thus optionally calls itself recursively). - - The VSS Item (project) to check for deletions - The path to the folder of the item being processed + + Scans the Project Item for deleted files and removes their local + copies from the local image of the project. Obeys the recursive setting + (and thus optionally calls itself recursively). + + The VSS Item (project) to check for deletions + The path to the folder of the item being processed - - The path to the local working directory. - + + The path to the local working directory. + - - Determines whether to perform the get recursively. - The default is . - + + Determines whether to perform the get recursively. + The default is . + - - Determines whether to replace writable files. - The default is . - + + Determines whether to replace writable files. + The default is . + - - Determines whether the files will be writable. - The default is . - + + Determines whether the files will be writable. + The default is . + @@ -9691,94 +9691,94 @@ - - Determines whether the timestamp on the local copy - will be the modification time (if false or omitted, - the checkout time will be used) - + + Determines whether the timestamp on the local copy + will be the modification time (if false or omitted, + the checkout time will be used) + - - Set the behavior for timestamps of local files. The default is - . - + + Set the behavior for timestamps of local files. The default is + . + - - Generates an XML file showing all changes made to a Visual SourceSafe - project/file between specified labels or dates (by a given user). - - - - Write all changes between "Release1" and "Release2" to XML file - "changelog.xml". - - - - ]]> - - - - - Write all changes between January 1st 2004 and March 31st 2004 to XML - file "history.xml". - - - - ]]> - - + + Generates an XML file showing all changes made to a Visual SourceSafe + project/file between specified labels or dates (by a given user). + + + + Write all changes between "Release1" and "Release2" to XML file + "changelog.xml". + + + + ]]> + + + + + Write all changes between January 1st 2004 and March 31st 2004 to XML + file "history.xml". + + + + ]]> + + - - The value of the label to start comparing to. If it is not included, - the compare will start with the very first history item. - + + The value of the label to start comparing to. If it is not included, + the compare will start with the very first history item. + - - The value of the label to compare up to. If it is not included, - the compare will end with the last history item. - + + The value of the label to compare up to. If it is not included, + the compare will end with the last history item. + - - Start date for comparison. - + + Start date for comparison. + - - End date for comparison. - + + End date for comparison. + - - Output file to save history to (as XML). - + + Output file to save history to (as XML). + - - Determines whether to perform the comparison recursively. - The default is . - + + Determines whether to perform the comparison recursively. + The default is . + - - Name of the user whose changes you want to see. - + + Name of the user whose changes you want to see. + @@ -9787,124 +9787,124 @@ - - Override to avoid exposing the corresponding attribute to build - authors. - + + Override to avoid exposing the corresponding attribute to build + authors. + - - Override to avoid exposing the corresponding attribute to build - authors. - + + Override to avoid exposing the corresponding attribute to build + authors. + - - Used to apply a label to a Visual Source Safe item. - - - Label all files in a local sourcesafe database. (Automatically applies the label recursively) - - ]]> - - - Label a file in a remote sourcesafe database. - - ]]> - + + Used to apply a label to a Visual Source Safe item. + + + Label all files in a local sourcesafe database. (Automatically applies the label recursively) + + ]]> + + + Label a file in a remote sourcesafe database. + + ]]> + - - The label comment. - + + The label comment. + - - The name of the label. - + + The name of the label. + - - Task is used to undo a checkout from SourceSafe - - - Undo a checkout of all of the files from a local sourcesafe database. - - ]]> - - - Checkout a file from a remote sourcesafe database. Put it in a relative directory. - - ]]> - + + Task is used to undo a checkout from SourceSafe + + + Undo a checkout of all of the files from a local sourcesafe database. + + ]]> + + + Checkout a file from a remote sourcesafe database. Put it in a relative directory. + + ]]> + - - The path to the local working directory. This is required if you wish to - have your local file replaced with the latest version from SourceSafe. - + + The path to the local working directory. This is required if you wish to + have your local file replaced with the latest version from SourceSafe. + - - Determines whether to perform a recursive undo of the checkout. - The default is . - + + Determines whether to perform a recursive undo of the checkout. + The default is . + - - Allows creation of view labels in StarTeam repositories. - - - Often when building projects you wish to label the source control repository. - By default this task creates view labels with the build option turned on. - This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel - You need to have the StarTeam SDK installed for this task to function correctly. - - - Creates a label in a StarTeam repository. - - - - - ]]> - - + + Allows creation of view labels in StarTeam repositories. + + + Often when building projects you wish to label the source control repository. + By default this task creates view labels with the build option turned on. + This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel + You need to have the StarTeam SDK installed for this task to function correctly. + + + Creates a label in a StarTeam repository. + + + + + ]]> + + @@ -9924,32 +9924,32 @@ Steve Cohen - The username of the connection + The username of the connection - The username of the connection + The username of the connection - name of Starteam server to connect to + name of Starteam server to connect to - port of Starteam server to connect to + port of Starteam server to connect to - name of Starteam project to connect to + name of Starteam project to connect to - name of Starteam view to connect to + name of Starteam view to connect to - The starteam server through which all activities will be done. + The starteam server through which all activities will be done. - - Derived classes must override this method to instantiate a view configured appropriately to its task. - - the unconfigured View - the view appropriately configured. + + Derived classes must override this method to instantiate a view configured appropriately to its task. + + the unconfigured View + the view appropriately configured. @@ -9959,9 +9959,9 @@ - Returns the name of the user or a blank string if the user is not found. - a user's ID - the name of the user + Returns the name of the user or a blank string if the user is not found. + a user's ID + the name of the user @@ -10039,39 +10039,39 @@ - The name of the label to be set in Starteam. + The name of the label to be set in Starteam. - The label description to be set in Starteam. + The label description to be set in Starteam. - Is the label being created a build label. + Is the label being created a build label. - If set the datetime to set the label as of. + If set the datetime to set the label as of. - Kludgy flag to keep track if date has been set. - Please kill this if you can. Here based on experiences I have had with VB.NET + Kludgy flag to keep track if date has been set. + Please kill this if you can. Here based on experiences I have had with VB.NET - Does user wish to make a revision label? + Does user wish to make a revision label? - - Override of base-class abstract function creates an appropriately configured view. - For labels this a view configured as of this.lastBuild. - - the unconfigured View - the snapshot View appropriately configured. + + Override of base-class abstract function creates an appropriately configured view. + For labels this a view configured as of this.lastBuild. + + the unconfigured View + the snapshot View appropriately configured. - - The name to be given to the label; required. - + + The name to be given to the label; required. + - Should label be marked build : default is true + Should label be marked build : default is true @@ -10084,7 +10084,7 @@ - Optional description of the label to be stored in the StarTeam project. + Optional description of the label to be stored in the StarTeam project. @@ -10189,28 +10189,28 @@ - - Locate the versionnumber.xml file in the repository. If it - is not present, the file is created. The file is checked out - exclusively for editing. - - StarTeam view we are working with. - - StarTeam file handle containing version xml. - + + Locate the versionnumber.xml file in the repository. If it + is not present, the file is created. The file is checked out + exclusively for editing. + + StarTeam view we are working with. + + StarTeam file handle containing version xml. + - - Creates the versionumber.xml file in the repository. - - StarTeam folder desired to put the versionnumber.xml files into - StarTeam File handle to the created file. + + Creates the versionumber.xml file in the repository. + + StarTeam folder desired to put the versionnumber.xml files into + StarTeam File handle to the created file. - - Allows user to specify the filename where the version xml is stored. - The default is versionnumber.xml. - + + Allows user to specify the filename where the version xml is stored. + The default is versionnumber.xml. + @@ -10294,15 +10294,15 @@ - - Helper method calls on the StarTeam API to retrieve an ID number for the specified view, corresponding to this.label. - - The Label identifier or -1 if no label was provided. + + Helper method calls on the StarTeam API to retrieve an ID number for the specified view, corresponding to this.label. + + The Label identifier or -1 if no label was provided. - Derived classes must override this class to define actual processing to be performed on each folder in the tree defined for the task - the StarTeam folderto be visited - the local mapping of rootStarteamFolder + Derived classes must override this class to define actual processing to be performed on each folder in the tree defined for the task + the StarTeam folderto be visited + the local mapping of rootStarteamFolder @@ -10312,16 +10312,16 @@ - - Gets the collection of the local file names in the supplied directory. - We need to check this collection against what we find in Starteam to - understand what we need to do in order to synch with the repository. - - - The goal is to keep track of which local files are not controlled by StarTeam. - - Local folder to scan - hashtable whose keys represent a file or directory in localFolder. + + Gets the collection of the local file names in the supplied directory. + We need to check this collection against what we find in Starteam to + understand what we need to do in order to synch with the repository. + + + The goal is to keep track of which local files are not controlled by StarTeam. + + Local folder to scan + hashtable whose keys represent a file or directory in localFolder. @@ -10349,35 +10349,35 @@ Regular expresssion for searching matching file names - - Convert path patterns to regularexpression patterns. Stored in the given string collection. - - collection of paths to expand into regular expressions - collection to store the given regularexpression patterns + + Convert path patterns to regularexpression patterns. Stored in the given string collection. + + collection of paths to expand into regular expressions + collection to store the given regularexpression patterns - - Root StarTeam folder to begin operations on. Defaults to the root of the view. - + + Root StarTeam folder to begin operations on. Defaults to the root of the view. + - - Root Local folder where files are to be checkout/in or manipulated. Defaults to the StarTeam default folder. - + + Root Local folder where files are to be checkout/in or manipulated. Defaults to the StarTeam default folder. + - - Accepts comma de-limited list of expressions to include in tree operations. - If nothing is set ALL filespecs are included. - - - Match all C# files in the directory - *.cs - - - Expressions should be just for filename matching. - Technically relative directory information is accepted but will never match. - + + Accepts comma de-limited list of expressions to include in tree operations. + If nothing is set ALL filespecs are included. + + + Match all C# files in the directory + *.cs + + + Expressions should be just for filename matching. + Technically relative directory information is accepted but will never match. + @@ -10397,9 +10397,9 @@ - - Default : true - should tasks recurse through tree. - + + Default : true - should tasks recurse through tree. + @@ -10413,70 +10413,70 @@ - - Label used for checkout. If no label is set latest state of repository is checked out. - - - The label must exist in starteam or an exception will be thrown. - + + Label used for checkout. If no label is set latest state of repository is checked out. + + + The label must exist in starteam or an exception will be thrown. + - classes used to access static values + classes used to access static values - Facotry classes used when files and folders are added to the repository. Populated when adduncontrolled is enabled. + Facotry classes used when files and folders are added to the repository. Populated when adduncontrolled is enabled. - will folders be created for new items found with the checkin. + will folders be created for new items found with the checkin. - The comment which will be stored with the checkin. + The comment which will be stored with the checkin. - holder for the add Uncontrolled attribute. If true, all local files not in StarTeam will be added to the repository. + holder for the add Uncontrolled attribute. If true, all local files not in StarTeam will be added to the repository. - This attribute tells whether unlocked files on checkin (so that other users may access them) checkout or to - leave the checkout status alone (default). - + This attribute tells whether unlocked files on checkin (so that other users may access them) checkout or to + leave the checkout status alone (default). + - - Override of base-class abstract function creates an appropriately configured view. For checkins this is - always the current or "tip" view. - - the unconfigured View - the snapshot View appropriately configured. + + Override of base-class abstract function creates an appropriately configured view. For checkins this is + always the current or "tip" view. + + the unconfigured View + the snapshot View appropriately configured. - Implements base-class abstract function to define tests for any preconditons required by the task + Implements base-class abstract function to define tests for any preconditons required by the task - Implements base-class abstract function to perform the checkin operation on the files in each folder of the tree. - the StarTeam folder to which files will be checked in - local folder from which files will be checked in + Implements base-class abstract function to perform the checkin operation on the files in each folder of the tree. + the StarTeam folder to which files will be checked in + local folder from which files will be checked in - Adds to the StarTeam repository everything on the local machine that is not currently in the repository. - Hasttable containing files missing in the repository for the current folder - StarTeam folder to which these items are to be added. + Adds to the StarTeam repository everything on the local machine that is not currently in the repository. + Hasttable containing files missing in the repository for the current folder + StarTeam folder to which these items are to be added. - Adds the file or directpry to the repository. - StarTeam folder underwhich items will be added. - the file or directory to add - true if the file was successfully added otherwise false. + Adds the file or directpry to the repository. + StarTeam folder underwhich items will be added. + the file or directory to add + true if the file was successfully added otherwise false. - - if true, any files or folders NOT in StarTeam will be added to the repository. Defaults to "false". - + + if true, any files or folders NOT in StarTeam will be added to the repository. Defaults to "false". + - - Set to do an unlocked checkout; optional, default is false; - If true, file will be unlocked so that other users may change it. If false, lock status will not change. - + + Set to do an unlocked checkout; optional, default is false; + If true, file will be unlocked so that other users may change it. If false, lock status will not change. + @@ -10503,130 +10503,130 @@ - holder for the createDirs property. + holder for the createDirs property. - holder for the deleteUncontrolled property. + holder for the deleteUncontrolled property. - holder for the lockstatus property. + holder for the lockstatus property. - - Override of base-class abstract function creates an appropriately configured view for checkout. - If a label is specified it is used otherwise the current view of the repository is used. - - the unconfigured StarTeam View - the snapshot StarTeam View appropriately configured. + + Override of base-class abstract function creates an appropriately configured view for checkout. + If a label is specified it is used otherwise the current view of the repository is used. + + the unconfigured StarTeam View + the snapshot StarTeam View appropriately configured. - Implements base-class abstract function to define tests for any preconditons required by the task + Implements base-class abstract function to define tests for any preconditons required by the task - - Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree. - - the StarTeam folder from which files to be checked out - the local mapping of the starteam folder + + Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree. + + the StarTeam folder from which files to be checked out + the local mapping of the starteam folder - - Deletes everything on the local machine that is not in the repository. - - Hashtable containing filenames to be deleted + + Deletes everything on the local machine that is not in the repository. + + Hashtable containing filenames to be deleted - Utility method to delete the file (and it's children) from the local drive. - the file or directory to delete. - was the file successfully deleted + Utility method to delete the file (and it's children) from the local drive. + the file or directory to delete. + was the file successfully deleted - - Default : true - Create directories that are in the Starteam repository even if they are empty. - + + Default : true - Create directories that are in the Starteam repository even if they are empty. + - - Not fully tested CAREFUL Default : false - Should all local files NOT in StarTeam be deleted? - + + Not fully tested CAREFUL Default : false - Should all local files NOT in StarTeam be deleted? + - - What type of lock to apply to files checked out. - - - LockType - - - unchanged - default: do not make any changes to the lock state of items. - - - exclusive - Exclusively lock items. No other users can update the object while it is exclusively locked. - - - nonexclusive - Put a non-exclusive lock on the item. - - - unlocked - Remove locks from all items checked out. This accompanied by force would effectively override a lock and replace local contents with the current version. - - - + + What type of lock to apply to files checked out. + + + LockType + + + unchanged + default: do not make any changes to the lock state of items. + + + exclusive + Exclusively lock items. No other users can update the object while it is exclusively locked. + + + nonexclusive + Put a non-exclusive lock on the item. + + + unlocked + Remove locks from all items checked out. This accompanied by force would effectively override a lock and replace local contents with the current version. + + + - - Allows creation of view labels in StarTeam repositories. - - - Often when building projects you wish to label the source control repository. - By default this task creates view labels with the build option turned on. - This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel - You need to have the StarTeam SDK installed for this task to function correctly. - - - Creates a label in a StarTeam repository. - - - - - ]]> - - + + Allows creation of view labels in StarTeam repositories. + + + Often when building projects you wish to label the source control repository. + By default this task creates view labels with the build option turned on. + This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel + You need to have the StarTeam SDK installed for this task to function correctly. + + + Creates a label in a StarTeam repository. + + + + + ]]> + + - - This method does the work of creating the new view and checking it - into Starteam. - + + This method does the work of creating the new view and checking it + into Starteam. + - - List items in StarTeam repositories. - - - This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlist - You need to have the StarTeam SDK installed for this task to function correctly. - - - Lists all files in a StarTeam repository. - - - - - ]]> - - + + List items in StarTeam repositories. + + + This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlist + You need to have the StarTeam SDK installed for this task to function correctly. + + + Lists all files in a StarTeam repository. + + + + + ]]> + + @@ -10637,59 +10637,59 @@ the snapshot View appropriately configured. - Required base-class abstract function implementation is a no-op here. + Required base-class abstract function implementation is a no-op here. - Implements base-class abstract function to perform the checkout - operation on the files in each folder of the tree. - the StarTeam folder from which files to be checked out - the local mapping of rootStarteamFolder + Implements base-class abstract function to perform the checkout + operation on the files in each folder of the tree. + the StarTeam folder from which files to be checked out + the local mapping of rootStarteamFolder - - Processes Surround SCM batch files. - - - Processes the batch commands found in the input file. Each line in the - input file should contain a single Surround SCM command including proper - command line options. The sscm command, Surround SCM server address, - port number, username and password are not required for each command line. - - - - Run the batch file ${src}/sscm.batch on the server at localhost, - port 4900 with username 'administrator' and a blank password. All script - output is directed to the console. - - - <sscmbatch - serverconnect="localhost:4900" - serverlogin="administrator:" - input="${src}/sscm.batch" - /> - - - - - Run the batch file ${src}/sscm.batch on the server at localhost, - port 4900 with username 'administrator' and a blank password. All script - output is redirected to ${dist}/sscm.batch.out. - - - <sscmbatch - serverconnect="localhost:4900" - serverconnect="administrator:" - input="${src}/sscm.batch" - output="${dist}/sscm.batch.out" - /> - - + + Processes Surround SCM batch files. + + + Processes the batch commands found in the input file. Each line in the + input file should contain a single Surround SCM command including proper + command line options. The sscm command, Surround SCM server address, + port number, username and password are not required for each command line. + + + + Run the batch file ${src}/sscm.batch on the server at localhost, + port 4900 with username 'administrator' and a blank password. All script + output is directed to the console. + + + <sscmbatch + serverconnect="localhost:4900" + serverlogin="administrator:" + input="${src}/sscm.batch" + /> + + + + + Run the batch file ${src}/sscm.batch on the server at localhost, + port 4900 with username 'administrator' and a blank password. All script + output is redirected to ${dist}/sscm.batch.out. + + + <sscmbatch + serverconnect="localhost:4900" + serverconnect="administrator:" + input="${src}/sscm.batch" + output="${dist}/sscm.batch.out" + /> + + - - Surround SCM - abstract task base. - + + Surround SCM + abstract task base. + @@ -10699,31 +10699,31 @@ The to write the task-specific arguments to. - - The address and port number of the Surround SCM server host computer. - Format is server:port. If not entered, the last saved connection - parameters are used. - + + The address and port number of the Surround SCM server host computer. + Format is server:port. If not entered, the last saved connection + parameters are used. + - - The username and password used to login to the Surround SCM server. - Format is username:password. If not entered, the last saved login - parameters are used. - + + The username and password used to login to the Surround SCM server. + Format is username:password. If not entered, the last saved login + parameters are used. + - - Override ExeName paramater to sscm.exe for Surround SCM. - + + Override ExeName paramater to sscm.exe for Surround SCM. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + @@ -10733,74 +10733,74 @@ The to write the task-specific arguments to. - - File to read commands from. - + + File to read commands from. + - - File to direct all standard output to. When executing commands from - the input file, all output is written to this file instead of being - displayed on the screen. - + + File to direct all standard output to. When executing commands from + the input file, all output is written to this file instead of being + displayed on the screen. + - - Creates new branches for Surround SCM. - - - - Create a new Baseline branch 'Widget 1.0' from branch 'Mainline', - repository 'Mainline/Widget' with the given comments. All files - are branched at the tip version. - - - <sscmbranch - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="Widget 1.0" - repository="Mainline/Widget" - parent="Mainline" - comment="Branch for continuing Widget 1.0 development" - type="baseline" - /> - - - - - Create a new Workspace branch 'MyWidgetDevelopment' from branch - 'Widget 1.0', repository 'Mainline/Widget'. All files are branched - at the tip version. - - - <sscmbranch - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="MyWidgetDevelopment" - repository="Mainline/Widget" - parent="Widget 1.0" - /> - - - - - Create a new Snapshot branch 'Build as of 12-1-03' from branch - 'Widget 1.0', repository 'Mainline/Widget' with the given comments. - All files are branched at their version as of 12-01-03. - - - <sscmbranch - serverconnect="localhost:4900" - serverlogin="administrator:" - name="Build as of 12-1-03" - repository="Mainline/Widget" - branch="Widget 1.0" - comment="Snapshot of source as it was on December 1st, 2003" - timestamp="2003120300:00:00" - type="snapshot" - /> - - + + Creates new branches for Surround SCM. + + + + Create a new Baseline branch 'Widget 1.0' from branch 'Mainline', + repository 'Mainline/Widget' with the given comments. All files + are branched at the tip version. + + + <sscmbranch + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="Widget 1.0" + repository="Mainline/Widget" + parent="Mainline" + comment="Branch for continuing Widget 1.0 development" + type="baseline" + /> + + + + + Create a new Workspace branch 'MyWidgetDevelopment' from branch + 'Widget 1.0', repository 'Mainline/Widget'. All files are branched + at the tip version. + + + <sscmbranch + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="MyWidgetDevelopment" + repository="Mainline/Widget" + parent="Widget 1.0" + /> + + + + + Create a new Snapshot branch 'Build as of 12-1-03' from branch + 'Widget 1.0', repository 'Mainline/Widget' with the given comments. + All files are branched at their version as of 12-01-03. + + + <sscmbranch + serverconnect="localhost:4900" + serverlogin="administrator:" + name="Build as of 12-1-03" + repository="Mainline/Widget" + branch="Widget 1.0" + comment="Snapshot of source as it was on December 1st, 2003" + timestamp="2003120300:00:00" + type="snapshot" + /> + + @@ -10810,31 +10810,31 @@ The to write the task-specific arguments to. - - The name of the branch you want to create. - + + The name of the branch you want to create. + - - The full repository path. - + + The full repository path. + - - The parent branch you want to create the new, child branch from. - If not specified, the mainline branch is used. - + + The parent branch you want to create the new, child branch from. + If not specified, the mainline branch is used. + - - Specifies a comment for the branch operation. - + + Specifies a comment for the branch operation. + - - Specifies which parent branch file versions are copied into the - child branch. - + + Specifies which parent branch file versions are copied into the + child branch. + @@ -10851,61 +10851,61 @@ - - Specifies the type of branch you want to create. Possible values are - workspace, baseline, or snapshot. The default is - workspace. - + + Specifies the type of branch you want to create. Possible values are + workspace, baseline, or snapshot. The default is + workspace. + - - Checks in files in Surround SCM - repository. - - - Check in updated Surround SCM files with changes, removes the lock on - the files, and makes changes available to other users. - - - - Check In all files and repositories from repository 'Mainline/Widget' - recursively from the 'Widget 1.0' branch to the working directory setup - for user 'administrator'. This call outputs the progress of the Check In - to the console. - - - <sscmcheckin - serverconnect="localhost:4900" - serverlogin="administrator:" - file="/" - branch="Widget 1.0" - repository="Mainline/Widget" - recursive="true" - comment="I made some changes" - /> - - - - - Check in file 'Mainline/Widget/Widget.java' from the 'Widget 1.0' - branch from the working directory setup for user 'administrator' - with comment 'I made some changes'. Set the 'Release 1.1.1' label - to this new version, even if the label already exists on an earlier - version. - - - <sscmcheckin - serverconnect="localhost:4900" - serverlogin="administrator:" - file="Widget.java" - branch="Widget 1.0" - repository="Mainline/Widget" - comment="I made some changes" - label="Release 1.1.1" - overwritelabel="true" - /> - - + + Checks in files in Surround SCM + repository. + + + Check in updated Surround SCM files with changes, removes the lock on + the files, and makes changes available to other users. + + + + Check In all files and repositories from repository 'Mainline/Widget' + recursively from the 'Widget 1.0' branch to the working directory setup + for user 'administrator'. This call outputs the progress of the Check In + to the console. + + + <sscmcheckin + serverconnect="localhost:4900" + serverlogin="administrator:" + file="/" + branch="Widget 1.0" + repository="Mainline/Widget" + recursive="true" + comment="I made some changes" + /> + + + + + Check in file 'Mainline/Widget/Widget.java' from the 'Widget 1.0' + branch from the working directory setup for user 'administrator' + with comment 'I made some changes'. Set the 'Release 1.1.1' label + to this new version, even if the label already exists on an earlier + version. + + + <sscmcheckin + serverconnect="localhost:4900" + serverlogin="administrator:" + file="Widget.java" + branch="Widget 1.0" + repository="Mainline/Widget" + comment="I made some changes" + label="Release 1.1.1" + overwritelabel="true" + /> + + @@ -10915,154 +10915,154 @@ The to write the task-specific arguments to. - - Surround SCM branch name. The default is pulled from the local - working directory. - + + Surround SCM branch name. The default is pulled from the local + working directory. + - - Surround SCM repository path. The default is pulled from the local - working directory. - + + Surround SCM repository path. The default is pulled from the local + working directory. + - - File or repository name. Can be / or empty, which means the - repository specified by the repository option or the default - repository. - + + File or repository name. Can be / or empty, which means the + repository specified by the repository option or the default + repository. + - - Comment for the check-in. - + + Comment for the check-in. + - - Force check in without merge. Ignores code changes checked in after - the user's last checkout or merge. The default is . - + + Force check in without merge. Ignores code changes checked in after + the user's last checkout or merge. The default is . + - - Get file after check in. The default is . - + + Get file after check in. The default is . + - - Keep the lock after check in. The default is . - + + Keep the lock after check in. The default is . + - - A label for the check in code. - + + A label for the check in code. + - - Overwrite previous label on file. The default is - . - + + Overwrite previous label on file. The default is + . + - - Do not list repository and local full path of the Surround - SCM server. The default is . - + + Do not list repository and local full path of the Surround + SCM server. The default is . + - - Recursively check in all files and sub-repositories. - The default is . - + + Recursively check in all files and sub-repositories. + The default is . + - - The TestTrack Pro database configuration name. - + + The TestTrack Pro database configuration name. + - - The TestTrack Pro username and password. - + + The TestTrack Pro username and password. + - - The TestTrack Pro defect number(s) for attachment. Format is "#:#:#:#". - + + The TestTrack Pro defect number(s) for attachment. Format is "#:#:#:#". + - - Make file writable after check in. The default is - . - + + Make file writable after check in. The default is + . + - - Update version even if no changes. The default is - . - + + Update version even if no changes. The default is + . + - - Remove local file after check in. The default is - . - + + Remove local file after check in. The default is + . + - - Checks out files from a Surround SCM - repository. - - - You can check out single files, multiple files, or a full repository. - Surround SCM creates a read-write copy of the files in the working - directory. - - - - Check Out all files and repositories from repository 'Mainline/Widget' - recursively from the 'Widget 1.0' branch to the working directory setup - for user 'administrator'. This call forces the file retrieval from the - server even if the local file is current and overwrites any writable - local files with the server copy. - - - <sscmcheckout - serverconnect="localhost:4900" - serverlogin="administrator:" - file="/" - branch="Widget 1.0" - repository="Mainline/Widget" - recursive="true" - force="true" - comment="This is my Check Out comment" - /> - - - - - Check Out version 1 of the file 'Mainline/Widget/Widget.java' exclusively - from the 'Widget 1.0' branch to the working directory setup for user - 'administrator'. Writable local files are not overwritten, even if they - are out of date. - - - <sscmcheckout - serverconnect="localhost:4900" - serverlogin="administrator:" - quiet="true" - file="Widget.java" - branch="Widget 1.0" - repository="Mainline/Widget" - overwrite="false" - writable="true" - version="1" - exclusive="true" - /> - - + + Checks out files from a Surround SCM + repository. + + + You can check out single files, multiple files, or a full repository. + Surround SCM creates a read-write copy of the files in the working + directory. + + + + Check Out all files and repositories from repository 'Mainline/Widget' + recursively from the 'Widget 1.0' branch to the working directory setup + for user 'administrator'. This call forces the file retrieval from the + server even if the local file is current and overwrites any writable + local files with the server copy. + + + <sscmcheckout + serverconnect="localhost:4900" + serverlogin="administrator:" + file="/" + branch="Widget 1.0" + repository="Mainline/Widget" + recursive="true" + force="true" + comment="This is my Check Out comment" + /> + + + + + Check Out version 1 of the file 'Mainline/Widget/Widget.java' exclusively + from the 'Widget 1.0' branch to the working directory setup for user + 'administrator'. Writable local files are not overwritten, even if they + are out of date. + + + <sscmcheckout + serverconnect="localhost:4900" + serverlogin="administrator:" + quiet="true" + file="Widget.java" + branch="Widget 1.0" + repository="Mainline/Widget" + overwrite="false" + writable="true" + version="1" + exclusive="true" + /> + + @@ -11072,16 +11072,16 @@ The to write the task-specific arguments to. - - Surround SCM branch name. The default is pulled from the local - working directory. - + + Surround SCM branch name. The default is pulled from the local + working directory. + - - Surround SCM repository path. The default is pulled from the local - working directory. - + + Surround SCM repository path. The default is pulled from the local + working directory. + @@ -11091,44 +11091,44 @@ - - Comment for the check-out. - + + Comment for the check-out. + - - Force file retrieval from server regardless of the local copy status. - The default is . - + + Force file retrieval from server regardless of the local copy status. + The default is . + - - Do not list repository and local full path of the Surround SCM server. - The default is . - + + Do not list repository and local full path of the Surround SCM server. + The default is . + - - Recursively get files and sub-repositories. The default is - . - + + Recursively get files and sub-repositories. The default is + . + - - Specifies whether to overwrite local writable files. The default is - . - + + Specifies whether to overwrite local writable files. The default is + . + - - Specifies how to set the local file's date/time. Possible values are - current, modify or checkin. - + + Specifies how to set the local file's date/time. Possible values are + current, modify or checkin. + - - Exclusively lock the files. The default is . - + + Exclusively lock the files. The default is . + @@ -11137,30 +11137,30 @@ - - Freezes branches in a Surround SCM - repository. - - - Freezing a branch prevents any code changes being made to files in the - branch. When a branch is frozen, it is locked and no changes can be - made to it. - - - - Freeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the - server at localhost, port 4900 with username 'administrator' and a - blank password. - - - <sscmfreeze - serverconnect="localhost:4900" - serverlogin="administrator:" - mainline="Mainline" - branch="Widget 1.0" - /> - - + + Freezes branches in a Surround SCM + repository. + + + Freezing a branch prevents any code changes being made to files in the + branch. When a branch is frozen, it is locked and no changes can be + made to it. + + + + Freeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the + server at localhost, port 4900 with username 'administrator' and a + blank password. + + + <sscmfreeze + serverconnect="localhost:4900" + serverlogin="administrator:" + mainline="Mainline" + branch="Widget 1.0" + /> + + @@ -11170,88 +11170,88 @@ The to write the task-specific arguments to. - - Surround SCM branch name. - + + Surround SCM branch name. + - - Surround SCM mainline branch name. The default is pulled from the - local working directory. - + + Surround SCM mainline branch name. The default is pulled from the + local working directory. + - - Gets files from a Surround SCM - repository. - - - You can get a single file, multiple files, or a repository. A read-only - copy of the file is created in the specified directory. - - - - Get all files and repositories from repository 'Mainline/Widget' - recursively from the 'Widget 1.0' branch to the working directory - setup for user 'administrator'. This call forces the file retrieval - from the server even if the local file is current and overwrites any - local files that are writable with the server copy. - - - <sscmget - serverconnect="localhost:4900" - serverlogin="administrator:" - file="/" - branch="Widget 1.0" - repository="Mainline/Widget" - recursive="true" - force="true" - overwrite="true" - /> - - - - - Get version 1 of the file 'Mainline/Widget/Widget.java' from the - 'Widget 1.0' branch to the working directory setup for user 'administrator'. - Writable local files are not overwritten, even if they are out of date. - - - <sscmget - serverconnect="localhost:4900" - serverlogin="administrator:" - quiet="true" - file="Widget.java" - branch="Widget 1.0" - repository="Mainline/Widget" - overwrite="false" - writable="true" - version="1" - /> - - - - - Get all files and repositories labeled with 'Release 1.0.0' (even those - removed from Surround) from repository 'Mainline/Widget' recursively - from the 'Widget 1.0' branch to the '${build}/src' directory. Writable - local files are overwritten with the server copy. - - - <sscmget - serverconnect="localhost:4900" - serverlogin="administrator:" - quiet="true" - file="/" - branch="Widget 1.0" - repository="Mainline/Widget" - recursive="true" - label="Release 1.0.1" - destdir="${build}/src" - overwrite="true" - /> - - + + Gets files from a Surround SCM + repository. + + + You can get a single file, multiple files, or a repository. A read-only + copy of the file is created in the specified directory. + + + + Get all files and repositories from repository 'Mainline/Widget' + recursively from the 'Widget 1.0' branch to the working directory + setup for user 'administrator'. This call forces the file retrieval + from the server even if the local file is current and overwrites any + local files that are writable with the server copy. + + + <sscmget + serverconnect="localhost:4900" + serverlogin="administrator:" + file="/" + branch="Widget 1.0" + repository="Mainline/Widget" + recursive="true" + force="true" + overwrite="true" + /> + + + + + Get version 1 of the file 'Mainline/Widget/Widget.java' from the + 'Widget 1.0' branch to the working directory setup for user 'administrator'. + Writable local files are not overwritten, even if they are out of date. + + + <sscmget + serverconnect="localhost:4900" + serverlogin="administrator:" + quiet="true" + file="Widget.java" + branch="Widget 1.0" + repository="Mainline/Widget" + overwrite="false" + writable="true" + version="1" + /> + + + + + Get all files and repositories labeled with 'Release 1.0.0' (even those + removed from Surround) from repository 'Mainline/Widget' recursively + from the 'Widget 1.0' branch to the '${build}/src' directory. Writable + local files are overwritten with the server copy. + + + <sscmget + serverconnect="localhost:4900" + serverlogin="administrator:" + quiet="true" + file="/" + branch="Widget 1.0" + repository="Mainline/Widget" + recursive="true" + label="Release 1.0.1" + destdir="${build}/src" + overwrite="true" + /> + + @@ -11261,16 +11261,16 @@ The to write the task-specific arguments to. - - Surround SCM branch name. The default is pulled from the local - working directory. - + + Surround SCM branch name. The default is pulled from the local + working directory. + - - Surround SCM repository path. The default is pulled from the local - working directory. - + + Surround SCM repository path. The default is pulled from the local + working directory. + @@ -11290,22 +11290,22 @@ - - Make local file editable or writable. The default is - . - + + Make local file editable or writable. The default is + . + - - Force file retrieval from server regardless of the local copy status. - The default is . - + + Force file retrieval from server regardless of the local copy status. + The default is . + - - Label to search for when getting a file. If a file version is - specified, this parameter is ignored. - + + Label to search for when getting a file. If a file version is + specified, this parameter is ignored. + @@ -11315,35 +11315,35 @@ - - Include removed files when getting files by label or timestamp. - The default is . Ignored if a label or - timestamp is not specified. - + + Include removed files when getting files by label or timestamp. + The default is . Ignored if a label or + timestamp is not specified. + - - Do not list repository and local full path of files. The default is - . - + + Do not list repository and local full path of files. The default is + . + - - Recursively get files and sub-repositories. The default is - . - + + Recursively get files and sub-repositories. The default is + . + - - Specifies whether to overwrite local writable files. The default is - . - + + Specifies whether to overwrite local writable files. The default is + . + - - Specifies how to set the local file's date/time. Possible values are - current, modify or checkin. - + + Specifies how to set the local file's date/time. Possible values are + current, modify or checkin. + @@ -11352,74 +11352,74 @@ - - Creates file or repository labels for a Surround SCM - repository. - - - Labels provide a way to mark a specific version of a file or repository. - You can create labels for single files, multiple files, or all files in - a repository. When you create a label, a new entry is created in the history. - The file, and the version number, do not change. Existing 'Release 1.0.1' - labels on a file will be moved to the tip version of the file. - - - - Label all files under the 'Mainline/Widget' repository recursively in - the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. - - - <sscmlabel - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="Widget 1.0" - repository="Mainline/Widget" - file="readme.txt" - recursive="true" - label="Release 1.0.1" - overwritelabel="false" - comment="This labels the final build for the release of Widget 1.0.1." - /> - - - - - Label all files under the 'Mainline/Widget' repository recursively in - the 'Widget 1.0' branch with 'Release 1.0.1' and no comments. - - - <sscmlabel - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="Widget 1.0" - repository="Mainline/Widget" - file="readme.txt" - recursive="true" - label="Release 1.0.1" - /> - - - - - Label version 4 of the file 'Mainline/Widget/Widget.java' in the - 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. An - existing 'Release 1.0.1' label on this file to be moved to version 4 - of the file. - - - <sscmlabel - serverconnect="localhost:4900" - serverlogin="administrator:" - branch="Widget 1.0" - repository="Mainline/Widget" - file="readme.txt" - label="Release 1.0.1" - overwritelabel=" true" - comment=" This labels the final build for the release of Widget 1.0.1." - version=" 4" - /> - - + + Creates file or repository labels for a Surround SCM + repository. + + + Labels provide a way to mark a specific version of a file or repository. + You can create labels for single files, multiple files, or all files in + a repository. When you create a label, a new entry is created in the history. + The file, and the version number, do not change. Existing 'Release 1.0.1' + labels on a file will be moved to the tip version of the file. + + + + Label all files under the 'Mainline/Widget' repository recursively in + the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. + + + <sscmlabel + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="Widget 1.0" + repository="Mainline/Widget" + file="readme.txt" + recursive="true" + label="Release 1.0.1" + overwritelabel="false" + comment="This labels the final build for the release of Widget 1.0.1." + /> + + + + + Label all files under the 'Mainline/Widget' repository recursively in + the 'Widget 1.0' branch with 'Release 1.0.1' and no comments. + + + <sscmlabel + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="Widget 1.0" + repository="Mainline/Widget" + file="readme.txt" + recursive="true" + label="Release 1.0.1" + /> + + + + + Label version 4 of the file 'Mainline/Widget/Widget.java' in the + 'Widget 1.0' branch with 'Release 1.0.1' and the given comment. An + existing 'Release 1.0.1' label on this file to be moved to version 4 + of the file. + + + <sscmlabel + serverconnect="localhost:4900" + serverlogin="administrator:" + branch="Widget 1.0" + repository="Mainline/Widget" + file="readme.txt" + label="Release 1.0.1" + overwritelabel=" true" + comment=" This labels the final build for the release of Widget 1.0.1." + version=" 4" + /> + + @@ -11429,16 +11429,16 @@ The to write the task-specific arguments to. - - Surround SCM branch name. The default is pulled from the local - working directory. - + + Surround SCM branch name. The default is pulled from the local + working directory. + - - Surround SCM repository path. The default is pulled from the local - working directory. - + + Surround SCM repository path. The default is pulled from the local + working directory. + @@ -11448,24 +11448,24 @@ - - The new label to create. - + + The new label to create. + - - Recursively label all files. The default is . - + + Recursively label all files. The default is . + - - Overwrite the existing label. The default is . - + + Overwrite the existing label. The default is . + - - Comment for the label. - + + Comment for the label. + @@ -11474,25 +11474,25 @@ - - Unlocks frozen branches for a Surround SCM - repository. - - - - Unfreeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the - server at localhost, port 4900 with username 'administrator' and a - blank password. - - - <sscmunfreeze - serverconnect="localhost:4900" - serverlogin="administrator:" - mainline="Mainline" - branch="Widget 1.0" - /> - - + + Unlocks frozen branches for a Surround SCM + repository. + + + + Unfreeze the 'Widget 1.0' branch off of the mainline 'Mainline' on the + server at localhost, port 4900 with username 'administrator' and a + blank password. + + + <sscmunfreeze + serverconnect="localhost:4900" + serverlogin="administrator:" + mainline="Mainline" + branch="Widget 1.0" + /> + + @@ -11502,47 +11502,47 @@ The to write the task-specific arguments to. - - Surround SCM branch name. - + + Surround SCM branch name. + - - Surround SCM mainline branch name. The default is pulled from the local working directory. - + + Surround SCM mainline branch name. The default is pulled from the local working directory. + - - A base class for creating tasks for executing CVS client commands on a - CVS repository. - + + A base class for creating tasks for executing CVS client commands on a + CVS repository. + - - An environment variable that holds path information about where - svn is located. - + + An environment variable that holds path information about where + svn is located. + - - The prefix used for command arguments. - + + The prefix used for command arguments. + - - The name of the svn executable. - + + The name of the svn executable. + - - Environment variable that holds the executable name that is used for - ssh communication. - + + Environment variable that holds the executable name that is used for + ssh communication. + - - Name of the password file that is used to cash password settings. - + + Name of the password file that is used to cash password settings. + @@ -11551,19 +11551,19 @@ - - Build up the command line arguments, determine which executable is being - used and find the path to that executable and set the working - directory. - - The process to prepare. + + Build up the command line arguments, determine which executable is being + used and find the path to that executable and set the working + directory. + + The process to prepare. - - Append the command line options or commen names for the options - to the generic options collection. This is then piped to the - command line as a switch. - + + Append the command line options or commen names for the options + to the generic options collection. This is then piped to the + command line as a switch. + @@ -11578,420 +11578,420 @@ - - Set default values for non-requiered parameters. - + + Set default values for non-requiered parameters. + - - The name of the executable. - + + The name of the executable. + - - The name of the password file. - + + The name of the password file. + - - Name of the home environment variable. - + + Name of the home environment variable. + - - The name of the ssh/ rsh environment variable. - + + The name of the ssh/ rsh environment variable. + - - The full path of the svn executable. - + + The full path of the svn executable. + - - - TODO: Add more documentation when I understand all svn root possibilities/ - protocols. - The svn root is usually in the form of a URL from which the server, protocol - and path information can be derived. Although the path to the repository - can also be determined from this the information is more implicit - than explicit. For example a subversion root URL of: - http://svn.collab.net/repos/svn/trunk/doc/book/tools - would have the following components: - protocol: http/ web_dav - username: anonymous - servername: svn.collab.net - repository: /repos/svn - server path: /trunk/doc/book/tools - - In addition the revision path or branch can also be determined as - subversion stores this information as a seperate physical directory. - In this example: - - revision: trunk - - + + + TODO: Add more documentation when I understand all svn root possibilities/ + protocols. + The svn root is usually in the form of a URL from which the server, protocol + and path information can be derived. Although the path to the repository + can also be determined from this the information is more implicit + than explicit. For example a subversion root URL of: + http://svn.collab.net/repos/svn/trunk/doc/book/tools + would have the following components: + protocol: http/ web_dav + username: anonymous + servername: svn.collab.net + repository: /repos/svn + server path: /trunk/doc/book/tools + + In addition the revision path or branch can also be determined as + subversion stores this information as a seperate physical directory. + In this example: + + revision: trunk + + - - The user performing the checkout. - + + The user performing the checkout. + - - The pasword to use to login to svn. - + + The pasword to use to login to svn. + - - Indicates whether the task should be interactive or not. This is - set to by default, and I don't see a reason - to expose this to the NAnt task. - + + Indicates whether the task should be interactive or not. This is + set to by default, and I don't see a reason + to expose this to the NAnt task. + - - The executable to use for ssh communication. - + + The executable to use for ssh communication. + - - The command to execute. - + + The command to execute. + - - Specifies whether to print as little information as possible. - The default is . - + + Specifies whether to print as little information as possible. + The default is . + - - Determines if the root is used for the command based on - the command name. Returns true if the root - is used, otherwise returns false. - + + Determines if the root is used for the command based on + the command name. Returns true if the root + is used, otherwise returns false. + - - Executes the svn checkout command. - - - Checkout Gentle.NET. - - - ]]> - - + + Executes the svn checkout command. + + + Checkout Gentle.NET. + + + ]]> + + - - Initialize the task, and set the default parameters. - + + Initialize the task, and set the default parameters. + - - Gets the svn command to execute. - - - The svn command to execute. The default value is "checkout". - + + Gets the svn command to execute. + + + The svn command to execute. The default value is "checkout". + - - if the command should be executed recursively. - The default is . - + + if the command should be executed recursively. + The default is . + - - The revision to checkout. If no revision is specified then subversion - will return the HEAD. - - - A revision argument can be one of: - NUMBER revision number - "{" DATE "}" revision at start of the date - "HEAD" latest in repository - "BASE" base rev of item's working copy - "COMMITTED" last commit at or before BASE - "PREV" revision just before COMMITTED - + + The revision to checkout. If no revision is specified then subversion + will return the HEAD. + + + A revision argument can be one of: + NUMBER revision number + "{" DATE "}" revision at start of the date + "HEAD" latest in repository + "BASE" base rev of item's working copy + "COMMITTED" last commit at or before BASE + "PREV" revision just before COMMITTED + - - if the authentiction token should be cached - locally. - + + if the authentiction token should be cached + locally. + - - The location of the configuration directory. - + + The location of the configuration directory. + - - Executes the svn command specified by the command attribute. - - - Checkout Gentle.NET. - - - ]]> - - + + Executes the svn command specified by the command attribute. + + + Checkout Gentle.NET. + + + ]]> + + - - The svn command to execute. - + + The svn command to execute. + - - Executes the svn update specified by the command attribute. - - - Update Gentle.NET. - - - ]]> - - + + Executes the svn update specified by the command attribute. + + + Update Gentle.NET. + + + ]]> + + - - Gets the svn command to execute. - - - The svn command to execute. The default value is "update". - + + Gets the svn command to execute. + + + The svn command to execute. The default value is "update". + - - Allows an IIS application pool to be controlled. - - - - Starts the "StsAdminAppPool" application pool on server - "SV-ARD-WEB". - - - - ]]> - - - - - Stops and restarts the "DefaultAppPool" application pool - on server "SV-ARD-WEB". - - - - ]]> - - + + Allows an IIS application pool to be controlled. + + + + Starts the "StsAdminAppPool" application pool on server + "SV-ARD-WEB". + + + + ]]> + + + + + Stops and restarts the "DefaultAppPool" application pool + on server "SV-ARD-WEB". + + + + ]]> + + - - The name of the server on which to perform the action. The default - is the local computer. - + + The name of the server on which to perform the action. The default + is the local computer. + - - The name of the application pool on which to perform the action. - + + The name of the application pool on which to perform the action. + - - The action that should be performed on the application pool. - + + The action that should be performed on the application pool. + - - Defines the actions that can be performed on an application pool. - + + Defines the actions that can be performed on an application pool. + - - Starts the application pool. - + + Starts the application pool. + - - Stops the application pool. - + + Stops the application pool. + - - Stops and restarts the application pool. - + + Stops and restarts the application pool. + - - Recycles an application pool. - + + Recycles an application pool. + - - Creates or modifies a virtual directory of a web site hosted on Internet - Information Server. - - - - If the virtual directory does not exist it is created, and if it already - exists it is modified. Only the IIS-properties specified will be set. If set - by other means (e.g. the Management Console), the unspecified properties retain their current value, - otherwise they are inherited from the parent. - - - For a list of optional parameters see IIsWebVirtualDir. - - - More information on metabase parameters is available here. - - - - - Create a virtual directory named Temp pointing to c:\temp - on the local machine. - - - - ]]> - - - - - Create a virtual directory named Temp pointing to c:\temp - on machine Staging. - - - - ]]> - - - - - Configure the home directory of for http://svc.here.dev/ to point to - D:\Develop\Here and require authentication - - - - ]]> - - - - - Create a virtual directory named WebServices/Dev pointing to - c:\MyProject\dev on the web site running on port 81 of - machine MyHost. - - - - ]]> - - Note that if WebServices is neither an existing virtual directory nor an - existing physical subdirectory of the web root, your IIS Management Console - will get confused. Even though http://MyHost:81/WebServices/Dev/theService.asmx - may be a perfectly working webservice, the Management Console will not show it. - + + Creates or modifies a virtual directory of a web site hosted on Internet + Information Server. + + + + If the virtual directory does not exist it is created, and if it already + exists it is modified. Only the IIS-properties specified will be set. If set + by other means (e.g. the Management Console), the unspecified properties retain their current value, + otherwise they are inherited from the parent. + + + For a list of optional parameters see IIsWebVirtualDir. + + + More information on metabase parameters is available here. + + + + + Create a virtual directory named Temp pointing to c:\temp + on the local machine. + + + + ]]> + + + + + Create a virtual directory named Temp pointing to c:\temp + on machine Staging. + + + + ]]> + + + + + Configure the home directory of for http://svc.here.dev/ to point to + D:\Develop\Here and require authentication + + + + ]]> + + + + + Create a virtual directory named WebServices/Dev pointing to + c:\MyProject\dev on the web site running on port 81 of + machine MyHost. + + + + ]]> + + Note that if WebServices is neither an existing virtual directory nor an + existing physical subdirectory of the web root, your IIS Management Console + will get confused. Even though http://MyHost:81/WebServices/Dev/theService.asmx + may be a perfectly working webservice, the Management Console will not show it. + - - Base class for all IIS-related task. - - - Basically this class hold the logic to determine the IIS version as well - as the IIS server/port determination/checking logic. - + + Base class for all IIS-related task. + + + Basically this class hold the logic to determine the IIS version as well + as the IIS server/port determination/checking logic. + - - Name of the IIS virtual directory. - + + Name of the IIS virtual directory. + - - The IIS server, which can be specified using the format [host]:[port]. - The default is localhost:80. - - - - This allows for targeting a specific virtual site on a physical box. - - + + The IIS server, which can be specified using the format [host]:[port]. + The default is localhost:80. + + + + This allows for targeting a specific virtual site on a physical box. + + - - The website on the IIS server. - - - - This allows for targeting a specific virtual site on a physical box. - - + + The website on the IIS server. + + + + This allows for targeting a specific virtual site on a physical box. + + - - Gets the version of IIS corresponding with the current OS. - - - The version of IIS corresponding with the current OS. - + + Gets the version of IIS corresponding with the current OS. + + + The version of IIS corresponding with the current OS. + - - Defines the IIS versions supported by the IIS tasks. - + + Defines the IIS versions supported by the IIS tasks. + - - The user-friendly name of the package or application. - + + The user-friendly name of the package or application. + - - The file system path. - + + The file system path. + - - Indicates whether the file or the contents of the folder may be - executed, regardless of file type. The default is . - + + Indicates whether the file or the contents of the folder may be + executed, regardless of file type. The default is . + @@ -12016,46 +12016,46 @@ - - A value of true indicates that remote requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests. - + + A value of true indicates that remote requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests. + - - indicates that remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests. - + + indicates that remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests. + - - Indicates whether the file or the contents of the folder may be - read. The default is . - + + Indicates whether the file or the contents of the folder may be + read. The default is . + - - Indicates whether users are allowed to access source code if either - Read or Write permissions are set. The default is . - + + Indicates whether users are allowed to access source code if either + Read or Write permissions are set. The default is . + - - Indicates whether the file or the contents of the folder may be - executed if they are script files or static content. The default - is . - + + Indicates whether the file or the contents of the folder may be + executed if they are script files or static content. The default + is . + - - Indicates whether file access requires SSL file permission processing, - with or without a client certificate. The default is . - + + Indicates whether file access requires SSL file permission processing, + with or without a client certificate. The default is . + - - Indicates whether file access requires SSL file permission processing - with a minimum key size of 128 bits, with or without a client - certificate. The default is . - + + Indicates whether file access requires SSL file permission processing + with a minimum key size of 128 bits, with or without a client + certificate. The default is . + @@ -12067,10 +12067,10 @@ - - Indicates whether SSL file access processing requests a certificate - from the client. The default is . - + + Indicates whether SSL file access processing requests a certificate + from the client. The default is . + @@ -12082,19 +12082,19 @@ - - Indicates whether users are allowed to upload files and their - associated properties to the enabled directory on your server or - to change content in a Write-enabled file. The default is - . - + + Indicates whether users are allowed to upload files and their + associated properties to the enabled directory on your server or + to change content in a Write-enabled file. The default is + . + - - Indicates whether IIS should handle the user password for anonymous - users attempting to access resources. The default is - . - + + Indicates whether IIS should handle the user password for anonymous + users attempting to access resources. The default is + . + @@ -12103,38 +12103,38 @@ - - Specifies whether ASP client-side debugging is enabled. The default - is . - + + Specifies whether ASP client-side debugging is enabled. The default + is . + - - Specifies whether ASP debugging is enabled on the server. The default - is . - + + Specifies whether ASP debugging is enabled on the server. The default + is . + - - Specifies the application pool where the application is routed - (IIS 6.0 or higher). - + + Specifies the application pool where the application is routed + (IIS 6.0 or higher). + - - Enables session state persistence for the ASP application. The - default is . - + + Enables session state persistence for the ASP application. The + default is . + - - Specifies whether output from an ASP application will be buffered. - If , all output from the application is - collected in the buffer before the buffer is flushed to the client. - With buffering on, the ASP application has to completely process the - ASP script before the client receives any output. The default is - . - + + Specifies whether output from an ASP application will be buffered. + If , all output from the application is + collected in the buffer before the buffer is flushed to the client. + With buffering on, the ASP application has to completely process the + ASP script before the client receives any output. The default is + . + @@ -12150,21 +12150,21 @@ - - Controls the behavior of ASP when a new request is to be rejected - due to a full request queue. If , an .htm file - with a similar name as the requested .asp file, will be sent instead - of the .asp file. The naming convention for the .htm file is the - name of the .asp file with _asp appended. The default is - . - + + Controls the behavior of ASP when a new request is to be rejected + due to a full request queue. If , an .htm file + with a similar name as the requested .asp file, will be sent instead + of the .asp file. The naming convention for the .htm file is the + name of the .asp file with _asp appended. The default is + . + - - Specifies whether HTTP 1.1 chunked transfer encoding is enabled for - the World Wide Web Publishing Service (WWW service). The default is - . - + + Specifies whether HTTP 1.1 chunked transfer encoding is enabled for + the World Wide Web Publishing Service (WWW service). The default is + . + @@ -12203,37 +12203,37 @@ - - Specifies whether an ASP page allows paths relative to the current - directory. The default is . - + + Specifies whether an ASP page allows paths relative to the current + directory. The default is . + - - Specifies whether type libraries are cached on the server. The - default is . - - - - The World Wide Web Publishing Service (WWW service) setting for - this property is applicable to all in-process and pooled out-of-process - application nodes, at all levels. - - - Metabase settings at the Web server level or lower are ignored - for in-process and pooled out-of-process applications. However, - settings at the Web server level or lower are used if that node - is an isolated out-of-process application. - - + + Specifies whether type libraries are cached on the server. The + default is . + + + + The World Wide Web Publishing Service (WWW service) setting for + this property is applicable to all in-process and pooled out-of-process + application nodes, at all levels. + + + Metabase settings at the Web server level or lower are ignored + for in-process and pooled out-of-process applications. However, + settings at the Web server level or lower are used if that node + is an isolated out-of-process application. + + - - Specifies whether ASP pages trap exceptions thrown by components. - If set to , the Microsoft Script Debugger tool - does not catch exceptions sent by the component that you are debugging. - The default is . - + + Specifies whether ASP pages trap exceptions thrown by components. + If set to , the Microsoft Script Debugger tool + does not catch exceptions sent by the component that you are debugging. + The default is . + @@ -12273,235 +12273,235 @@ - - Specifies whether the Web server writes debugging specifics - (file name, error, line number, description) to the client browser, - in addition to logging them to the Windows Event Log. The default - is . - + + Specifies whether the Web server writes debugging specifics + (file name, error, line number, description) to the client browser, + in addition to logging them to the Windows Event Log. The default + is . + - - Indicates whether IIS thread gating is enabled (only applies to IIS 4 and 5). - The default is . - - - IIS performs thread gating to dynamically control the number of - concurrently executing threads, in response to varying load conditions. - + + Indicates whether IIS thread gating is enabled (only applies to IIS 4 and 5). + The default is . + + + IIS performs thread gating to dynamically control the number of + concurrently executing threads, in response to varying load conditions. + - - Specifies whether IIS checks the threading model of any components - that your application creates. The default is . - + + Specifies whether IIS checks the threading model of any components + that your application creates. The default is . + - - Specifies Anonymous authentication as one of the possible authentication - schemes returned to clients as being available. The default is - . - + + Specifies Anonymous authentication as one of the possible authentication + schemes returned to clients as being available. The default is + . + - - Specifies Basic authentication as one of the possible authentication - schemes returned to clients as being available. The default is - . - + + Specifies Basic authentication as one of the possible authentication + schemes returned to clients as being available. The default is + . + - - Specifies Integrated Windows authentication as one of the possible - authentication schemes returned to clients as being available. The - default is . - + + Specifies Integrated Windows authentication as one of the possible + authentication schemes returned to clients as being available. The + default is . + - - Specifies that authentication persists only for a single request on - a connection. IIS resets the authentication at the end of each request, - and forces re-authentication on the next request of the session. - - - [IIS 6.0] When the AuthPersistSingleRequest flag is set to true when - using NTLM authentication, IIS 6.0 automatically reauthenticates every - request, even those on the same connection. - + + Specifies that authentication persists only for a single request on + a connection. IIS resets the authentication at the end of each request, + and forces re-authentication on the next request of the session. + + + [IIS 6.0] When the AuthPersistSingleRequest flag is set to true when + using NTLM authentication, IIS 6.0 automatically reauthenticates every + request, even those on the same connection. + - - Specifies authentication will persist only across single requests - on a connection if the connection is by proxy. Applies to IIS 5.0 - and 5.1. The default is - - - IIS will reset the authentication at the end of the request if the current authenticated - request is by proxy and it is not the special case where IIS is running MSPROXY - + + Specifies authentication will persist only across single requests + on a connection if the connection is by proxy. Applies to IIS 5.0 + and 5.1. The default is + + + IIS will reset the authentication at the end of the request if the current authenticated + request is by proxy and it is not the special case where IIS is running MSPROXY + - - Specifies whether authentication is valid for a single request - if by proxy. IIS will reset the authentication at the end of the - request and force re-authentication on the next request if the - current authenticated request is by proxy of any type. Applies to - IIS 5.0 and 5.1. The default is . - + + Specifies whether authentication is valid for a single request + if by proxy. IIS will reset the authentication at the end of the + request and force re-authentication on the next request if the + current authenticated request is by proxy of any type. Applies to + IIS 5.0 and 5.1. The default is . + - - Specifies whether the HTTP 1.1 directive to prevent caching of content - should be sent to clients. The default is . - + + Specifies whether the HTTP 1.1 directive to prevent caching of content + should be sent to clients. The default is . + - - Indicates whether ISAPI extensions are cached in memory after first - use. The default is . - + + Indicates whether ISAPI extensions are cached in memory after first + use. The default is . + - - Specifies whether the installed content indexer should index content - under this directory tree. The default is . - + + Specifies whether the installed content indexer should index content + under this directory tree. The default is . + - - Specifies whether process accounting and throttling should be performed - for ISAPI extensions and ASP applications. The default is - . - + + Specifies whether process accounting and throttling should be performed + for ISAPI extensions and ASP applications. The default is + . + - - Indicates whether IIS should perform process accounting for CGI - applications. The default is . - + + Indicates whether IIS should perform process accounting for CGI + applications. The default is . + - - Indicates whether a CGI application runs in its own console. The - default is . - + + Indicates whether a CGI application runs in its own console. The + default is . + - - Specifies whether a CGI process is created in the system context - or in the context of the requesting user. The default is - . - + + Specifies whether a CGI process is created in the system context + or in the context of the requesting user. The default is + . + - - Specifies whether date information is displayed when browsing - directories. The default is . - + + Specifies whether date information is displayed when browsing + directories. The default is . + - - Specifies whether file extensions are displayed when browsing - directories. The default is . - + + Specifies whether file extensions are displayed when browsing + directories. The default is . + - - Specifies whether date information is displayed in extended format - when displaying directories. The default is . - + + Specifies whether date information is displayed in extended format + when displaying directories. The default is . + - - Specifies whether file size information is displayed when displaying - directories. The default is . - + + Specifies whether file size information is displayed when displaying + directories. The default is . + - - Specifies whether file creation time is displayed when browsing - directories. The default is . - + + Specifies whether file creation time is displayed when browsing + directories. The default is . + - - Specifies whether client requests are written to the IIS log files. - The default is . - + + Specifies whether client requests are written to the IIS log files. + The default is . + - - When set to true, the default document (specified by the DefaultDoc property) for a directory is loaded when the directory is browsed. - + + When set to true, the default document (specified by the DefaultDoc property) for a directory is loaded when the directory is browsed. + - - Specifies whether directory browsing is enabled. The default is - . - + + Specifies whether directory browsing is enabled. The default is + . + - - Enables or disables custom footers. The default is - . - + + Enables or disables custom footers. The default is + . + - - Enables or disables reverse Domain Name Server (DNS) lookups for - the World Wide Web Publishing Service (WWW service). The default is - . - + + Enables or disables reverse Domain Name Server (DNS) lookups for + the World Wide Web Publishing Service (WWW service). The default is + . + - - Specifies whether server-side include (SSI) #exec directives are - disabled under this path. The default is . - + + Specifies whether server-side include (SSI) #exec directives are + disabled under this path. The default is . + - - - + + + - - - + + + - - One or more file names of default documents that will be returned to - the client if no file name is included in the client's request. - + + One or more file names of default documents that will be returned to + the client if no file name is included in the client's request. + - - Specifies the user name for Universal Naming Convention (UNC) virtual - roots. - + + Specifies the user name for Universal Naming Convention (UNC) virtual + roots. + - - Specifies the encrypted password used to gain access to UNC - (Universal Naming Convention) virtual roots. - + + Specifies the encrypted password used to gain access to UNC + (Universal Naming Convention) virtual roots. + - - The different ways a (virtual) directory in IIS can be configured - as an application. - + + The different ways a (virtual) directory in IIS can be configured + as an application. + - - Virtual directory is not configured as an application. - + + Virtual directory is not configured as an application. + - - Virtual directory is configured as an in-process application. - + + Virtual directory is configured as an in-process application. + @@ -12510,126 +12510,126 @@ - - Virtual directory is configured as an out-of-process application. - + + Virtual directory is configured as an out-of-process application. + - - Deletes a virtual directory from a given web site hosted on Internet - Information Server. - - - - Delete a virtual directory named Temp from the web site running - on port 80 of the local machine. If more than one web site is - running on port 80, take the web site bound to the hostname - localhost if existent or bound to no hostname otherwise. - - - - ]]> - - - - - Delete a virtual directory named Temp from the website running - on port 81 of machine MyHost. - - - - ]]> - - + + Deletes a virtual directory from a given web site hosted on Internet + Information Server. + + + + Delete a virtual directory named Temp from the web site running + on port 80 of the local machine. If more than one web site is + running on port 80, take the web site bound to the hostname + localhost if existent or bound to no hostname otherwise. + + + + ]]> + + + + + Delete a virtual directory named Temp from the website running + on port 81 of machine MyHost. + + + + ]]> + + - - Lists the configuration settings of a specified virtual directory in a - web site hosted on Internet Information Server. - - - - List the settings of a virtual directory named Temp. - - - - ]]> - - + + Lists the configuration settings of a specified virtual directory in a + web site hosted on Internet Information Server. + + + + List the settings of a virtual directory named Temp. + + + + ]]> + + - - Base NAnt task for working with ADSI. This task contains only the path of the ADSI - object that you want to work with. - + + Base NAnt task for working with ADSI. This task contains only the path of the ADSI + object that you want to work with. + - - The ADSI path of the location where we want to work with. - + + The ADSI path of the location where we want to work with. + - - Used to get the value of a property from an ADSI object. - + + Used to get the value of a property from an ADSI object. + - - Sets the specified property - + + Sets the specified property + - - The name of the property to get. - + + The name of the property to get. + - - The name of the property to store the value in. - + + The name of the property to store the value in. + - - Sets a property on an ADSI object. - - - This task uses a heuristic to determine the type of the property in ADSI. The following cases are notable: - - If the property does not exist on the item, it is inserted as a string. - If the property already exists, this method will attempt to preserve - the type of the property. The types this method knows about are String, - Boolean, and Int32. - If the property exists and is an array, the value is added to - the array, but only if it is not already present. - - - - - - ]]> - - - - - - - - - ]]> - - + + Sets a property on an ADSI object. + + + This task uses a heuristic to determine the type of the property in ADSI. The following cases are notable: + + If the property does not exist on the item, it is inserted as a string. + If the property already exists, this method will attempt to preserve + the type of the property. The types this method knows about are String, + Boolean, and Int32. + If the property exists and is an array, the value is added to + the array, but only if it is not already present. + + + + + + ]]> + + + + + + + + + ]]> + + - - Sets the specified property - + + Sets the specified property + @@ -12659,732 +12659,732 @@ - - The name of the property to set. - + + The name of the property to set. + - - The new value of the property. - + + The new value of the property. + - - Formats source code in a given directory to a specified code format. - - - - Most examples inline have been produced by Tal Davidson and team and - are part of the astyle documentation. They have been included in - the task documentation as an easy reference. - - NOTE: This task relies on the astyle.exe file being in your path variable. - Please download the astyle.exe from http://astyle.sourceforge.net. - - - - - - - - - ]]> - - + + Formats source code in a given directory to a specified code format. + + + + Most examples inline have been produced by Tal Davidson and team and + are part of the astyle documentation. They have been included in + the task documentation as an easy reference. + + NOTE: This task relies on the astyle.exe file being in your path variable. + Please download the astyle.exe from http://astyle.sourceforge.net. + + + + + + + + + ]]> + + - - The default style seems to be the closest to C# standards. - + + The default style seems to be the closest to C# standards. + - - Build up the command line arguments, determine which executable is - being used and find the path to that executable and set the working - directory. - - The process to prepare. + + Build up the command line arguments, determine which executable is + being used and find the path to that executable and set the working + directory. + + The process to prepare. - - Adds a new command option if none exists. If one does exist then - the use switch is toggled on or of. - - The common name of the option. - The option value or command line switch of the option. - if the option should be appended to the commandline, otherwise . + + Adds a new command option if none exists. If one does exist then + the use switch is toggled on or of. + + The common name of the option. + The option value or command line switch of the option. + if the option should be appended to the commandline, otherwise . - - Append the command line options or commen names for the options - to the generic options collection. This is then piped to the - command line as a switch. - + + Append the command line options or commen names for the options + to the generic options collection. This is then piped to the + command line as a switch. + - - Append the files specified in the fileset to the command line argument. - + + Append the files specified in the fileset to the command line argument. + - - A collection of command line option switches. - + + A collection of command line option switches. + - - Used to select the files to copy. - + + Used to select the files to copy. + - - The command-line arguments for the program. - + + The command-line arguments for the program. + - - Indicate the preset style to use. - - ansi - - namespace foospace - { - int Foo() - { - if (isBar) - { - bar(); - return 1; - } - else - return 0; - } - } - - - kr ( Kernighan&Ritchie ) - - namespace foospace { - int Foo() { - if (isBar) { - bar(); - return 1; - } else - return 0; - } - } - - - linux - - namespace foospace - { - int Foo() - { - if (isBar) { - bar(); - return 1; - } else - return 0; - } - } - - - gnu - - namespace foospace - { - int Foo() - { - if (isBar) - { - bar(); - return 1; - } - else - return 0; - } - } - - - java - - class foospace { - int Foo() { - if (isBar) { - bar(); - return 1; - } else - return 0; - } - } - - - NAnt - - namespace foospace { - class foo() { - #region Protected Static Fields - private int Foo() { - if (isBar) { - bar(); - return 1; - } else { - return 0; - } - } - #endregion - } - - - - + + Indicate the preset style to use. + + ansi + + namespace foospace + { + int Foo() + { + if (isBar) + { + bar(); + return 1; + } + else + return 0; + } + } + + + kr ( Kernighan&Ritchie ) + + namespace foospace { + int Foo() { + if (isBar) { + bar(); + return 1; + } else + return 0; + } + } + + + linux + + namespace foospace + { + int Foo() + { + if (isBar) { + bar(); + return 1; + } else + return 0; + } + } + + + gnu + + namespace foospace + { + int Foo() + { + if (isBar) + { + bar(); + return 1; + } + else + return 0; + } + } + + + java + + class foospace { + int Foo() { + if (isBar) { + bar(); + return 1; + } else + return 0; + } + } + + + NAnt + + namespace foospace { + class foo() { + #region Protected Static Fields + private int Foo() { + if (isBar) { + bar(); + return 1; + } else { + return 0; + } + } + #endregion + } + + + + - - Astyle leaves the original files around, renamed with a different - suffix. Setting this to true - will remove these files. - + + Astyle leaves the original files around, renamed with a different + suffix. Setting this to true + will remove these files. + - - The suffix to append to original files, defaults to .orig - if not specified. - + + The suffix to append to original files, defaults to .orig + if not specified. + - - Indicate the maximum number of spaces to indent relative to a - previous line. - + + Indicate the maximum number of spaces to indent relative to a + previous line. + - - Indicate that tabs should be used to indent sources. The number - specified indicates the maximum number of spaces the tab character - will represent. - + + Indicate that tabs should be used to indent sources. The number + specified indicates the maximum number of spaces the tab character + will represent. + - - Indent using tab characters. Treat each tab as # spaces. Uses tabs as - indents in areas '--indent=tab' prefers to use spaces, such as - inside multi-line statements. - + + Indent using tab characters. Treat each tab as # spaces. Uses tabs as + indents in areas '--indent=tab' prefers to use spaces, such as + inside multi-line statements. + - - to convert tabs to spaces. - + + to convert tabs to spaces. + - - if class statements should be indented. - - - The default: - class Foo - { - public: - Foo(); - virtual ~Foo(); - }; - becomes: - class Foo - { - public: - Foo(); - virtual ~Foo(); - }; - - - + + if class statements should be indented. + + + The default: + class Foo + { + public: + Foo(); + virtual ~Foo(); + }; + becomes: + class Foo + { + public: + Foo(); + virtual ~Foo(); + }; + + + - - if switch statements should be indented. - - - The default: - switch (foo) - { - case 1: - a += 2; - break; - default: - a += 2; - break; - } - becomes: - switch (foo) - { - case 1: - a += 2; - break; - default: - a += 2; - break; - } - - - + + if switch statements should be indented. + + + The default: + switch (foo) + { + case 1: + a += 2; + break; + default: + a += 2; + break; + } + becomes: + switch (foo) + { + case 1: + a += 2; + break; + default: + a += 2; + break; + } + + + - - if case statements should be indented. - - - The default: - switch (foo) - { - case 1: - { - a += 2; - break; - } - default: - { - a += 2; - break; - } - } - becomes: - switch (foo) - { - case 1: - { - a += 2; - break; - } - default: - { - a += 2; - break; - } - } - - - + + if case statements should be indented. + + + The default: + switch (foo) + { + case 1: + { + a += 2; + break; + } + default: + { + a += 2; + break; + } + } + becomes: + switch (foo) + { + case 1: + { + a += 2; + break; + } + default: + { + a += 2; + break; + } + } + + + - - true if bracket statements should be indented. - - - The default: - if (isFoo) - { - bar(); - } - else - { - anotherBar(); - } - becomes: - if (isFoo) - { - bar(); - } - else - { - anotherBar(); - } - - - + + true if bracket statements should be indented. + + + The default: + if (isFoo) + { + bar(); + } + else + { + anotherBar(); + } + becomes: + if (isFoo) + { + bar(); + } + else + { + anotherBar(); + } + + + - - if block statements should be indented. - The default: - if (isFoo) - { - bar(); - } - else - anotherBar(); - becomes: - if (isFoo) - { - bar(); - } - else - anotherBar(); - + + if block statements should be indented. + The default: + if (isFoo) + { + bar(); + } + else + anotherBar(); + becomes: + if (isFoo) + { + bar(); + } + else + anotherBar(); + - - if namespace statements should be indented. - - The default: - namespace foospace - { - class Foo - { - public: - Foo(); - virtual ~Foo(); - }; - } - becomes: - namespace foospace - { - class Foo - { - public: - Foo(); - virtual ~Foo(); - }; - } - - + + if namespace statements should be indented. + + The default: + namespace foospace + { + class Foo + { + public: + Foo(); + virtual ~Foo(); + }; + } + becomes: + namespace foospace + { + class Foo + { + public: + Foo(); + virtual ~Foo(); + }; + } + + - - if label statements should be indented. - - - The default: - int foospace() - { - while (isFoo) - { - ... - goto error; - error: - ... - } - } - becomes: - int foospace() - { - while (isFoo) - { - ... - goto error; - error: - ... - } - } - - + + if label statements should be indented. + + + The default: + int foospace() + { + while (isFoo) + { + ... + goto error; + error: + ... + } + } + becomes: + int foospace() + { + while (isFoo) + { + ... + goto error; + error: + ... + } + } + + - - Indicate the maximum number of spaces to indent relative to a - previous line. - + + Indicate the maximum number of spaces to indent relative to a + previous line. + - - Indicate the maximum number of spaces to indent relative to a - previous line. - + + Indicate the maximum number of spaces to indent relative to a + previous line. + - - if empty lines should be filled with the - whitespace of the previous line. - + + if empty lines should be filled with the + whitespace of the previous line. + - - if brackets should be put on a new line. - - if (isFoo) - { - bar(); - } - else - { - anotherBar(); - } - - - + + if brackets should be put on a new line. + + if (isFoo) + { + bar(); + } + else + { + anotherBar(); + } + + + - - if brackets should be attached. - - - if (isFoo){ - bar(); - } else { - anotherBar(); - } - - - + + if brackets should be attached. + + + if (isFoo){ + bar(); + } else { + anotherBar(); + } + + + - - if brackets should be put on a new line and - indented. - - namespace foospace - { - int Foo() - { - if (isBar) { - bar(); - return 1; - } else - return 0; - } - } - - + + if brackets should be put on a new line and + indented. + + namespace foospace + { + int Foo() + { + if (isBar) { + bar(); + return 1; + } else + return 0; + } + } + + - - if the line after a bracket (i.e. an else - statement after the closing if) should be placed on the next line. - - - if (isFoo){ - bar(); - }else { - anotherBar(); - } - becomes: - if (isFoo) { - bar(); - } - else { - anotherBar(); - } - - - + + if the line after a bracket (i.e. an else + statement after the closing if) should be placed on the next line. + + + if (isFoo){ + bar(); + }else { + anotherBar(); + } + becomes: + if (isFoo) { + bar(); + } + else { + anotherBar(); + } + + + - - to break block statements with an empty line. - - isFoo = true; - if (isFoo) { - bar(); - } else { - anotherBar(); - } - isBar = false; - becomes: - isFoo = true; - if (isFoo) { - bar(); - } else { - anotherBar(); - } - isBar = false; - - + + to break block statements with an empty line. + + isFoo = true; + if (isFoo) { + bar(); + } else { + anotherBar(); + } + isBar = false; + becomes: + isFoo = true; + if (isFoo) { + bar(); + } else { + anotherBar(); + } + isBar = false; + + - - to break all block statements, even on - nested ifs with an empty line. - - isFoo = true; - if (isFoo) { - bar(); - } else { - anotherBar(); - } - isBar = false; - becomes: - isFoo = true; - if (isFoo) { - bar(); - } else { - anotherBar(); - } - isBar = false; - - + + to break all block statements, even on + nested ifs with an empty line. + + isFoo = true; + if (isFoo) { + bar(); + } else { + anotherBar(); + } + isBar = false; + becomes: + isFoo = true; + if (isFoo) { + bar(); + } else { + anotherBar(); + } + isBar = false; + + - - to put the if component of an else if on a - new line. - - if (isFoo) { - bar(); - } else if (isBar()){ - anotherBar(); - } - becomes: - if (isFoo) { - bar(); - } else - if (isBar()){ - anotherBar(); - } - - - + + to put the if component of an else if on a + new line. + + if (isFoo) { + bar(); + } else if (isBar()){ + anotherBar(); + } + becomes: + if (isFoo) { + bar(); + } else + if (isBar()){ + anotherBar(); + } + + + - - to pad operators with a space. - - - if (isFoo) - a = bar((b-c)*a,*d--); - becomes: - if (isFoo) - a = bar((b - c) * a, *d--); - - + + to pad operators with a space. + + + if (isFoo) + a = bar((b-c)*a,*d--); + becomes: + if (isFoo) + a = bar((b - c) * a, *d--); + + - - to pad parenthesis with a space. - - if (isFoo) - a = bar((b-c)*a,*d--); - becomes: - if ( isFoo ) - a = bar( ( b-c )*a, *d-- ); - - + + to pad parenthesis with a space. + + if (isFoo) + a = bar((b-c)*a,*d--); + becomes: + if ( isFoo ) + a = bar( ( b-c )*a, *d-- ); + + - - to pad operators and parenthesis. - - - if (isFoo) - a = bar((b-c)*a,*d--); - becomes: - if ( isFoo ) - a = bar( ( b - c ) * a, *d-- ); - - + + to pad operators and parenthesis. + + + if (isFoo) + a = bar((b-c)*a,*d--); + becomes: + if ( isFoo ) + a = bar( ( b - c ) * a, *d-- ); + + - - to keep complex statements on the same line. - - - if (isFoo) - { - isFoo = false; cout << isFoo << endl; - } - remains as is. - if (isFoo) DoBar(); - remains as is. - - + + to keep complex statements on the same line. + + + if (isFoo) + { + isFoo = false; cout << isFoo << endl; + } + remains as is. + if (isFoo) DoBar(); + remains as is. + + - - to keep single line statements on the same line. - - if (isFoo) - { isFoo = false; cout << isFoo << endl; } - remains as is. - - + + to keep single line statements on the same line. + + if (isFoo) + { isFoo = false; cout << isFoo << endl; } + remains as is. + + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Changes the current working directory. - - - - Changes the current working directory to the "subdir" - directory, relative to the project base directory. - - - - ]]> - - + + Changes the current working directory. + + + + Changes the current working directory to the "subdir" + directory, relative to the project base directory. + + + + ]]> + + - - Changes the current directory. - + + Changes the current directory. + - - The path to which the current working directory should be set. - + + The path to which the current working directory should be set. + - - Calculates checksums for a set of files. - Loosely based on Ant's Checksum task. - - - This task takes a set of input files in a fileset - and calculates a checksum for each one of them. - You can specify the algorithm to use when calculating - the checksum value (MD5 or SHA1, for example). - The calculated value is saved to a file with the same - name as the input file and an added extension either - based on the algorithm name (e.g. .MD5), or whatever - is specified through the fileext attribute. - - - - - - - - - ]]> - - + + Calculates checksums for a set of files. + Loosely based on Ant's Checksum task. + + + This task takes a set of input files in a fileset + and calculates a checksum for each one of them. + You can specify the algorithm to use when calculating + the checksum value (MD5 or SHA1, for example). + The calculated value is saved to a file with the same + name as the input file and an added extension either + based on the algorithm name (e.g. .MD5), or whatever + is specified through the fileext attribute. + + + + + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Writes a checksum to a destination file - - - + + Writes a checksum to a destination file + + + - - Name of Algorithm to use when calculating - the checksum. Can be MD5 or SHA1. - + + Name of Algorithm to use when calculating + the checksum. Can be MD5 or SHA1. + - - The generated checksum file's name will be the - original filename with "." and fileext - added to it. Defaults to the - algorithm name being used - + + The generated checksum file's name will be the + original filename with "." and fileext + added to it. Defaults to the + algorithm name being used + - - Set of files to use as input - + + Set of files to use as input + @@ -13464,10 +13464,10 @@ - - One or more alternative sets of tasks to execute. - - The set of tasks to add. + + One or more alternative sets of tasks to execute. + + The set of tasks to add. @@ -13476,28 +13476,28 @@ - - Gets a value indicating whether a fallback element is defined. - - - if a fallback element is defined; otherwise, - . - + + Gets a value indicating whether a fallback element is defined. + + + if a fallback element is defined; otherwise, + . + - - Groups a set of tasks to execute when a condition is met. - + + Groups a set of tasks to execute when a condition is met. + - - Executes embedded tasks in the order in which they are defined. - + + Executes embedded tasks in the order in which they are defined. + - - Creates and executes the embedded (child XML nodes) elements. - + + Creates and executes the embedded (child XML nodes) elements. + @@ -13511,247 +13511,247 @@ - - Used to test arbitrary boolean expression. - + + Used to test arbitrary boolean expression. + - - Generates statistics from source code. - - - Scans files in a fileset counting lines. - - - - Generate statistics for a set of C# and VB.NET sources, applying - different labels for both. - - - - - - - - - - - - - - - - - ]]> - - - - - Generate statistics for all C# sources and only output a summary to - the log. - - - - - - - - - - - - ]]> - - + + Generates statistics from source code. + + + Scans files in a fileset counting lines. + + + + Generate statistics for a set of C# and VB.NET sources, applying + different labels for both. + + + + + + + + + + + + + + + + + ]]> + + + + + Generate statistics for all C# sources and only output a summary to + the log. + + + + + + + + + + + + ]]> + + - - Set of line counters to enable. - + + Set of line counters to enable. + - - An identifier to be able to track which build last updated the - code stats file. - + + An identifier to be able to track which build last updated the + code stats file. + - - Specifies whether the results should be appended to the output file. - The default is . - + + Specifies whether the results should be appended to the output file. + The default is . + - - If you only want to show summary stats for the whole fileset - + + If you only want to show summary stats for the whole fileset + - - The name of the file to save the output to (in XML). - + + The name of the file to save the output to (in XML). + - - Register COM servers or type libraries. - - - - COM register task will try and register any type of COM related file - that needs registering. - - Executable files (.exe) will be registered as exe servers, type - libaries (.tlb) registered with RegisterTypeLib and for all other - filetypes it will attempt to register them as dll servers. - - - - Register a single dll server. - - - ]]> - - - - Register a single exe server - - - ]]> - - - - Register a set of COM files at once. - - - - - - - - - - ]]> - - + + Register COM servers or type libraries. + + + + COM register task will try and register any type of COM related file + that needs registering. + + Executable files (.exe) will be registered as exe servers, type + libaries (.tlb) registered with RegisterTypeLib and for all other + filetypes it will attempt to register them as dll servers. + + + + Register a single dll server. + + + ]]> + + + + Register a single exe server + + + ]]> + + + + Register a set of COM files at once. + + + + + + + + + + ]]> + + - - Register an inproc COM server, usually a .dll or .ocx - - + + Register an inproc COM server, usually a .dll or .ocx + + - - Register a COM type library - - + + Register a COM type library + + - - Register exe servers. - - + + Register exe servers. + + - - The name of the file to register. This is provided as an alternate - to using the task's fileset. - + + The name of the file to register. This is provided as an alternate + to using the task's fileset. + - Unregistering this time. ( /u paramater )Default is "false". + Unregistering this time. ( /u paramater )Default is "false". - - The set of files to register. - + + The set of files to register. + - - Helper class to synamically build an assembly with the correct - P/Invoke signature - + + Helper class to synamically build an assembly with the correct + P/Invoke signature + - - Register a given dll. - - - - + + Register a given dll. + + + + - - A task that concatenates a set of files. - Loosely based on Ant's Concat task. - - - - This task takes a set of input files in a fileset - and concatenates them into a single file. You can - either replace the output file, or append to it - by using the append attribute. - - - The order the files are concatenated in is not - especified. - - - - - - - - - - ]]> - - + + A task that concatenates a set of files. + Loosely based on Ant's Concat task. + + + + This task takes a set of input files in a fileset + and concatenates them into a single file. You can + either replace the output file, or append to it + by using the append attribute. + + + The order the files are concatenated in is not + especified. + + + + + + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Opens the destination file according - to the specified flags - - + + Opens the destination file according + to the specified flags + + - - Appends all specified files - - File to write to + + Appends all specified files + + File to write to - - Name of the destination file. - + + Name of the destination file. + - - Specifies whether to append to the destination file. - The default is . - + + Specifies whether to append to the destination file. + The default is . + - - Set of files to use as input. - + + Set of files to use as input. + @@ -13762,17 +13762,17 @@ The depends task never forces the execution of any target that has already been executed. It works just like the depends attribute of a . - - Executes the specified task. - + + Executes the specified task. + - - A space or comma separated dependency list of targets. - - - Expressions get evaluated when the task is executed. - + + A space or comma separated dependency list of targets. + + + Expressions get evaluated when the task is executed. + @@ -13796,84 +13796,84 @@ - - Discover the details for the specified web service. - + + Discover the details for the specified web service. + - The URL or Path to discover. + The URL or Path to discover. - Suppresses the banner. + Suppresses the banner. - Do not save the discovered documents to the local disk. + Do not save the discovered documents to the local disk. - The output directory to save discovered documents in. + The output directory to save discovered documents in. - Username of an account with credentials to access a - server that requires authentication. + Username of an account with credentials to access a + server that requires authentication. - Password of an account with credentials to access a - server that requires authentication. + Password of an account with credentials to access a + server that requires authentication. - Domain of an account with credentials to access a - server that requires authentication. + Domain of an account with credentials to access a + server that requires authentication. - URL of a proxy server to use for HTTP requests. - The default is to use the system proxy setting. + URL of a proxy server to use for HTTP requests. + The default is to use the system proxy setting. - Username of an account with credentials to access a - proxy that requires authentication. + Username of an account with credentials to access a + proxy that requires authentication. - Password of an account with credentials to access a - proxy that requires authentication. + Password of an account with credentials to access a + proxy that requires authentication. - Domain of an account with credentials to access a - proxy that requires authentication. + Domain of an account with credentials to access a + proxy that requires authentication. - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Analyzes managed code assemblies and reports information about the - assemblies, such as possible design, localization, performance, and - security improvements. - - - - this task relies on fxcopcmd.exe being in your PATH environment variable. - You can download the latest FxCop from . - - - - - - - - - - - - - ]]> - - + + Analyzes managed code assemblies and reports information about the + assemblies, such as possible design, localization, performance, and + security improvements. + + + + this task relies on fxcopcmd.exe being in your PATH environment variable. + You can download the latest FxCop from . + + + + + + + + + + + + + ]]> + + @@ -13881,187 +13881,187 @@ - - Performs logic before the external process is started - - Process. + + Performs logic before the external process is started + + Process. - - Executes the task. - + + Executes the task. + - - Builds the arguments to pass to the exe. - + + Builds the arguments to pass to the exe. + - - Applies the XSL transformation specified in /outXsl to the analysis report before saving the file. - + + Applies the XSL transformation specified in /outXsl to the analysis report before saving the file. + - - Directs analysis output to the console or to the Output window in Visual Studio .NET. By default, the XSL file FxCopConsoleOutput.xsl is applied to the output before it is displayed. - + + Directs analysis output to the console or to the Output window in Visual Studio .NET. By default, the XSL file FxCopConsoleOutput.xsl is applied to the output before it is displayed. + - - Specifies the XSL or XSLT file that contains a transformation to be applied to the analysis output before it is displayed in the console. - + + Specifies the XSL or XSLT file that contains a transformation to be applied to the analysis output before it is displayed in the console. + - - Specifies additional directories to search for assembly dependencies. FxCopCmd always searches the target assembly directory and the current working directory. - + + Specifies additional directories to search for assembly dependencies. FxCopCmd always searches the target assembly directory and the current working directory. + - - Specifies the target assembly to analyze. - + + Specifies the target assembly to analyze. + - - Specifies the name of an analysis report or project file to import. Any messages in the imported file that are marked as excluded are not included in the analysis results. - + + Specifies the name of an analysis report or project file to import. Any messages in the imported file that are marked as excluded are not included in the analysis results. + - - Specifies the file name for the analysis report. - + + Specifies the file name for the analysis report. + - - Specifies the XSL or XSLT file that is referenced by the xml-stylesheet processing instruction in the analysis report. - + + Specifies the XSL or XSLT file that is referenced by the xml-stylesheet processing instruction in the analysis report. + - - Specifies the location of the version of Mscorlib.dll that was used when building the target assemblies if this version is not installed on the computer running FxCopCmd. - + + Specifies the location of the version of Mscorlib.dll that was used when building the target assemblies if this version is not installed on the computer running FxCopCmd. + - - Specifies the filename of FxCop project file. - + + Specifies the filename of FxCop project file. + - - Specifies the filename(s) of FxCop project file(s). - + + Specifies the filename(s) of FxCop project file(s). + - - Includes a summary report with the informational messages returned by FxCopCmd. - + + Includes a summary report with the informational messages returned by FxCopCmd. + - - Comma-separated list of type names to analyze. This option disables analysis of assemblies, namespaces, and resources; only the specified types and their members are included in the analysis. - Use the wildcard character '*' at the end of the name to select multiple types. - + + Comma-separated list of type names to analyze. This option disables analysis of assemblies, namespaces, and resources; only the specified types and their members are included in the analysis. + Use the wildcard character '*' at the end of the name to select multiple types. + - - Saves the results of the analysis in the project file. - + + Saves the results of the analysis in the project file. + - - Determines if the task should fail when analysis errors occur - + + Determines if the task should fail when analysis errors occur + - - The directory in which the command will be executed. - - - The directory in which the command will be executed. The default - is the project's base directory. - - - - It will be evaluated relative to the project's - base directory if it is relative. - - + + The directory in which the command will be executed. + + + The directory in which the command will be executed. The default + is the project's base directory. + + + + It will be evaluated relative to the project's + base directory if it is relative. + + - - Gets the program arguments. - + + Gets the program arguments. + - - Installs assemblies into the Global Assembly Cache (GAC) by using the - gacutil SDK tool. - - - - Assemblies can be installed to the GAC with or without reference counting. - The full details of reference counting can be found in the SDK - documentation. - - - - Installs Shared.dll into the GAC. - - - - - - - ]]> - - - - - Installs Shared.dll and MyWeb.dll into the GAC. - - - - - - - - - ]]> - - - - - Installs Shared.dll and MyWeb.dll into the GAC and - specifies reference information. - - - - - - - - - - ]]> - - + + Installs assemblies into the Global Assembly Cache (GAC) by using the + gacutil SDK tool. + + + + Assemblies can be installed to the GAC with or without reference counting. + The full details of reference counting can be found in the SDK + documentation. + + + + Installs Shared.dll into the GAC. + + + + + + + ]]> + + + + + Installs Shared.dll and MyWeb.dll into the GAC. + + + + + + + + + ]]> + + + + + Installs Shared.dll and MyWeb.dll into the GAC and + specifies reference information. + + + + + + + + + + ]]> + + - - Base class functionality for the GAC tasks. - - - Concrete GAC tasks extend this class in order to obtain common functionality. - + + Base class functionality for the GAC tasks. + + + Concrete GAC tasks extend this class in order to obtain common functionality. + - - Stores the details of the assembly currently being operated against. This could be a name or - path, depending on the concrete task. - + + Stores the details of the assembly currently being operated against. This could be a name or + path, depending on the concrete task. + @@ -14074,101 +14074,101 @@ - - Constructs and initialises an instance of GacTask. - + + Constructs and initialises an instance of GacTask. + - - Starts the process that is wrapped by this GAC task. - - - Provided only to seal the implementation of StartProcess(). - - The process that was started. + + Starts the process that is wrapped by this GAC task. + + + Provided only to seal the implementation of StartProcess(). + + The process that was started. - - Validates the task's configuration. - + + Validates the task's configuration. + - - Executes the task. - - - Provided only to seal the implementation of ExecuteTask(). - + + Executes the task. + + + Provided only to seal the implementation of ExecuteTask(). + - - Appends any task-specific program arguments. - - The StringBuilder on which to append program arguments. - - Subclasses must override this method to return the arguments with which to run the GAC task. - + + Appends any task-specific program arguments. + + The StringBuilder on which to append program arguments. + + Subclasses must override this method to return the arguments with which to run the GAC task. + - - Invoked prior to invoking ExecuteTask() on the base class. - - - Allows, for example, subclasses to output useful information to the log. - + + Invoked prior to invoking ExecuteTask() on the base class. + + + Allows, for example, subclasses to output useful information to the log. + - - Gets or sets a value indicating whether the GAC operation will be forced. - - - The exact meaning of this property is dependent on the subclass. As such, subclasses should override this - property to provide a valid description. - + + Gets or sets a value indicating whether the GAC operation will be forced. + + + The exact meaning of this property is dependent on the subclass. As such, subclasses should override this + property to provide a valid description. + - - Specifies reference details to use when working with the GAC. - + + Specifies reference details to use when working with the GAC. + - - Concrete GAC tasks must override this property to return an array of assembly names or paths - upon which to operate. - + + Concrete GAC tasks must override this property to return an array of assembly names or paths + upon which to operate. + - - Gets the executable name for the gacutil command-line tool. - + + Gets the executable name for the gacutil command-line tool. + - - Specifies whether a reference was specified for the GAC task. - + + Specifies whether a reference was specified for the GAC task. + - - Gets the current assembly being operated against. - + + Gets the current assembly being operated against. + - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + - - Gets the program arguments with which to run the gacutil process. - + + Gets the program arguments with which to run the gacutil process. + @@ -14176,37 +14176,37 @@ - - Constructs and initialises an instance of the GacInstallTask. - + + Constructs and initialises an instance of the GacInstallTask. + - - Appends any install-specific arguments. - - The StringBuilder to append arguments to. + + Appends any install-specific arguments. + + The StringBuilder to append arguments to. - - Outputs log information. - + + Outputs log information. + - - Specifies the assemblies to install. - + + Specifies the assemblies to install. + - - Gets the assembly list to install. - + + Gets the assembly list to install. + - - If , the specified assemblies will be forcibly - installed. Any existing duplicate assemblies in the GAC will be - overwritten. The default is . - + + If , the specified assemblies will be forcibly + installed. Any existing duplicate assemblies in the GAC will be + overwritten. The default is . + @@ -14268,9 +14268,9 @@ - - The name of a file that contains an assembly manifest. - + + The name of a file that contains an assembly manifest. + @@ -14279,22 +14279,22 @@ - - Fileset are used to define multiple assemblies. - + + Fileset are used to define multiple assemblies. + - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + @@ -14303,21 +14303,21 @@ - - Installs an assembly into the global assembly cache. - + + Installs an assembly into the global assembly cache. + - - Installs an assembly into the global assembly cache. If an assembly - with the same name already exists in the global assembly cache, it is - overwritten. - + + Installs an assembly into the global assembly cache. If an assembly + with the same name already exists in the global assembly cache, it is + overwritten. + - - Uninstalls an assembly from the global assembly cache. - + + Uninstalls an assembly from the global assembly cache. + @@ -14425,253 +14425,253 @@ - - Constructs an instance of the GacUninstallTask. - + + Constructs an instance of the GacUninstallTask. + - - Appends any install-specific arguments. - - + + Appends any install-specific arguments. + + - - Outputs log information. - + + Outputs log information. + - - If , specifies that the assemblies should be - uninstalled from the native image cache. The default is . - + + If , specifies that the assemblies should be + uninstalled from the native image cache. The default is . + - - Specifies the assemblies to uninstall. - + + Specifies the assemblies to uninstall. + - - Gets the assembly list to uninstall. - + + Gets the assembly list to uninstall. + - - If , the specified assemblies will be forcibly - removed from the GAC. All references to the specified assemblies will - be removed from the GAC prior to removing the assemblies themselves. - The default is . - - - You cannot use this option to remove an assembly that was installed using Microsoft Windows Installer. - + + If , the specified assemblies will be forcibly + removed from the GAC. All references to the specified assemblies will + be removed from the GAC prior to removing the assemblies themselves. + The default is . + + + You cannot use this option to remove an assembly that was installed using Microsoft Windows Installer. + - - Compiles a Microsoft HTML Help 2.0 Project. - - - Compile a help file. - - - ]]> - - + + Compiles a Microsoft HTML Help 2.0 Project. + + + Compile a help file. + + + ]]> + + - - The name of the contents (.HxC) file. - + + The name of the contents (.HxC) file. + - - ANSI/DBCS log filename. - + + ANSI/DBCS log filename. + - - Unicode log filename. - + + Unicode log filename. + - - Root directory containing Help 2.0 project files. - + + Root directory containing Help 2.0 project files. + - - Output (.HxS) filename. - + + Output (.HxS) filename. + - - Generate no informational messages. - + + Generate no informational messages. + - - Generate no error messages. - + + Generate no error messages. + - - Generate no warning messages. - + + Generate no warning messages. + - - File to be decompiled. - + + File to be decompiled. + - - Directory to place decompiled files into. - + + Directory to place decompiled files into. + - - Arguments of program to execute - + + Arguments of program to execute + - - Registers a Microsoft HTML Help 2.0 Collection. - - - Register a help namespace. - - - ]]> - - + + Registers a Microsoft HTML Help 2.0 Collection. + + + Register a help namespace. + + + ]]> + + - Help collection namespace. + Help collection namespace. - Title identifier. + Title identifier. - Collection (.HxC) filename. + Collection (.HxC) filename. - Description of the namespace. + Description of the namespace. - Help (.HxS) filename. + Help (.HxS) filename. - Index (.HxI) filename. + Index (.HxI) filename. - Combined full-text search (.HxQ) filename. + Combined full-text search (.HxQ) filename. - Combined attribute index (.HxR) filename. + Combined attribute index (.HxR) filename. - Language ID. + Language ID. - Alias. + Alias. - Filename of a file containing HxReg commands. + Filename of a file containing HxReg commands. - Unregister a namespace, title, or alias. + Unregister a namespace, title, or alias. - - Arguments of program to execute - + + Arguments of program to execute + - - Reads String values in INI files. - - Reads the value for AutoRefresh in the MS Transaction Server section - of the VendorMISMO2.ini ini file. Stores the value in the "myvar" property. - - - - ]]> - - The file contents look like this: - - [MS Transaction Server] - Executable="VendorMISMO2.dll" - AutoRefresh=1 - - + + Reads String values in INI files. + + Reads the value for AutoRefresh in the MS Transaction Server section + of the VendorMISMO2.ini ini file. Stores the value in the "myvar" property. + + + + ]]> + + The file contents look like this: + + [MS Transaction Server] + Executable="VendorMISMO2.dll" + AutoRefresh=1 + + - - INI File to Write To. - + + INI File to Write To. + - - Key to set the value for. - + + Key to set the value for. + - - value to set. - + + value to set. + - - Section in the INI file. - + + Section in the INI file. + - - property where we store the return value. - + + property where we store the return value. + - - Sets String values in INI files. - - - Set the value for Executable in the VendorMISMO2.ini ini file - - - ]]> - - The file contents look like this: - - [MS Transaction Server] - Executable="VendorMISMO2.dll" - AutoRefresh=1 - - + + Sets String values in INI files. + + + Set the value for Executable in the VendorMISMO2.ini ini file + + + ]]> + + The file contents look like this: + + [MS Transaction Server] + Executable="VendorMISMO2.dll" + AutoRefresh=1 + + - - INI File to Write To. - + + INI File to Write To. + - - Key to set the value for. - + + Key to set the value for. + - - value to set. - + + value to set. + - - Section in the INI file. - + + Section in the INI file. + @@ -14684,231 +14684,231 @@ - Starts a server and a client process on the local computer, and stops - the server process once the client process has finished executing. + Starts a server and a client process on the local computer, and stops + the server process once the client process has finished executing. + + + + + + ]]> + + + + + + The unique identifier of the process to stop. + + + + + The name of the computer on the network on which the process must + be stopped. The default is the local computer. + + + + + The maximum amount of time to wait until the process is stopped, + expressed in milliseconds. The default is to wait indefinitely. + + + + + Loads a file's contents as NAnt properties. + + + + Each line in a .properties file stores a single property, with the + name and value separated by an equals sign. + + + Empty lines and lines that start with a '#' character are skipped. + + - - + ]]> - - - The unique identifier of the process to stop. - - - - - The name of the computer on the network on which the process must - be stopped. The default is the local computer. - - - - - The maximum amount of time to wait until the process is stopped, - expressed in milliseconds. The default is to wait indefinitely. - - - - - Loads a file's contents as NAnt properties. - - - - Each line in a .properties file stores a single property, with the - name and value separated by an equals sign. - - - Empty lines and lines that start with a '#' character are skipped. - - - - - - ]]> - - - - - The encoding to use when loading the file. The default is the - system's current ANSI code page. - + + The encoding to use when loading the file. The default is the + system's current ANSI code page. + - - The file to load properties from. - + + The file to load properties from. + - - Chain of filters used to alter the file's content as it is - copied. - + + Chain of filters used to alter the file's content as it is + copied. + - - A task that generates strongly typed WMI classes using - mgmtclassgen.exe. - - - The Management Strongly Typed Class Generator - enables you to quickly generate an early-bound - managed class for a specified Windows Management - Instrumentation (WMI) class. The generated - class simplifies the code you must write to access - an instance of the WMI class. - - - - - ]]> - - + + A task that generates strongly typed WMI classes using + mgmtclassgen.exe. + + + The Management Strongly Typed Class Generator + enables you to quickly generate an early-bound + managed class for a specified Windows Management + Instrumentation (WMI) class. The generated + class simplifies the code you must write to access + an instance of the WMI class. + + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Specifies the name of the WMI class - to generate the strongly typed class - + + Specifies the name of the WMI class + to generate the strongly typed class + - - Specifies the language in which to generate - the class. Possible values are: CS, VB, JS - + + Specifies the language in which to generate + the class. Possible values are: CS, VB, JS + - - Specifies the machine to connect to. - + + Specifies the machine to connect to. + - - Specifies the path to the WMI namespace - that contains the class. - + + Specifies the path to the WMI namespace + that contains the class. + - - Namespace of the generated .NET class - + + Namespace of the generated .NET class + - - Path of the file to generate - + + Path of the file to generate + - - User name to use when connecting to - the specified machine - + + User name to use when connecting to + the specified machine + - - Password to use when connecting to the - specified machine - + + Password to use when connecting to the + specified machine + - - Filename of program to execute - + + Filename of program to execute + - - Arguments of program to execute - + + Arguments of program to execute + - - Builds the specified targets in the project file using MSBuild. - - - - If a project file is not specified, MSBuild searches the current - working directory for a file that has a file extension that ends in - "proj" and uses that file. - - + + Builds the specified targets in the project file using MSBuild. + + + + If a project file is not specified, MSBuild searches the current + working directory for a file that has a file extension that ends in + "proj" and uses that file. + + - - Starts the external process and captures its output. - + + Starts the external process and captures its output. + - - The project to build. - + + The project to build. + - - Set or override these project-level properties. - + + Set or override these project-level properties. + - - Build these targets in this project. Use a semicolon or a comma - comma to separate multiple targets. - + + Build these targets in this project. Use a semicolon or a comma + comma to separate multiple targets. + - - Do not auto-include the MSBuild.rsp file. - + + Do not auto-include the MSBuild.rsp file. + - - Specifies the amount of information to display in the MSBuild log. - + + Specifies the amount of information to display in the MSBuild log. + - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + - - Gets the command line arguments for the external program. - - - The command line arguments for the external program. - + + Gets the command line arguments for the external program. + + + The command line arguments for the external program. + @@ -14929,175 +14929,175 @@ - - Pre-translates native code for an assembly containing IL (Intermediary - Language bytecode) on the Windows platform. - - - - - ]]> - - + + Pre-translates native code for an assembly containing IL (Intermediary + Language bytecode) on the Windows platform. + + + + + ]]> + + - Assembly path or display name. + Assembly path or display name. - If existing images should be shown. + If existing images should be shown. - If existing images should be deleted. + If existing images should be deleted. - If an image should be generated which - can be used under a debugger. + If an image should be generated which + can be used under a debugger. - If an image should be generated which - can be used under a debugger in optimized - debugging mode. + If an image should be generated which + can be used under a debugger in optimized + debugging mode. - If an image should be generated which - can be used under a profiler. + If an image should be generated which + can be used under a profiler. - - Arguments of program to execute - + + Arguments of program to execute + - - A task that generates a summary HTML - from a set of NUnit xml report files. - Loosely based on Erik Hatcher JUnitReport for Ant. - - - This task can generate a combined HTML report out of a - set of NUnit result files generated using the - XML Result Formatter. - - By default, NUnitReport will generate the combined - report using the NUnitSummary.xsl file located at the - assembly's location, but you can specify a different - XSLT template to use with the xslfile - attribute. - - Also, all the properties defined in the current - project will be passed down to the XSLT file as - template parameters, so you can access properties - such as nant.project.name, nant.version, etc. - - - - - - - - - ]]> - + + A task that generates a summary HTML + from a set of NUnit xml report files. + Loosely based on Erik Hatcher JUnitReport for Ant. + + + This task can generate a combined HTML report out of a + set of NUnit result files generated using the + XML Result Formatter. + + By default, NUnitReport will generate the combined + report using the NUnitSummary.xsl file located at the + assembly's location, but you can specify a different + XSLT template to use with the xslfile + attribute. + + Also, all the properties defined in the current + project will be passed down to the XSLT file as + template parameters, so you can access properties + such as nant.project.name, nant.version, etc. + + + + + + + + + ]]> + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done - + + This is where the work is done + - - Initializes the XmlDocument instance - used to summarize the test results - - + + Initializes the XmlDocument instance + used to summarize the test results + + - - Builds an XsltArgumentList with all - the properties defined in the - current project as XSLT parameters. - - Property List + + Builds an XsltArgumentList with all + the properties defined in the + current project as XSLT parameters. + + Property List - - Loads the XSLT Transform - - - This method will load the file specified - through the the xslfile attribute, or - the default transformation included - as a managed resource. - - The Transformation to use + + Loads the XSLT Transform + + + This method will load the file specified + through the the xslfile attribute, or + the default transformation included + as a managed resource. + + The Transformation to use - - Name of Output HTML file. - + + Name of Output HTML file. + - - XSLT file used to generate the report. - + + XSLT file used to generate the report. + - - Set of XML files to use as input - + + Set of XML files to use as input + - - Custom XmlResolver used to load the - XSLT files out of this assembly resources. - + + Custom XmlResolver used to load the + XSLT files out of this assembly resources. + - - Loads the XSLT file - - - - - + + Loads the XSLT file + + + + + - - A task that records the build's output to a file. Loosely based on Ant's - Record - task. - - - This task allows you to record the build's output, or parts of it to a - file. You can start and stop recording at any place in the build process. - - - - - - ]]> - - + + A task that records the build's output to a file. Loosely based on Ant's + Record + task. + + + This task allows you to record the build's output, or parts of it to a + file. You can start and stop recording at any place in the build process. + + + + + + ]]> + + - - This is where the work is done. - + + This is where the work is done. + - - Name of destination file. - + + Name of destination file. + @@ -15127,68 +15127,68 @@ - - Registers an assembly for use from COM clients. - - - - Refer to the Regasm - documentation for more information on the regasm tool. - - - - - Register a single assembly. - - - - ]]> - - - - - Register an assembly while exporting a typelibrary. - - - - ]]> - - - - - Register a set of assemblies at once. - - - - - - - - - ]]> - - + + Registers an assembly for use from COM clients. + + + + Refer to the Regasm + documentation for more information on the regasm tool. + + + + + Register a single assembly. + + + + ]]> + + + + + Register an assembly while exporting a typelibrary. + + + + ]]> + + + + + Register a set of assemblies at once. + + + + + + + + + ]]> + + - - The name of the file to register. This is provided as an alternate - to using the task's fileset. - + + The name of the file to register. This is provided as an alternate + to using the task's fileset. + - - Registry file to export to instead of entering the types directly - into the registry. If a fileset is used then the entries are all - collated into this file. - + + Registry file to export to instead of entering the types directly + into the registry. If a fileset is used then the entries are all + collated into this file. + - - Set the code base registry setting. - + + Set the code base registry setting. + @@ -15198,31 +15198,31 @@ - - Only refer to already registered type libraries. - + + Only refer to already registered type libraries. + - - Export the assembly to the specified type library and register it. - This attribute is ignored when a fileset is specified. - + + Export the assembly to the specified type library and register it. + This attribute is ignored when a fileset is specified. + - - Unregister the assembly. The default is . - + + Unregister the assembly. The default is . + - - The set of files to register. - + + The set of files to register. + - - Indicates that class should be validated by an XML Schema. - - None. + + Indicates that class should be validated by an XML Schema. + + None. @@ -15255,151 +15255,151 @@ - - Specifies that no reference counting scheme will be used when performing the GAC task. - + + Specifies that no reference counting scheme will be used when performing the GAC task. + - - Specifies that registry-related reference counting will be used when performing the GAC task. - - - When the scheme type is set to UninstallKey, the related scheme ID should be set to the name of the application - set in the HKLM\Software\Microsoft\Windows\CurrentVersion registry key. - - + + Specifies that registry-related reference counting will be used when performing the GAC task. + + + When the scheme type is set to UninstallKey, the related scheme ID should be set to the name of the application + set in the HKLM\Software\Microsoft\Windows\CurrentVersion registry key. + + - - Specifies that file-based reference counting will be used when performing the GAC task. - - - When the scheme type is set to FilePath, the related scheme ID should be set to the full path to the executable - file that installs the assembly. - - + + Specifies that file-based reference counting will be used when performing the GAC task. + + + When the scheme type is set to FilePath, the related scheme ID should be set to the full path to the executable + file that installs the assembly. + + - - Specifies that custom information will be supplied to accommodate reference counting. - - - When the scheme type is set to Opaque, the related scheme ID can be set to any custom piece of information. - + + Specifies that custom information will be supplied to accommodate reference counting. + + + When the scheme type is set to Opaque, the related scheme ID can be set to any custom piece of information. + - - Copies a file to a remote server using scp. - - - Copies a file using scp to a remote server. - The Username Environment variable is used. - - - Copy a single file to a remote server and path. - - - ]]> - - + + Copies a file to a remote server using scp. + + + Copies a file using scp to a remote server. + The Username Environment variable is used. + + + Copy a single file to a remote server and path. + + + ]]> + + - - The program to execute. The default is "scp". - + + The program to execute. The default is "scp". + - - The command line arguments. - + + The command line arguments. + - - The file to transfer. - + + The file to transfer. + - - The server to send the file to. - + + The server to send the file to. + - - The path on the remote server. The default is "~". - + + The path on the remote server. The default is "~". + - - The username to connect as. The default is the value of the - USERNAME environment variable. - + + The username to connect as. The default is the value of the + USERNAME environment variable. + - - The path separator used by the program. The default is "/". - + + The path separator used by the program. The default is "/". + - - Gets the filename of the external program to start. - - - The filename of the external program. - + + Gets the filename of the external program to start. + + + The filename of the external program. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - The directory in which the command will be executed. - + + The directory in which the command will be executed. + - - Converts a Visual Studio.NET Solution to a NAnt build file or nmake file. - - - - Convert the solution MySolution.sln to the NAnt build file - MySolution.build and call the new build file. - - - - - - - - ]]> - - - - - Convert the solution MySolution.sln to the NAnt build file - MySolution.build. As the solution contains one or more web - projects, one or more maps needs to be specified. - - - - - - - - - ]]> - - + + Converts a Visual Studio.NET Solution to a NAnt build file or nmake file. + + + + Convert the solution MySolution.sln to the NAnt build file + MySolution.build and call the new build file. + + + + + + + + ]]> + + + + + Convert the solution MySolution.sln to the NAnt build file + MySolution.build. As the solution contains one or more web + projects, one or more maps needs to be specified. + + + + + + + + + ]]> + + @@ -15416,119 +15416,119 @@ - - The Visual Studio.NET solution file to convert. - + + The Visual Studio.NET solution file to convert. + - - The output file format - either nant or nmake. - + + The output file format - either nant or nmake. + - - The output file name. - + + The output file name. + - - Mappings from URI to directories. These are required for web projects. - + + Mappings from URI to directories. These are required for web projects. + - - Parameters to pass to SLiNgshoT. The parameter build.basedir is required. - + + Parameters to pass to SLiNgshoT. The parameter build.basedir is required. + - - A task to execute arbitrary SQL statements against a OLEDB data source. - - - You can specify a set of sql statements inside the - sql element, or execute them from a text file that contains them. You can also - choose to execute the statements in a single batch, or execute them one by one - (even inside a transaction, if you want to). - - - - Execute a set of statements inside a transaction. - - - - INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('My Job', 22, 45); - INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('Other Job', 09, 43); - SELECT * FROM jobs; - - ]]> - - - - - Execute a set of statements from a file and write all query results - to a file. - - - - ]]> - - - - - Execute a SQL script generated by SQL Server Enterprise Manager. - - - - ]]> - - + + A task to execute arbitrary SQL statements against a OLEDB data source. + + + You can specify a set of sql statements inside the + sql element, or execute them from a text file that contains them. You can also + choose to execute the statements in a single batch, or execute them one by one + (even inside a transaction, if you want to). + + + + Execute a set of statements inside a transaction. + + + + INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('My Job', 22, 45); + INSERT INTO jobs (job_desc, min_lvl, max_lvl) VALUES('Other Job', 09, 43); + SELECT * FROM jobs; + + ]]> + + + + + Execute a set of statements from a file and write all query results + to a file. + + + + ]]> + + + + + Execute a SQL script generated by SQL Server Enterprise Manager. + + + + ]]> + + - - Initializes task and ensures the supplied attributes are valid. - + + Initializes task and ensures the supplied attributes are valid. + - - This is where the work is done. - + + This is where the work is done. + - - Executes the SQL Statements one by one. - - + + Executes the SQL Statements one by one. + + - - Executes the SQL statements in a single batch. - - + + Executes the SQL statements in a single batch. + + @@ -15538,94 +15538,94 @@ to write output to. - - Connection string used to access database. - This should be an OleDB connection string. - + + Connection string used to access database. + This should be an OleDB connection string. + - - The encoding of the files containing SQL statements. The default is - the system's current ANSI code page. - + + The encoding of the files containing SQL statements. The default is + the system's current ANSI code page. + - - File where the sql statements are defined. - - - You cannot specify both a source and an inline set of statements. - + + File where the sql statements are defined. + + + You cannot specify both a source and an inline set of statements. + - - String that separates statements from one another. - + + String that separates statements from one another. + - - If true, the statements will be executed as a single batch. - If false, they will be executed one by one. Default is true. - + + If true, the statements will be executed as a single batch. + If false, they will be executed one by one. Default is true. + - - If true, the any nant-style properties on the sql will be - expanded before execution. Default is true. - + + If true, the any nant-style properties on the sql will be + expanded before execution. Default is true. + - - Command timeout to use when creating commands. - + + Command timeout to use when creating commands. + - - Kind of delimiter used. Allowed values are Normal or Line. - - - Delimiters can be of two kinds: Normal delimiters are - always specified inline, so they permit having two - different statements in the same line. Line delimiters, - however, need to be in a line by their own. - Default is Normal. - + + Kind of delimiter used. Allowed values are Normal or Line. + + + Delimiters can be of two kinds: Normal delimiters are + always specified inline, so they permit having two + different statements in the same line. Line delimiters, + however, need to be in a line by their own. + Default is Normal. + - - If set to true, results from the statements will be - output to the build log. - + + If set to true, results from the statements will be + output to the build log. + - - If set, the results from the statements will be output to the - specified file. - + + If set, the results from the statements will be output to the + specified file. + - - If set to , all statements will be executed - within a single transaction. The default is . - + + If set to , all statements will be executed + within a single transaction. The default is . + - - Whether output should be appended to or overwrite - an existing file. The default is . - + + Whether output should be appended to or overwrite + an existing file. The default is . + - - If set to , prints headers for result sets. - The default is . - + + If set to , prints headers for result sets. + The default is . + - - The character(s) to surround result columns with when printing, the - default is an empty string. - + + The character(s) to surround result columns with when printing, the + default is an empty string. + @@ -15795,268 +15795,268 @@ - - The tasks in this block will be executed as a normal part of - the build script. - + + The tasks in this block will be executed as a normal part of + the build script. + - - The tasks in this block will be executed if any task in the try - block fails. - + + The tasks in this block will be executed if any task in the try + block fails. + - - The tasks in this block will always be executed, regardless of - what happens in the try and catch blocks. - - - Note that any failure in any of the tasks in this block will - prevent any subsequent tasks from executing. - + + The tasks in this block will always be executed, regardless of + what happens in the try and catch blocks. + + + Note that any failure in any of the tasks in this block will + prevent any subsequent tasks from executing. + - - Defines the name of the property to save the message describing - the failure that has been caught. - - - - The failure message is only available in the context of the catch - block. If you wish to preserve the message, you will need to save - it into another property. - - - Readonly properties cannot be overridden by this mechanism. - - + + Defines the name of the property to save the message describing + the failure that has been caught. + + + + The failure message is only available in the context of the catch + block. If you wish to preserve the message, you will need to save + it into another property. + + + Readonly properties cannot be overridden by this mechanism. + + - Generates collection classes based on a given XML specification file. Code generation is in the specified language. - - See the CollectionGen tool page for more information. - - - - - - - - - ]]> - - + Generates collection classes based on a given XML specification file. Code generation is in the specified language. + + See the CollectionGen tool page for more information. + + + + + + + + + ]]> + + - - The actual generation work is done here. - - - + + The actual generation work is done here. + + + - The language to generate collection classes for. Valid values are "CSharp" or "VB". + The language to generate collection classes for. Valid values are "CSharp" or "VB". - The name of the template file for collection generation. This is provided as an alternate to using the task's fileset. + The name of the template file for collection generation. This is provided as an alternate to using the task's fileset. - - All files in this fileset will be run thru the collection generator. - + + All files in this fileset will be run thru the collection generator. + - - Validates a set of XML files based on a set of XML Schemas (XSD). - - - - - - - - - - - - - ]]> - - + + Validates a set of XML files based on a set of XML Schemas (XSD). + + + + + + + + + + + + + ]]> + + - - This is where the work is done. - + + This is where the work is done. + - - The XML files that must be validated. - + + The XML files that must be validated. + - - The XML Schemas (XSD) to use for validation. - + + The XML Schemas (XSD) to use for validation. + - - Compiles Microsoft Visual Basic 6 programs. - - - - Uses the VB6.EXE executable included with the Visual Basic 6 - environment. - - - The compiler uses the settings and source files specified in the - project or group file. - - - - - Build the project HelloWorld.vbp in the build directory. - - - - ]]> - - - - - Check compiled property "vb6.compiled" - - - - - ]]> - - + + Compiles Microsoft Visual Basic 6 programs. + + + + Uses the VB6.EXE executable included with the Visual Basic 6 + environment. + + + The compiler uses the settings and source files specified in the + project or group file. + + + + + Build the project HelloWorld.vbp in the build directory. + + + + ]]> + + + + + Check compiled property "vb6.compiled" + + + + + ]]> + + - - Compiles the Visual Basic project or project group. - + + Compiles the Visual Basic project or project group. + - - Parses a VB group file and extract the file names of the sub-projects - in the group. - - The file name of the group file. - - A string collection containing the list of sub-projects in the group. - + + Parses a VB group file and extract the file names of the sub-projects + in the group. + + The file name of the group file. + + A string collection containing the list of sub-projects in the group. + - - Determines if a VB project needs to be recompiled by comparing the timestamp of - the project's files and references to the timestamp of the last built version. - - The file name of the project file. - - if the project should be compiled; otherwise, - . - + + Determines if a VB project needs to be recompiled by comparing the timestamp of + the project's files and references to the timestamp of the last built version. + + The file name of the project file. + + if the project should be compiled; otherwise, + . + - - VB6 uses a special algorithm to search for the typelib file. It doesn't - rely on the API function QueryPathOfRegTypeLib, because VB could use a newer - version of the TLB. - - The algorithm used by VB is not perfect and has some flaws, which you could - get a newer version even if your requested version is installed. This is because - the algorithm iterates the registry beneath the Guid - entry by entry - from the - beginning and returns the first TLB version that is higher or equal to the - requested version. - - pseudo code: - 1. open the key HKEY_CLASSES_ROOT\TypeLib\{Guid} - 2. If the key exists: - 3. Foreach version under the key that has the requested culture entry: - 4. If the version higher or equal to the requested version: - 5. Get the TLB filename and returns it - - The guid of the tlb to look for - The major version number of the tlb - The minor version number of the tlb. If you parse minor from a string, treat the string as hex value. - The culture id - null if couldn't find a match, otherwise it returns the file. + + VB6 uses a special algorithm to search for the typelib file. It doesn't + rely on the API function QueryPathOfRegTypeLib, because VB could use a newer + version of the TLB. + + The algorithm used by VB is not perfect and has some flaws, which you could + get a newer version even if your requested version is installed. This is because + the algorithm iterates the registry beneath the Guid - entry by entry - from the + beginning and returns the first TLB version that is higher or equal to the + requested version. + + pseudo code: + 1. open the key HKEY_CLASSES_ROOT\TypeLib\{Guid} + 2. If the key exists: + 3. Foreach version under the key that has the requested culture entry: + 4. If the version higher or equal to the requested version: + 5. Get the TLB filename and returns it + + The guid of the tlb to look for + The major version number of the tlb + The minor version number of the tlb. If you parse minor from a string, treat the string as hex value. + The culture id + null if couldn't find a match, otherwise it returns the file. - - Parses a VB project file and extracts the source files, reference files, and - the name of the compiled file for the project. - - The filename of the project file. - - A fileset representing the source files of the project, which will - populated by the method. - - - A fileset representing the references of the project, which will - populated by the method. - - A string containing the output file name for the project. + + Parses a VB project file and extracts the source files, reference files, and + the name of the compiled file for the project. + + The filename of the project file. + + A fileset representing the source files of the project, which will + populated by the method. + + + A fileset representing the references of the project, which will + populated by the method. + + A string containing the output file name for the project. - - Output directory for the compilation target. - + + Output directory for the compilation target. + - - Visual Basic project or group file. - + + Visual Basic project or group file. + - - Determines whether project references are checked when deciding - whether the project needs to be recompiled. The default is - . - + + Determines whether project references are checked when deciding + whether the project needs to be recompiled. The default is + . + - - The file to which the Visual Basic compiler should log errors. - + + The file to which the Visual Basic compiler should log errors. + - - Tells Visual Basic which values to use for conditional compilation - constants. - + + Tells Visual Basic which values to use for conditional compilation + constants. + - - The name of a property in which will be set to - if compilation was needed and done without errors (default: "vb6.compiled") - This can be used for touching the compilation files if - vb6 autoincrement is set to true to avoid recompilation without any - other changes. - + + The name of a property in which will be set to + if compilation was needed and done without errors (default: "vb6.compiled") + This can be used for touching the compilation files if + vb6 autoincrement is set to true to avoid recompilation without any + other changes. + - - Gets the filename of the external program to start. - - - The filename of the external program. - + + Gets the filename of the external program to start. + + + The filename of the external program. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + @@ -16128,22 +16128,22 @@ The version to write to . - - Calculates the build number based on the number of months since the - start date. - - - The build number based on the number of months since the start date. - + + Calculates the build number based on the number of months since the + start date. + + + The build number based on the number of months since the start date. + - - Calculates the number of seconds since midnight. - start date. - - - The number of seconds since midnight. - + + Calculates the number of seconds since midnight. + start date. + + + The number of seconds since midnight. + @@ -16155,26 +16155,26 @@ - - Calculates the complete version. - - - The version. - + + Calculates the complete version. + + + The version. + - - Calculates the revision number of the version number based on RevisionType specified - - - The revision number. - + + Calculates the revision number of the version number based on RevisionType specified + + + The revision number. + - - The string to prefix the properties with. The default is - 'buildnumber.'. - + + The string to prefix the properties with. The default is + 'buildnumber.'. + @@ -16184,10 +16184,10 @@ - - Path to the file containing the current version number. The default - file is 'build.number' in the project base directory. - + + Path to the file containing the current version number. The default + file is 'build.number' in the project base directory. + @@ -16202,40 +16202,40 @@ - - Defines possible algorithms to generate the build number. - + + Defines possible algorithms to generate the build number. + - - Use the number of months since start of project * 100 + current - day in month as build number. - + + Use the number of months since start of project * 100 + current + day in month as build number. + - - Increment an existing build number. - + + Increment an existing build number. + - - Use an existing build number (and do not increment it). - + + Use an existing build number (and do not increment it). + - - Defines possible algorithms to generate the revision number. - + + Defines possible algorithms to generate the revision number. + - - Use the number of seconds since the start of today / 10. - + + Use the number of seconds since the start of today / 10. + - - Increment an existing revision number. - + + Increment an existing revision number. + @@ -16267,110 +16267,110 @@ - - The unique identifier of the process to wait for. - + + The unique identifier of the process to wait for. + - - The maximum amount of time to wait until the process is exited, - expressed in milliseconds. The default is to wait indefinitely. - + + The maximum amount of time to wait until the process is exited, + expressed in milliseconds. The default is to wait indefinitely. + - Generates code for web service clients and xml web services - using ASP.NET from WSDL contract files, XSD Schemas and .discomap - discovery documents. Can be used in conjunction with .disco files. - - Generate a proxy class for a web service. - ]]> - + Generates code for web service clients and xml web services + using ASP.NET from WSDL contract files, XSD Schemas and .discomap + discovery documents. Can be used in conjunction with .disco files. + + Generate a proxy class for a web service. + ]]> + - URL or Path to a WSDL, XSD, or .discomap document. + URL or Path to a WSDL, XSD, or .discomap document. - Suppresses the banner. + Suppresses the banner. - Language of generated code. 'CS', 'VB', 'JS', - or the fully-qualified name of a class implementing - System.CodeDom.Compiler.CodeDomCompiler. + Language of generated code. 'CS', 'VB', 'JS', + or the fully-qualified name of a class implementing + System.CodeDom.Compiler.CodeDomCompiler. - Compiles server-side ASP.NET abstract classes - based on the web service contract. The default is to - create client side proxy classes. + Compiles server-side ASP.NET abstract classes + based on the web service contract. The default is to + create client side proxy classes. - Microsoft.NET namespace of generated classes. + Microsoft.NET namespace of generated classes. - Output filename of the created proxy. Default name is derived from the service name. + Output filename of the created proxy. Default name is derived from the service name. - Override default protocol to implement. Choose from 'SOAP', - 'HttpGet', 'HttpPost', or a custom protocol as specified in the - configuration file. + Override default protocol to implement. Choose from 'SOAP', + 'HttpGet', 'HttpPost', or a custom protocol as specified in the + configuration file. - Username of an account with credentials to access a - server that requires authentication. + Username of an account with credentials to access a + server that requires authentication. - Password of an account with credentials to access a - server that requires authentication. + Password of an account with credentials to access a + server that requires authentication. - Domain of an account with credentials to access a - server that requires authentication. + Domain of an account with credentials to access a + server that requires authentication. - URL of a proxy server to use for HTTP requests. - The default is to use the system proxy setting. + URL of a proxy server to use for HTTP requests. + The default is to use the system proxy setting. - Username of an account with credentials to access a - proxy that requires authentication. + Username of an account with credentials to access a + proxy that requires authentication. - Password of an account with credentials to access a - proxy that requires authentication. + Password of an account with credentials to access a + proxy that requires authentication. - Domain of an account with credentials to access a - proxy that requires authentication. + Domain of an account with credentials to access a + proxy that requires authentication. - Configuration key to use in the code generation to - read the default value for the Url property. The default is - not to read from the config file. + Configuration key to use in the code generation to + read the default value for the Url property. The default is + not to read from the config file. - Base Url to use when calculating the Url fragment. - The UrlKey attribute must also be specified. + Base Url to use when calculating the Url fragment. + The UrlKey attribute must also be specified. - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + @@ -16471,23 +16471,23 @@ - - XML Schema (.xsd) filename. - + + XML Schema (.xsd) filename. + - - Target of XML Schema compilation - either classes or - dataset. The default is classes. - + + Target of XML Schema compilation - either classes or + dataset. The default is classes. + - - XML element in the Schema to process. - - - TO-DO : turn this into collection of elements ! - + + XML element in the Schema to process. + + + TO-DO : turn this into collection of elements ! + @@ -16497,29 +16497,29 @@ - - Specifies the runtime namespace for the generated types. The default - namespace is Schemas. - + + Specifies the runtime namespace for the generated types. The default + namespace is Schemas. + - - The output directory in which to place generated files. - + + The output directory in which to place generated files. + - - Assembly (.dll or .exe) to generate an XML Schema for. - + + Assembly (.dll or .exe) to generate an XML Schema for. + - - Types in the assembly for which an XML schema is being created. - By default all types in the assembly will be included. - - - TO-DO : turn this into collection of types ! - + + Types in the assembly for which an XML schema is being created. + By default all types in the assembly will be included. + + + TO-DO : turn this into collection of types ! + @@ -16528,60 +16528,60 @@ - - XML document to generate an XML Schema for. - + + XML document to generate an XML Schema for. + - - XDR Schema to generate an XML Schema for. - + + XDR Schema to generate an XML Schema for. + - - Gets a value indiciating whether the external program is a managed - application which should be executed using a runtime engine, if - configured. - - - . - - - Modifying this property has no effect. - + + Gets a value indiciating whether the external program is a managed + application which should be executed using a runtime engine, if + configured. + + + . + + + Modifying this property has no effect. + - - Gets the command-line arguments for the external program. - - - The command-line arguments for the external program. - + + Gets the command-line arguments for the external program. + + + The command-line arguments for the external program. + - - Indicates the status of a service. - + + Indicates the status of a service. + - - The service is unbound. - + + The service is unbound. + - - The service is bound. - + + The service is bound. + - - The service is enlisted, but not started. - + + The service is enlisted, but not started. + - - The service is started. - + + The service is started. + @@ -16615,14 +16615,14 @@ - - Report with separate HTML frames. - + + Report with separate HTML frames. + - - Frameless report. - + + Frameless report. + @@ -16639,19 +16639,19 @@ - - Constructs and initializes an instance of Entity. - + + Constructs and initializes an instance of Entity. + - - The path for the entity. - + + The path for the entity. + - - If true then the entity will be included. The default is true. - + + If true then the entity will be included. The default is true. + @@ -16669,19 +16669,19 @@ - - Constructs and initializes an instance of EntitySet. - + + Constructs and initializes an instance of EntitySet. + - - Gets the collection of entity paths assigned to this entity set. - + + Gets the collection of entity paths assigned to this entity set. + - - The entities to include in the project task. - + + The entities to include in the project task. + @@ -16719,35 +16719,35 @@ - - Constructs and initializes an instance of Assembly. - + + Constructs and initializes an instance of Assembly. + - - Converts this Assembly object into it's string representation. - - + + Converts this Assembly object into it's string representation. + + - - The culture for the assembly. - + + The culture for the assembly. + - - If true then the assembly will be included. The default is true. - + + If true then the assembly will be included. The default is true. + - - The name of the assembly. - + + The name of the assembly. + - - The public key token of the assembly. - + + The public key token of the assembly. + @@ -16756,42 +16756,42 @@ - - The version of the assembly. - + + The version of the assembly. + - - Represents a set of assemblies via their identity information. - + + Represents a set of assemblies via their identity information. + - - Constructs and initializes an instance of AssemblySet. - + + Constructs and initializes an instance of AssemblySet. + - - Gets the collection of assemblies added to this assembly set. - + + Gets the collection of assemblies added to this assembly set. + - - The assemblies to include. - + + The assemblies to include. + - - The set of files to work on. - + + The set of files to work on. + - - The label to apply to the results. - + + The label to apply to the results. + @@ -16857,11 +16857,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -16894,10 +16894,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -16918,28 +16918,28 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + @@ -16947,14 +16947,14 @@ - - Holds the token which will be replaced in the filter operation. - + + Holds the token which will be replaced in the filter operation. + - - Holsd the value which will replace the token in the filtering operation. - + + Holsd the value which will replace the token in the filtering operation. + @@ -16970,14 +16970,14 @@ The value which will replace the token when filtering. - - The token which will be replaced when filtering. - + + The token which will be replaced when filtering. + - - The value which will replace the token when filtering. - + + The value which will replace the token when filtering. + @@ -17042,11 +17042,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -17079,10 +17079,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -17103,48 +17103,48 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - A set of filters to be applied to something. - - - - A filter set may have begintoken and endtokens defined. - - + + A set of filters to be applied to something. + + + + A filter set may have begintoken and endtokens defined. + + - - The default token start string. - + + The default token start string. + - - The default token end string. - + + The default token end string. + @@ -17152,30 +17152,30 @@ - - Does replacement on the given string with token matching. - - The line to process the tokens in. - - The line with the tokens replaced. - + + Does replacement on the given string with token matching. + + The line to process the tokens in. + + The line with the tokens replaced. + - - The string used to identity the beginning of a token. The default is - @. - + + The string used to identity the beginning of a token. The default is + @. + - - The string used to identify the end of a token. The default is - @. - + + The string used to identify the end of a token. The default is + @. + - - The filters to apply. - + + The filters to apply. + @@ -17229,11 +17229,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -17266,28 +17266,28 @@ The to remove from the collection. - - Does replacement on the given string with token matching. - - The line to process the tokens in. - - The line with the tokens replaced. - + + Does replacement on the given string with token matching. + + The line to process the tokens in. + + The line with the tokens replaced. + - - Checks to see if there are filters in the collection of filtersets. - - - if there are filters in this collection of - filtersets; otherwise, . - + + Checks to see if there are filters in the collection of filtersets. + + + if there are filters in this collection of + filtersets; otherwise, . + - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -17302,38 +17302,38 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Used to specify reference information when working with the GAC. - - - - The full details of GAC references can be found in the SDK documentation. - - + + Used to specify reference information when working with the GAC. + + + + The full details of GAC references can be found in the SDK documentation. + + @@ -17361,35 +17361,35 @@ - - Constructs and initializes an instance of GacReference. - + + Constructs and initializes an instance of GacReference. + - - If true then the entity will be included. The default is true. - + + If true then the entity will be included. The default is true. + - - The scheme type to use when working with GAC references. The default - is , which means that references will - not be used by the GAC task. - + + The scheme type to use when working with GAC references. The default + is , which means that references will + not be used by the GAC task. + - - The scheme ID to use when working with GAC references. This is only - relevant if a scheme type other than - is specified. - + + The scheme ID to use when working with GAC references. This is only + relevant if a scheme type other than + is specified. + - - The scheme description to use when working with GAC references. This - is only relevant if a scheme type other than - is specified. - + + The scheme description to use when working with GAC references. This + is only relevant if a scheme type other than + is specified. + @@ -17398,27 +17398,27 @@ - - Represents the an element based on a schema definition. - + + Represents the an element based on a schema definition. + - - Represents the schema collection element. - + + Represents the schema collection element. + - - Namespace URI associated with this schema. - If not present, it is assumed that the - schema's targetNamespace value is to be used. - + + Namespace URI associated with this schema. + If not present, it is assumed that the + schema's targetNamespace value is to be used. + - - Location of this schema. Could be a - local file path or an HTTP URL. - + + Location of this schema. Could be a + local file path or an HTTP URL. + @@ -17484,11 +17484,11 @@ - - Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. - - The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. - The zero-based index in at which copying begins. + + Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array. + + The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing. + The zero-based index in at which copying begins. @@ -17521,10 +17521,10 @@ The to remove from the collection. - - Gets or sets the element at the specified index. - - The zero-based index of the element to get or set. + + Gets or sets the element at the specified index. + + The zero-based index of the element to get or set. @@ -17545,34 +17545,34 @@ The collection that should be enumerated. - - Advances the enumerator to the next element of the collection. - - - if the enumerator was successfully advanced - to the next element; if the enumerator has - passed the end of the collection. - + + Advances the enumerator to the next element of the collection. + + + if the enumerator was successfully advanced + to the next element; if the enumerator has + passed the end of the collection. + - - Sets the enumerator to its initial position, which is before the - first element in the collection. - + + Sets the enumerator to its initial position, which is before the + first element in the collection. + - - Gets the current element in the collection. - - - The current element in the collection. - + + Gets the current element in the collection. + + + The current element in the collection. + - - Helper class to calculate checksums - of files. - + + Helper class to calculate checksums + of files. + @@ -17582,50 +17582,50 @@ The specified hash algorithm does not exist. - - Calculates a checksum for a given file - and returns it in a hex string - - name of the input file - hex checksum string + + Calculates a checksum for a given file + and returns it in a hex string + + name of the input file + hex checksum string - - Converts a checksum value (a byte array) - into a Hex-formatted string. - - Checksum value to convert - Hexified string value + + Converts a checksum value (a byte array) + into a Hex-formatted string. + + Checksum value to convert + Hexified string value - - Recorder interface user with the Record task - + + Recorder interface user with the Record task + - - Starts recording. - + + Starts recording. + - - Stops recording. - + + Stops recording. + - - Closes the recorder. - + + Closes the recorder. + - - Flushes the recorder. - + + Flushes the recorder. + - - Gets the name of this recorder (possibly a file name). - + + Gets the name of this recorder (possibly a file name). + @@ -17633,15 +17633,15 @@ - - Defines whether the underlying writer is automatically flushes or - not. - + + Defines whether the underlying writer is automatically flushes or + not. + - - Keeps track of used recorders - + + Keeps track of used recorders + @@ -17650,9 +17650,9 @@ - - Flushes buffered build events or messages to the underlying storage. - + + Flushes buffered build events or messages to the underlying storage. + @@ -17720,11 +17720,11 @@ - - Empty implementation which allows derived classes to receive the - output that is generated in this logger. - - The message being logged. + + Empty implementation which allows derived classes to receive the + output that is generated in this logger. + + The message being logged. @@ -17754,28 +17754,28 @@ TODO - - Gets or sets the highest level of message this logger should respond - to. - - - The highest level of message this logger should respond to. - - - Only messages with a message level higher than or equal to the given - level should be written to the log. - + + Gets or sets the highest level of message this logger should respond + to. + + + The highest level of message this logger should respond to. + + + Only messages with a message level higher than or equal to the given + level should be written to the log. + - - Gets or sets a value indicating whether to produce emacs (and other - editor) friendly output. - - - if output is to be unadorned so that emacs - and other editors can parse files names, etc. The default is - . - + + Gets or sets a value indicating whether to produce emacs (and other + editor) friendly output. + + + if output is to be unadorned so that emacs + and other editors can parse files names, etc. The default is + . + @@ -17784,9 +17784,9 @@ - - Groups a set of useful file manipulation methods. - + + Groups a set of useful file manipulation methods. + @@ -17817,161 +17817,161 @@ The collection of filtersets that should be applied to the file. - - Given an absolute directory and an absolute file name, returns a - relative file name. - - An absolute directory. - An absolute file name. - - A relative file name for the given absolute file name. - + + Given an absolute directory and an absolute file name, returns a + relative file name. + + An absolute directory. + An absolute file name. + + A relative file name for the given absolute file name. + - - Returns a string from your INI file - - - - - + + Returns a string from your INI file + + + + + - - ' Writes a string to your INI file - - - - + + ' Writes a string to your INI file + + + + - - Helper class used to execute Sql Statements. - + + Helper class used to execute Sql Statements. + - - Initializes a new instance. - - OleDB Connection string - True if you want to use a transaction + + Initializes a new instance. + + OleDB Connection string + True if you want to use a transaction - - Close the connection and terminate - - true if the transaction should be commited + + Close the connection and terminate + + true if the transaction should be commited - - Executes a SQL statement. - - SQL statement to execute - Command timeout to use - Data reader used to check the result + + Executes a SQL statement. + + SQL statement to execute + Command timeout to use + Data reader used to check the result - - OleDB Connection object - + + OleDB Connection object + - - Helper class to adapt SQL statements from some - input into something OLEDB can consume directly - + + Helper class to adapt SQL statements from some + input into something OLEDB can consume directly + - - Creates a new instance - - + + Creates a new instance + + - - Adapts a set of Sql statements from a string. - - A string containing the original sql statements + + Adapts a set of Sql statements from a string. + + A string containing the original sql statements - - Adapts a set of Sql statements from a string. - - Path of file containing all sql statements - The encoding of the file containing the SQL statements. - The new instance + + Adapts a set of Sql statements from a string. + + Path of file containing all sql statements + The encoding of the file containing the SQL statements. + The new instance - - Determines how the delimiter is interpreted in a SQL string. - + + Determines how the delimiter is interpreted in a SQL string. + - - Delimiter can appear anywhere on a line. - + + Delimiter can appear anywhere on a line. + - - Delimiter always appears by itself on a line. - + + Delimiter always appears by itself on a line. + - - Helper class to maintain a list of SQL Statements. - + + Helper class to maintain a list of SQL Statements. + - - Initializes a new instance. - - String that separates statements from each other - Style of the delimiter + + Initializes a new instance. + + String that separates statements from each other + Style of the delimiter - - Parses the SQL into the internal list using the specified delimiter - and delimiter style - - The SQL string to parse. + + Parses the SQL into the internal list using the specified delimiter + and delimiter style + + The SQL string to parse. - - Parses the contents of the file into the - internal list using the specified delimiter - and delimiter style - - File name - The encoding of the file containing the SQL statements. + + Parses the contents of the file into the + internal list using the specified delimiter + and delimiter style + + File name + The encoding of the file containing the SQL statements. - - Allows foreach(). - - + + Allows foreach(). + + - - Expands project properties in the - sql string - - - + + Expands project properties in the + sql string + + + - - Gets the number of statements in the list. - + + Gets the number of statements in the list. + - - Gets the statement specified by the index. - + + Gets the statement specified by the index. + - - Project's properties for property expansion - + + Project's properties for property expansion + diff --git a/lib/NAnt.Core.dll b/lib/NAnt.Core.dll index df9936b..1083a42 100755 Binary files a/lib/NAnt.Core.dll and b/lib/NAnt.Core.dll differ diff --git a/src/Dbdeploy.Console/OptionsManager.cs b/src/Dbdeploy.Console/OptionsManager.cs index e643f0b..86c34b5 100644 --- a/src/Dbdeploy.Console/OptionsManager.cs +++ b/src/Dbdeploy.Console/OptionsManager.cs @@ -87,7 +87,7 @@ private static OptionSet Initialize(DbDeployConfig config, ConfigFileInfo config options .Add( "d|dbms=", - "DBMS type ('mssql', 'mysql' or 'ora')", + "DBMS type ('mssql', 'mysql', 'ora' or 'postgresql')", s => config.Dbms = s) .Add( diff --git a/src/Dbdeploy.Powershell/Commands/DbUpdateBase.cs b/src/Dbdeploy.Powershell/Commands/DbUpdateBase.cs index 975af2c..f198b70 100644 --- a/src/Dbdeploy.Powershell/Commands/DbUpdateBase.cs +++ b/src/Dbdeploy.Powershell/Commands/DbUpdateBase.cs @@ -87,5 +87,19 @@ protected string ToAbsolutePath(string deltasDirectory) return deltasDirectory; } + + protected DbDeployConfig ConfigFromParameters() + { + return new DbDeployConfig + { + Dbms = this.DatabaseType, + ConnectionString = this.ConnectionString, + ChangeLogTableName = this.TableName, + ScriptDirectory = new DirectoryInfo(this.deltasDirectory), + AutoCreateChangeLogTable = this.AutoCreateChangeLogTable, + ForceUpdate = this.ForceUpdate, + UseSqlCmd = this.UseSqlCmd + }; + } } } \ No newline at end of file diff --git a/src/Dbdeploy.Powershell/Commands/ExportDbUpdate.cs b/src/Dbdeploy.Powershell/Commands/ExportDbUpdate.cs index e83ec3e..ba4a31d 100644 --- a/src/Dbdeploy.Powershell/Commands/ExportDbUpdate.cs +++ b/src/Dbdeploy.Powershell/Commands/ExportDbUpdate.cs @@ -30,21 +30,12 @@ protected override void ProcessRecord() return; } - var config = new DbDeployConfig - { - Dbms = this.DatabaseType, - ConnectionString = this.ConnectionString, - ChangeLogTableName = this.TableName, - ScriptDirectory = new DirectoryInfo(this.deltasDirectory), - AutoCreateChangeLogTable = this.AutoCreateChangeLogTable, - ForceUpdate = this.ForceUpdate, - UseSqlCmd = this.UseSqlCmd, - OutputFile = new FileInfo(this.ToAbsolutePath(this.OutputFile)) - }; + var config = ConfigFromParameters(); + config.OutputFile = new FileInfo(this.ToAbsolutePath(this.OutputFile)); if (!string.IsNullOrEmpty(this.UndoOutputFile)) { - config.OutputFile = new FileInfo(this.ToAbsolutePath(UndoOutputFile)); + config.UndoOutputFile = new FileInfo(this.ToAbsolutePath(UndoOutputFile)); } var deployer = new DbDeployer(); diff --git a/src/Dbdeploy.Powershell/Commands/PushDbUpdate.cs b/src/Dbdeploy.Powershell/Commands/PushDbUpdate.cs index 335e898..7c5cc7e 100644 --- a/src/Dbdeploy.Powershell/Commands/PushDbUpdate.cs +++ b/src/Dbdeploy.Powershell/Commands/PushDbUpdate.cs @@ -13,13 +13,7 @@ protected override void ProcessRecord() { base.ProcessRecord(); - var config = new DbDeployConfig - { - Dbms = DatabaseType, - ConnectionString = ConnectionString, - ChangeLogTableName = TableName, - ScriptDirectory = new DirectoryInfo(deltasDirectory), - }; + var config = ConfigFromParameters(); var deployer = new DbDeployer(); deployer.Execute(config, new LambdaTextWriter(WriteVerbose)); diff --git a/src/Net.Sf.Dbdeploy/Appliers/SqlCmdApplier.cs b/src/Net.Sf.Dbdeploy/Appliers/SqlCmdApplier.cs index 28d4638..c773f30 100644 --- a/src/Net.Sf.Dbdeploy/Appliers/SqlCmdApplier.cs +++ b/src/Net.Sf.Dbdeploy/Appliers/SqlCmdApplier.cs @@ -1,35 +1,35 @@ -namespace Net.Sf.Dbdeploy.Appliers -{ - using System; - using System.Collections.Generic; - using System.Globalization; - using System.IO; - using System.Linq; - using System.Text; - - using Net.Sf.Dbdeploy.Database; - using Net.Sf.Dbdeploy.Database.SqlCmd; - using Net.Sf.Dbdeploy.Exceptions; - using Net.Sf.Dbdeploy.Scripts; - - /// - /// Applier for running scripts using SQLCMD mode against MSSQL. - /// - public class SqlCmdApplier : IChangeScriptApplier - { - /// - /// The database connection string. - /// - private readonly string connectionString; - - /// - /// The info text writer to display output information. - /// - private readonly TextWriter infoTextWriter; - - /// - /// The schema version manager for tracking change scripts. - /// +namespace Net.Sf.Dbdeploy.Appliers +{ + using System; + using System.Collections.Generic; + using System.Globalization; + using System.IO; + using System.Linq; + using System.Text; + + using Net.Sf.Dbdeploy.Database; + using Net.Sf.Dbdeploy.Database.SqlCmd; + using Net.Sf.Dbdeploy.Exceptions; + using Net.Sf.Dbdeploy.Scripts; + + /// + /// Applier for running scripts using SQLCMD mode against MSSQL. + /// + public class SqlCmdApplier : IChangeScriptApplier + { + /// + /// The database connection string. + /// + private readonly string connectionString; + + /// + /// The info text writer to display output information. + /// + private readonly TextWriter infoTextWriter; + + /// + /// The schema version manager for tracking change scripts. + /// private readonly DatabaseSchemaVersionManager schemaVersionManager; /// @@ -54,39 +54,39 @@ public SqlCmdApplier( string connectionString, DatabaseSchemaVersionManager schemaVersionManager, IDbmsSyntax dbmsSyntax, - string changeLogTableName, - TextWriter infoTextWriter) - { - if (string.IsNullOrWhiteSpace(connectionString)) - { - throw new ArgumentNullException("connectionString"); - } - - if (schemaVersionManager == null) - { - throw new ArgumentNullException("schemaVersionManager"); + string changeLogTableName, + TextWriter infoTextWriter) + { + if (string.IsNullOrWhiteSpace(connectionString)) + { + throw new ArgumentNullException("connectionString"); } - if (dbmsSyntax == null) + if (schemaVersionManager == null) { - throw new ArgumentNullException("dbmsSyntax"); + throw new ArgumentNullException("schemaVersionManager"); } - if (changeLogTableName == null) + if (dbmsSyntax == null) { - throw new ArgumentNullException("changeLogTableName"); - } - - if (infoTextWriter == null) - { - throw new ArgumentNullException("infoTextWriter"); - } - + throw new ArgumentNullException("dbmsSyntax"); + } + + if (changeLogTableName == null) + { + throw new ArgumentNullException("changeLogTableName"); + } + + if (infoTextWriter == null) + { + throw new ArgumentNullException("infoTextWriter"); + } + this.schemaVersionManager = schemaVersionManager; this.dbmsSyntax = dbmsSyntax; this.changeLogTableName = changeLogTableName; - this.infoTextWriter = infoTextWriter; - this.connectionString = connectionString; + this.infoTextWriter = infoTextWriter; + this.connectionString = connectionString; } /// @@ -94,22 +94,22 @@ public SqlCmdApplier( /// /// The change scripts. /// Whether the change log table script should also be generated at the top - public void Apply(IEnumerable changeScripts, bool createChangeLogTable) + public void Apply(IEnumerable changeScripts, bool createChangeLogTable) { - using (var sqlCmdExecutor = new SqlCmdExecutor(this.connectionString)) + using (var sqlCmdExecutor = new SqlCmdExecutor(this.connectionString)) { if (createChangeLogTable) { CreateChangeLogTable(sqlCmdExecutor); } - this.infoTextWriter.WriteLine(changeScripts.Any() ? "Applying change scripts...\n" : "No changes to apply.\n"); - - foreach (var script in changeScripts) - { + this.infoTextWriter.WriteLine(changeScripts.Any() ? "Applying change scripts...\n" : "No changes to apply.\n"); + + foreach (var script in changeScripts) + { RunScript(script, sqlCmdExecutor); - } - } + } + } } private void CreateChangeLogTable(SqlCmdExecutor sqlCmdExecutor) @@ -155,5 +155,5 @@ private void RunScript(ChangeScript script, SqlCmdExecutor sqlCmdExecutor) output.ToString()); } } - } -} + } +} diff --git a/src/Net.Sf.Dbdeploy/Database/DatabaseSchemaVersionManager.cs b/src/Net.Sf.Dbdeploy/Database/DatabaseSchemaVersionManager.cs index 8f3eae5..ed43447 100755 --- a/src/Net.Sf.Dbdeploy/Database/DatabaseSchemaVersionManager.cs +++ b/src/Net.Sf.Dbdeploy/Database/DatabaseSchemaVersionManager.cs @@ -66,11 +66,11 @@ public virtual IList GetAppliedChanges() while (reader.Read()) { var folder = GetValue(reader, "Folder"); - var scriptNumber = GetValue(reader, "ScriptNumber"); + var scriptNumber = GetValue(reader, "ScriptNumber"); var changeEntry = new ChangeEntry(folder, scriptNumber); changeEntry.ChangeId = GetValue(reader, "ChangeId"); changeEntry.ScriptName = GetValue(reader, "ScriptName"); - changeEntry.Status = (ScriptStatus)GetValue(reader, "ScriptStatus"); + changeEntry.Status = (ScriptStatus)GetByteValue(reader, "ScriptStatus"); changeEntry.Output = GetValue(reader, "ScriptOutput"); changes.Add(changeEntry); @@ -129,7 +129,7 @@ public virtual void RecordScriptStatus(ChangeScript script, ScriptStatus status, { var sql = string.Format( CultureInfo.InvariantCulture, -@"INSERT INTO {0} (Folder, ScriptNumber, ScriptName, StartDate, CompleteDate, AppliedBy, ScriptStatus, ScriptOutput) VALUES (@1, @2, @3, {1}, {2}, {3}, @4, @5) +@"INSERT INTO {0} (Folder, ScriptNumber, ScriptName, StartDate, CompleteDate, AppliedBy, ScriptStatus, ScriptOutput) VALUES (@1, @2, @3, {1}, {2}, {3}, @4, @5) ; SELECT ChangeId FROM {0} WHERE Folder = @1 and ScriptNumber = @2", this.changeLogTableName, this.syntax.CurrentTimestamp, @@ -184,6 +184,18 @@ private static T GetValue(IDataReader reader, string name) return value; } + // Npgsql doesn't have a mapping to byte that I know of. + // This is here to support that particular case + private static byte GetByteValue(IDataReader reader, string name) + { + var columnValue = reader[name]; + if (columnValue != DBNull.Value) + { + return Convert.ToByte(columnValue); + } + return default(byte); + } + /// /// Creates the change log table in the database. /// diff --git a/src/Net.Sf.Dbdeploy/Database/DbProviderFile.cs b/src/Net.Sf.Dbdeploy/Database/DbProviderFile.cs index c4d0750..c897a02 100755 --- a/src/Net.Sf.Dbdeploy/Database/DbProviderFile.cs +++ b/src/Net.Sf.Dbdeploy/Database/DbProviderFile.cs @@ -10,25 +10,26 @@ public class DbProviderFile { public const string ProviderFilename = @"dbproviders.xml"; - private string path; - public DbProviderFile() { - this.path = null; + this.Path = null; } - public string Path - { - get { return this.path; } - set { this.path = value; } - } + public string Path { get; set; } public DbProviders LoadProviders() { Stream providerStream; - if (Path == null) providerStream = GetType().Assembly.GetManifestResourceStream(GetType(), ProviderFilename); - else if (!File.Exists(Path)) throw new FileNotFoundException("Could not load provider file from " + path); - else providerStream = File.OpenRead(Path); + if (!string.IsNullOrWhiteSpace(Path) && !System.IO.File.Exists(Path)) + throw new FileNotFoundException("File not found for loading providers", Path); + var path = ProviderFilename; + if (!File.Exists(path)) + path = System.IO.Path.Combine(System.IO.Path.GetDirectoryName(GetType().Assembly.Location), path); + + if (File.Exists(path)) + providerStream = File.OpenRead(path); + else + providerStream = GetType().Assembly.GetManifestResourceStream(GetType(), ProviderFilename); using (providerStream) using (XmlReader reader = new XmlTextReader(providerStream)) @@ -38,20 +39,20 @@ public DbProviders LoadProviders() return (DbProviders)serializer.Deserialize(reader); } } - + private static string GetDefaultPath() { DirectoryInfo assemblyDirectory = new FileInfo(Assembly.GetExecutingAssembly().Location).Directory; string providerFilePath = System.IO.Path.Combine(assemblyDirectory.FullName, ProviderFilename); - + if (!File.Exists(providerFilePath)) { providerFilePath = System.IO.Path.Combine(Environment.CurrentDirectory, ProviderFilename); } - + return providerFilePath; } } -} +} \ No newline at end of file diff --git a/src/Net.Sf.Dbdeploy/Database/DbmsFactory.cs b/src/Net.Sf.Dbdeploy/Database/DbmsFactory.cs index 8d4e8fd..1dbbca0 100755 --- a/src/Net.Sf.Dbdeploy/Database/DbmsFactory.cs +++ b/src/Net.Sf.Dbdeploy/Database/DbmsFactory.cs @@ -30,8 +30,10 @@ public virtual IDbmsSyntax CreateDbmsSyntax() return new MsSqlDbmsSyntax(); case "mysql": return new MySqlDbmsSyntax(); + case "postgresql": + return new PostgresqlDbmsSyntax(); default: - throw new ArgumentException("Supported dbms: ora, mssql, mysql"); + throw new ArgumentException("Supported dbms: ora, mssql, mysql, postgresql"); } } diff --git a/src/Net.Sf.Dbdeploy/Database/PostgresqlDbmsSyntax.cs b/src/Net.Sf.Dbdeploy/Database/PostgresqlDbmsSyntax.cs new file mode 100644 index 0000000..119816b --- /dev/null +++ b/src/Net.Sf.Dbdeploy/Database/PostgresqlDbmsSyntax.cs @@ -0,0 +1,38 @@ +namespace Net.Sf.Dbdeploy.Database +{ + public class PostgresqlDbmsSyntax : DbmsSyntax + { + /// + /// Initializes a new instance of the class. + /// + public PostgresqlDbmsSyntax() : base("postgresql") + {} + + public override string TableExists(string tableName) + { + return base.TableExists(tableName.ToLowerInvariant()); + } + + /// + /// Gets the get timestamp. + /// + /// + /// The get timestamp. + /// + public override string CurrentTimestamp + { + get { return "CURRENT_TIMESTAMP"; } + } + + /// + /// Gets the syntax to get the current user. + /// + /// + /// The current user syntax. + /// + public override string CurrentUser + { + get { return "CURRENT_USER"; } + } + } +} \ No newline at end of file diff --git a/src/Net.Sf.Dbdeploy/Database/QueryExecuter.cs b/src/Net.Sf.Dbdeploy/Database/QueryExecuter.cs index ddd6e1a..de878f1 100644 --- a/src/Net.Sf.Dbdeploy/Database/QueryExecuter.cs +++ b/src/Net.Sf.Dbdeploy/Database/QueryExecuter.cs @@ -162,7 +162,10 @@ public void InfoMessageEventHandler(object sender, EventArgs args) { if (this.currentOutput != null) { - this.currentOutput.AppendLine(((dynamic)args).Message); + foreach (var errorMessage in ((dynamic)args).errors) + { + this.currentOutput.AppendLine(errorMessage.Message); + } } } diff --git a/src/Net.Sf.Dbdeploy/Database/SqlCmd/SqlCmdExecutor.cs b/src/Net.Sf.Dbdeploy/Database/SqlCmd/SqlCmdExecutor.cs index 853f115..c2ff863 100644 --- a/src/Net.Sf.Dbdeploy/Database/SqlCmd/SqlCmdExecutor.cs +++ b/src/Net.Sf.Dbdeploy/Database/SqlCmd/SqlCmdExecutor.cs @@ -1,106 +1,106 @@ -namespace Net.Sf.Dbdeploy.Database.SqlCmd -{ +namespace Net.Sf.Dbdeploy.Database.SqlCmd +{ using System; using System.Collections.Generic; - using System.Globalization; - using System.IO; - using System.Reflection; - using System.Text; - - using Net.Sf.Dbdeploy.Appliers; - - using System.Diagnostics; - - /// - /// Manager for handling execution and deployment of SQLCMD. - /// - public class SqlCmdExecutor : IDisposable - { - /// - /// The SQLCMD file name. - /// - private const string SqlCmdFileName = "SQLCMD.EXE"; - - /// - /// The SQL CMD resource file. - /// - private const string SqlCmdResourceFile = "SQLCMD.rll"; - - /// - /// The timeout for running SQLCMD. - /// - private const int SqlCmdTimeout = 60000; - - /// - /// The error severity for SQLCMD exiting. - /// - private const int ErrorSeverity = 1; - - /// - /// The path to deploy to SQLCMD to temporarily to execution. - /// - private static readonly string ExtractPath; - - /// - /// The connection string for the database. - /// + using System.Globalization; + using System.IO; + using System.Reflection; + using System.Text; + + using Net.Sf.Dbdeploy.Appliers; + + using System.Diagnostics; + + /// + /// Manager for handling execution and deployment of SQLCMD. + /// + public class SqlCmdExecutor : IDisposable + { + /// + /// The SQLCMD file name. + /// + private const string SqlCmdFileName = "SQLCMD.EXE"; + + /// + /// The SQL CMD resource file. + /// + private const string SqlCmdResourceFile = "SQLCMD.rll"; + + /// + /// The timeout for running SQLCMD. + /// + private const int SqlCmdTimeout = 60000; + + /// + /// The error severity for SQLCMD exiting. + /// + private const int ErrorSeverity = 1; + + /// + /// The path to deploy to SQLCMD to temporarily to execution. + /// + private static readonly string ExtractPath; + + /// + /// The connection string for the database. + /// private readonly string connectionString; - /// - /// Initializes static members of the class. - /// - static SqlCmdExecutor() - { - ExtractPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location); - } - - /// - /// Initializes a new instance of the class. - /// - /// The connection string. - public SqlCmdExecutor(string connectionString) - { - this.connectionString = connectionString; - DeploySqlCmd(); - } - - /// - /// Executes the SQL script file. - /// - /// The file. - /// The output of the script run. - /// - /// true if the SQL file succeeded; otherwise false. - /// - public bool ExecuteFile(FileInfo file, StringBuilder output) - { - bool success; - using (var process = new Process()) - { - process.StartInfo = new ProcessStartInfo - { - CreateNoWindow = true, - UseShellExecute = false, - WindowStyle = ProcessWindowStyle.Hidden, - FileName = GetResourceFilePath(SqlCmdFileName), - Arguments = BuildCommandArguments(this.connectionString, file), - RedirectStandardError = true, - RedirectStandardOutput = true - }; - - process.Start(); - process.WaitForExit(SqlCmdTimeout); - - var standardOut = process.StandardOutput.ReadToEnd(); - output.AppendLine(standardOut); - - var standardError = process.StandardError.ReadToEnd(); - output.Append(standardError); - - success = process.ExitCode == 0; - } - - return success; + /// + /// Initializes static members of the class. + /// + static SqlCmdExecutor() + { + ExtractPath = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location); + } + + /// + /// Initializes a new instance of the class. + /// + /// The connection string. + public SqlCmdExecutor(string connectionString) + { + this.connectionString = connectionString; + DeploySqlCmd(); + } + + /// + /// Executes the SQL script file. + /// + /// The file. + /// The output of the script run. + /// + /// true if the SQL file succeeded; otherwise false. + /// + public bool ExecuteFile(FileInfo file, StringBuilder output) + { + bool success; + using (var process = new Process()) + { + process.StartInfo = new ProcessStartInfo + { + CreateNoWindow = true, + UseShellExecute = false, + WindowStyle = ProcessWindowStyle.Hidden, + FileName = GetResourceFilePath(SqlCmdFileName), + Arguments = BuildCommandArguments(this.connectionString, file), + RedirectStandardError = true, + RedirectStandardOutput = true + }; + + process.Start(); + process.WaitForExit(SqlCmdTimeout); + + var standardOut = process.StandardOutput.ReadToEnd(); + output.AppendLine(standardOut); + + var standardError = process.StandardError.ReadToEnd(); + output.Append(standardError); + + success = process.ExitCode == 0; + } + + return success; } public bool ExecuteString(string script, StringBuilder output) @@ -121,117 +121,117 @@ public bool ExecuteString(string script, StringBuilder output) } } } - - - /// - /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - /// - public void Dispose() - { + + + /// + /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + /// + public void Dispose() + { CleanUpSqlCmd(); - } - - /// - /// Extracts the SQL CMD to be able to execute against it. - /// - private static void DeploySqlCmd() - { - // Extract SQLCMD and dependencies from resource to the file system so it can be run. - ExtractFile(SqlCmdFileName); - ExtractFile(SqlCmdResourceFile); - } - - /// - /// Extracts resource to file. - /// - /// The resource key. - private static void ExtractFile(string resourceKey) - { - Assembly assembly = Assembly.GetExecutingAssembly(); - string resourceName = string.Format("Net.Sf.Dbdeploy.Resources.{0}", resourceKey); - using (Stream resourceStream = assembly.GetManifestResourceStream(resourceName)) - { - using (var fileStream = new FileStream(GetResourceFilePath(resourceKey), FileMode.Create)) - { - resourceStream.CopyTo(fileStream); - } - } - } - - /// - /// Cleans up SQLCMD from the file system. - /// - private static void CleanUpSqlCmd() - { + } + + /// + /// Extracts the SQL CMD to be able to execute against it. + /// + private static void DeploySqlCmd() + { + // Extract SQLCMD and dependencies from resource to the file system so it can be run. + ExtractFile(SqlCmdFileName); + ExtractFile(SqlCmdResourceFile); + } + + /// + /// Extracts resource to file. + /// + /// The resource key. + private static void ExtractFile(string resourceKey) + { + Assembly assembly = Assembly.GetExecutingAssembly(); + string resourceName = string.Format("Net.Sf.Dbdeploy.Resources.{0}", resourceKey); + using (Stream resourceStream = assembly.GetManifestResourceStream(resourceName)) + { + using (var fileStream = new FileStream(GetResourceFilePath(resourceKey), FileMode.Create)) + { + resourceStream.CopyTo(fileStream); + } + } + } + + /// + /// Cleans up SQLCMD from the file system. + /// + private static void CleanUpSqlCmd() + { DeleteFile(SqlCmdFileName); DeleteFile(SqlCmdResourceFile); } - /// - /// Deletes the file resource. - /// - /// The resource key. - private static void DeleteFile(string resourceKey) - { - var filePath = GetResourceFilePath(resourceKey); - if (File.Exists(filePath)) - { - File.Delete(filePath); - } - } - - /// - /// Gets the resource file path on the local file system. - /// - /// The resource key. - /// Full file path on local file system. - private static string GetResourceFilePath(string resourceKey) - { - return Path.Combine(ExtractPath, resourceKey); - } - - /// - /// Builds the SQL command arguments. - /// - /// The connection string. - /// The script file to execute. - /// - /// SQLCMD command arguments. - /// - private static string BuildCommandArguments(string connectionString, FileInfo scriptFile) - { - var info = ConnectionStringParser.Parse(connectionString); - var result = new StringBuilder(); - - AppendItem(result, "-S \"{0}\"", info.Server); - AppendItem(result, "-d \"{0}\"", info.Database); - AppendItem(result, "-U \"{0}\"", info.UserId); - AppendItem(result, "-P \"{0}\"", info.Password); - AppendItem(result, "-E", info.TrustedConnection ? "true" : null); - AppendItem(result, "-i \"{0}\"", scriptFile.FullName); - AppendItem(result, "-V {0}", ErrorSeverity.ToString(CultureInfo.InvariantCulture)); - - return result.ToString(); - } - - /// - /// Appends the item if it exists. - /// - /// The result. - /// The format. - /// The value. - private static void AppendItem(StringBuilder output, string format, string value) - { - if (!string.IsNullOrWhiteSpace(value)) - { - // Add a space if there is something before. - if (output.Length > 0) - { - output.Append(' '); - } - - output.AppendFormat(format, value); - } + /// + /// Deletes the file resource. + /// + /// The resource key. + private static void DeleteFile(string resourceKey) + { + var filePath = GetResourceFilePath(resourceKey); + if (File.Exists(filePath)) + { + File.Delete(filePath); + } + } + + /// + /// Gets the resource file path on the local file system. + /// + /// The resource key. + /// Full file path on local file system. + private static string GetResourceFilePath(string resourceKey) + { + return Path.Combine(ExtractPath, resourceKey); + } + + /// + /// Builds the SQL command arguments. + /// + /// The connection string. + /// The script file to execute. + /// + /// SQLCMD command arguments. + /// + private static string BuildCommandArguments(string connectionString, FileInfo scriptFile) + { + var info = ConnectionStringParser.Parse(connectionString); + var result = new StringBuilder(); + + AppendItem(result, "-S \"{0}\"", info.Server); + AppendItem(result, "-d \"{0}\"", info.Database); + AppendItem(result, "-U \"{0}\"", info.UserId); + AppendItem(result, "-P \"{0}\"", info.Password); + AppendItem(result, "-E", info.TrustedConnection ? "true" : null); + AppendItem(result, "-i \"{0}\"", scriptFile.FullName); + AppendItem(result, "-V {0}", ErrorSeverity.ToString(CultureInfo.InvariantCulture)); + + return result.ToString(); + } + + /// + /// Appends the item if it exists. + /// + /// The result. + /// The format. + /// The value. + private static void AppendItem(StringBuilder output, string format, string value) + { + if (!string.IsNullOrWhiteSpace(value)) + { + // Add a space if there is something before. + if (output.Length > 0) + { + output.Append(' '); + } + + output.AppendFormat(format, value); + } } - } -} + } +} diff --git a/src/Net.Sf.Dbdeploy/DbDeployer.cs b/src/Net.Sf.Dbdeploy/DbDeployer.cs index 3988ac0..ec83d4f 100644 --- a/src/Net.Sf.Dbdeploy/DbDeployer.cs +++ b/src/Net.Sf.Dbdeploy/DbDeployer.cs @@ -59,6 +59,8 @@ public void Execute(DbDeployConfig config, TextWriter infoWriter) if (config.OutputFile != null) { + if(config.OutputFile.Exists) config.OutputFile.Delete(); + doWriter = new StreamWriter(config.OutputFile.OpenWrite(), config.Encoding); doScriptApplier = new TemplateBasedApplier( diff --git a/src/Net.Sf.Dbdeploy/Net.Sf.Dbdeploy.csproj b/src/Net.Sf.Dbdeploy/Net.Sf.Dbdeploy.csproj index cbdca51..9871d42 100755 --- a/src/Net.Sf.Dbdeploy/Net.Sf.Dbdeploy.csproj +++ b/src/Net.Sf.Dbdeploy/Net.Sf.Dbdeploy.csproj @@ -71,6 +71,12 @@ + + ..\packages\Npgsql.2.2.1\lib\net40\Mono.Security.dll + + + ..\packages\Npgsql.2.2.1\lib\net40\Npgsql.dll + ..\packages\NVelocity.1.0.3\lib\NVelocity.dll @@ -96,6 +102,7 @@ + @@ -189,6 +196,12 @@ PreserveNewest + + PreserveNewest + + + PreserveNewest + @@ -211,6 +224,11 @@ PreserveNewest + + + PreserveNewest + + + + ..\packages\Npgsql.2.2.1\lib\net40\Mono.Security.dll + False ..\packages\Moq.4.1.1308.2321\lib\net40\Moq.dll @@ -86,6 +89,9 @@ False ..\..\lib\NAnt.Core.dll + + ..\packages\Npgsql.2.2.1\lib\net40\Npgsql.dll + False ..\..\lib\nunit.core.dll @@ -124,6 +130,8 @@ + + @@ -135,7 +143,6 @@ - @@ -218,6 +225,9 @@ Always + + Always + diff --git a/src/Test.Net.Sf.Dbdeploy/packages.config b/src/Test.Net.Sf.Dbdeploy/packages.config index 6e63897..f28c5eb 100644 --- a/src/Test.Net.Sf.Dbdeploy/packages.config +++ b/src/Test.Net.Sf.Dbdeploy/packages.config @@ -1,4 +1,5 @@  + \ No newline at end of file diff --git a/src/dbproviders.xml b/src/dbproviders.xml index ac3400a..651b86c 100755 --- a/src/dbproviders.xml +++ b/src/dbproviders.xml @@ -13,8 +13,13 @@ /> +