Commit a3ddbae
Changed files (54)
slips
build
tools
nant
bin
extensions
common
lib
slips/build/tools/nant/bin/extensions/common/2.0/NAnt.MSBuild.dll
Binary file
slips/build/tools/nant/bin/extensions/common/2.0/NAnt.MSBuild.xml
@@ -1,37 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.MSBuild</name>
- </assembly>
- <members>
- <member name="T:NAnt.MSBuild.Functions.MSBuildFunctions">
- <summary>
- Functions to return information for MSBuild system.
- </summary>
- </member>
- <member name="M:NAnt.MSBuild.Functions.MSBuildFunctions.#ctor(NAnt.Core.Project,NAnt.Core.PropertyDictionary)">
- <exclude/>
- </member>
- <member name="M:NAnt.MSBuild.Functions.MSBuildFunctions.IsMsbuildProject(System.String)">
- <summary>
- Test whether project is VS2005 project and could be built using <msbuild>
- </summary>
- <param name="project">The name or path of the project file (csproj, vbproj, ...).</param>
- <returns>
- True, if it is msbuild project, False otherwise.
- </returns>
- </member>
- <member name="M:NAnt.MSBuild.NAntLogger.Initialize(Microsoft.Build.Framework.IEventSource)">
- <summary>
- Initialize is guaranteed to be called by MSBuild at the start of the build
- before any events are raised.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.WhidbeySolution">
- <summary>
- Analyses Microsoft Visual Studio .NET 2005 (Whidbey) solution files.
- !! FOR NOW IT IS PLAIN COPY OF EVERETT (2003) !!
- </summary>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/lib/net/2.0/NDoc.Core.dll
Binary file
slips/build/tools/nant/bin/lib/net/2.0/NDoc.Documenter.Msdn.dll
Binary file
slips/build/tools/nant/bin/lib/net/2.0/NDoc.ExtendedUI.dll
Binary file
slips/build/tools/nant/bin/lib/net/2.0/nunit.core.dll
Binary file
slips/build/tools/nant/bin/lib/net/2.0/nunit.framework.dll
Binary file
slips/build/tools/nant/bin/lib/net/2.0/nunit.util.dll
Binary file
slips/build/tools/nant/bin/lib/ICSharpCode.SharpCvsLib.Console.dll
Binary file
slips/build/tools/nant/bin/lib/ICSharpCode.SharpCvsLib.dll
Binary file
slips/build/tools/nant/bin/lib/ICSharpCode.SharpZipLib.dll
Binary file
slips/build/tools/nant/bin/lib/NUnitCore.dll
Binary file
slips/build/tools/nant/bin/CollectionGen.dll
Binary file
slips/build/tools/nant/bin/Interop.MsmMergeTypeLib.dll
Binary file
slips/build/tools/nant/bin/Interop.StarTeam.dll
Binary file
slips/build/tools/nant/bin/Interop.WindowsInstaller.dll
Binary file
slips/build/tools/nant/bin/log4net.dll
Binary file
slips/build/tools/nant/bin/MSITaskErrors.mst
Binary file
slips/build/tools/nant/bin/MSITaskTemplate.msi
Binary file
slips/build/tools/nant/bin/MSMTaskErrors.mst
Binary file
slips/build/tools/nant/bin/MSMTaskTemplate.msm
Binary file
slips/build/tools/nant/bin/NAnt.CompressionTasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.CompressionTasks.xml
@@ -1,615 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.CompressionTasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.Compression.Tasks.GUnzip">
- <summary>
- Expands a file packed using GZip compression.
- </summary>
- <example>
- <para>Expands "test.tar.gz" to "test2.tar".</para>
- <code>
- <![CDATA[
- <gunzip src="test.tar.gz" dest="test.tar" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Compression.Tasks.GUnzip.ExecuteTask">
- <summary>
- Extracts the file from the gzip archive.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.GUnzip.SrcFile">
- <summary>
- The file to expand.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.GUnzip.DestFile">
- <summary>
- The destination file.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Tasks.TarTask">
- <summary>
- Creates a tar file from the specified filesets.
- </summary>
- <remarks>
- <para>Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see> (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.</para>
- </remarks>
- <example>
- <para>
- Tar all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
- called "backup.tar.gz", and apply gzip compression to it.
- </para>
- <code>
- <![CDATA[
- <tar destfile="backup.tar.gz" compression="GZip">
- <fileset basedir="${bin.dir}" prefix="bin">
- <include name="**/*" />
- </fileset>
- <fileset basedir="${doc.dir}" prefix="doc">
- <include name="**/*" />
- </fileset>
- </tar>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Compression.Tasks.TarTask.ExecuteTask">
- <summary>
- Creates the tar file.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.TarTask.DestFile">
- <summary>
- The tar file to create.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.TarTask.IncludeEmptyDirs">
- <summary>
- Include empty directories in the generated tar file. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.TarTask.TarFileSets">
- <summary>
- The set of files to be included in the archive.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.TarTask.CompressionMethod">
- <summary>
- The compression method. The default is <see cref="F:NAnt.Compression.Tasks.TarCompressionMethod.None"/>.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Tasks.TarCompressionMethod">
- <summary>
- Specifies the compression methods supported by <see cref="T:NAnt.Compression.Tasks.TarTask"/>.
- </summary>
- </member>
- <member name="F:NAnt.Compression.Tasks.TarCompressionMethod.None">
- <summary>
- No compression.
- </summary>
- </member>
- <member name="F:NAnt.Compression.Tasks.TarCompressionMethod.GZip">
- <summary>
- GZIP compression.
- </summary>
- </member>
- <member name="F:NAnt.Compression.Tasks.TarCompressionMethod.BZip2">
- <summary>
- BZIP2 compression.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Tasks.UnZipTask">
- <summary>
- Extracts files from a zip file.
- </summary>
- <remarks>
- <para>
- Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see>
- (SharpZipLib), an open source Zip/GZip library written entirely in C#.
- </para>
- </remarks>
- <example>
- <para>Extracts all the file from the zip, preserving the directory structure.</para>
- <code>
- <![CDATA[
- <unzip zipfile="backup.zip"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Compression.Tasks.UnZipTask.ExecuteTask">
- <summary>
- Extracts the files from the zip file.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Tasks.UnZipTask.ExtractFile(System.IO.Stream,System.String,System.DateTime,System.Int64)">
- <summary>
- Extracts a file entry from the specified stream.
- </summary>
- <param name="inputStream">The <see cref="T:System.IO.Stream"/> containing the compressed entry.</param>
- <param name="entryName">The name of the entry including directory information.</param>
- <param name="entryDate">The date of the entry.</param>
- <param name="entrySize">The uncompressed size of the entry.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The destination directory for the entry could not be created.</para>
- <para>-or-</para>
- <para>The entry could not be extracted.</para>
- </exception>
- <remarks>
- We cannot rely on the fact that the directory entry of a given file
- is created before the file is extracted, so we should create the
- directory if it doesn't yet exist.
- </remarks>
- </member>
- <member name="M:NAnt.Compression.Tasks.UnZipTask.ExtractDirectory(System.IO.Stream,System.String,System.DateTime)">
- <summary>
- Extracts a directory entry from the specified stream.
- </summary>
- <param name="inputStream">The <see cref="T:System.IO.Stream"/> containing the directory entry.</param>
- <param name="entryName">The name of the directory entry.</param>
- <param name="entryDate">The date of the entry.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The destination directory for the entry could not be created.</para>
- </exception>
- </member>
- <member name="P:NAnt.Compression.Tasks.UnZipTask.ZipFile">
- <summary>
- The archive file to expand.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.UnZipTask.ToDirectory">
- <summary>
- The directory where the expanded files should be stored. The
- default is the project base directory.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.UnZipTask.Overwrite">
- <summary>
- Overwrite files, even if they are newer than the corresponding
- entries in the archive. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.UnZipTask.Encoding">
- <summary>
- The character encoding that has been used for filenames inside the
- zip file. The default is the system's OEM code page.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Tasks.ZipTask">
- <summary>
- Creates a zip file from the specified filesets.
- </summary>
- <remarks>
- <para>
- Uses <see href="http://www.icsharpcode.net/OpenSource/SharpZipLib/">#ziplib</see>
- (SharpZipLib), an open source Tar/Zip/GZip library written entirely in C#.
- </para>
- </remarks>
- <example>
- <para>
- Zip all files in <c>${build.dir}</c> and <c>${doc.dir}</c> into a file
- called "backup.zip".
- </para>
- <code>
- <![CDATA[
- <zip zipfile="backup.zip">
- <fileset basedir="${bin.dir}" prefix="bin">
- <include name="**/*" />
- </fileset>
- <fileset basedir="${doc.dir}" prefix="doc">
- <include name="**/*" />
- </fileset>
- </zip>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Compression.Tasks.ZipTask.ExecuteTask">
- <summary>
- Creates the zip file.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.ZipTask.ZipFile">
- <summary>
- The zip file to create.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.ZipTask.Comment">
- <summary>
- The comment for the file.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.ZipTask.Stamp">
- <summary>
- Date/time stamp for the files in the format MM/DD/YYYY HH:MM:SS.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.ZipTask.ZipLevel">
- <summary>
- Desired level of compression. Possible values are 0 (STORE only)
- to 9 (highest). The default is <c>6</c>.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.ZipTask.IncludeEmptyDirs">
- <summary>
- Include empty directories in the generated zip file. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.ZipTask.ZipFileSets">
- <summary>
- The set of files to be included in the archive.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.ZipTask.DuplicateHandling">
- <summary>
- Specifies the behaviour when a duplicate file is found. The default
- is <see cref="F:NAnt.Compression.Types.DuplicateHandling.Add"/>.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Tasks.ZipTask.Encoding">
- <summary>
- The character encoding to use for filenames and comment inside the
- zip file. The default is the system's OEM code page.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Types.DuplicateHandling">
- <summary>
- Specifies how entries with the same name should be processed.
- </summary>
- </member>
- <member name="F:NAnt.Compression.Types.DuplicateHandling.Add">
- <summary>
- Overwrite existing entry with same name.
- </summary>
- </member>
- <member name="F:NAnt.Compression.Types.DuplicateHandling.Preserve">
- <summary>
- Preserve existing entry with the same name.
- </summary>
- </member>
- <member name="F:NAnt.Compression.Types.DuplicateHandling.Fail">
- <summary>
- Report failure when two entries have the same name.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Types.TarFileSet">
- <summary>
- A <see cref="T:NAnt.Compression.Types.TarFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
- attributes useful in the context of the <see cref="T:NAnt.Compression.Tasks.TarTask"/>.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSet.FileMode">
- <summary>
- 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 <c>644</c>.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSet.DirMode">
- <summary>
- A 3 digit octal string, specify the user, group and other modes
- in the standard Unix fashion. Only applies to directories. The
- default is <c>755</c>.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSet.UserName">
- <summary>
- The username for the tar entry.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSet.Uid">
- <summary>
- The user identifier (UID) for the tar entry.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSet.GroupName">
- <summary>
- The groupname for the tar entry.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSet.Gid">
- <summary>
- The group identifier (GID) for the tar entry.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSet.Prefix">
- <summary>
- 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.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Types.TarFileSetCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor(NAnt.Compression.Types.TarFileSetCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class
- with the specified <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.#ctor(NAnt.Compression.Types.TarFileSet[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> class
- with the specified array of <see cref="T:NAnt.Compression.Types.TarFileSet"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.Add(NAnt.Compression.Types.TarFileSet)">
- <summary>
- Adds a <see cref="T:NAnt.Compression.Types.TarFileSet"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.AddRange(NAnt.Compression.Types.TarFileSet[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Compression.Types.TarFileSet"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.AddRange(NAnt.Compression.Types.TarFileSetCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.Contains(NAnt.Compression.Types.TarFileSet)">
- <summary>
- Determines whether a <see cref="T:NAnt.Compression.Types.TarFileSet"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.CopyTo(NAnt.Compression.Types.TarFileSet[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.IndexOf(NAnt.Compression.Types.TarFileSet)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Compression.Types.TarFileSet"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Compression.Types.TarFileSet"/>. If the <see cref="T:NAnt.Compression.Types.TarFileSet"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.Insert(System.Int32,NAnt.Compression.Types.TarFileSet)">
- <summary>
- Inserts a <see cref="T:NAnt.Compression.Types.TarFileSet"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to insert.</param>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Compression.Types.TarFileSetEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetCollection.Remove(NAnt.Compression.Types.TarFileSet)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Compression.Types.TarFileSet"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSetCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSetCollection.FileCount">
- <summary>
- Get the total number of files that are represented by the
- filesets in this collection.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Types.TarFileSetEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Compression.Types.TarFileSet"/> elements of a <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.#ctor(NAnt.Compression.Types.TarFileSetCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Compression.Types.TarFileSetEnumerator"/> class
- with the specified <see cref="T:NAnt.Compression.Types.TarFileSetCollection"/>.
- </summary>
- <param name="TarFileSets">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Compression.Types.TarFileSetEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.TarFileSetEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Compression.Types.ZipFileSet">
- <summary>
- A <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
- attributes useful in the context of the <see cref="T:NAnt.Compression.Tasks.ZipTask"/>.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.ZipFileSet.Prefix">
- <summary>
- 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.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Types.ZipFileSetCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor(NAnt.Compression.Types.ZipFileSetCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class
- with the specified <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.#ctor(NAnt.Compression.Types.ZipFileSet[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> class
- with the specified array of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Add(NAnt.Compression.Types.ZipFileSet)">
- <summary>
- Adds a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.AddRange(NAnt.Compression.Types.ZipFileSet[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.AddRange(NAnt.Compression.Types.ZipFileSetCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Contains(NAnt.Compression.Types.ZipFileSet)">
- <summary>
- Determines whether a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.CopyTo(NAnt.Compression.Types.ZipFileSet[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.IndexOf(NAnt.Compression.Types.ZipFileSet)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Compression.Types.ZipFileSet"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Compression.Types.ZipFileSet"/>. If the <see cref="T:NAnt.Compression.Types.ZipFileSet"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Insert(System.Int32,NAnt.Compression.Types.ZipFileSet)">
- <summary>
- Inserts a <see cref="T:NAnt.Compression.Types.ZipFileSet"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to insert.</param>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Compression.Types.ZipFileSetEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetCollection.Remove(NAnt.Compression.Types.ZipFileSet)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Compression.Types.ZipFileSet"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Compression.Types.ZipFileSetCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Compression.Types.ZipFileSetCollection.FileCount">
- <summary>
- Get the total number of files that are represented by the
- filesets in this collection.
- </summary>
- </member>
- <member name="T:NAnt.Compression.Types.ZipFileSetEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Compression.Types.ZipFileSet"/> elements of a <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.#ctor(NAnt.Compression.Types.ZipFileSetCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Compression.Types.ZipFileSetEnumerator"/> class
- with the specified <see cref="T:NAnt.Compression.Types.ZipFileSetCollection"/>.
- </summary>
- <param name="ZipFileSets">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Compression.Types.ZipFileSetEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Compression.Types.ZipFileSetEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.Contrib.Tasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.Contrib.Tasks.xml
@@ -1,18933 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.Contrib.Tasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.Contrib.Functions.FileSetFunctions">
- <summary>
- Provides methods for interrogating Filesets.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Functions.FileSetFunctions.GetFileCount(System.String)">
- <summary>
- Determines the number of files within a <see cref="T:NAnt.Core.Types.FileSet"/>.
- </summary>
- <param name="fileset">The id of the FileSet to scan.</param>
- <returns>The number of files included in the FileSet</returns>
- <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
- <example>
- <para>
- Define a fileset and check the number of files in it.
- </para>
- <code>
- <![CDATA[
- <fileset id="test.fileset">
- <include name="**/*.cs">
- </fileset>
- <echo message="FileSet contains ${fileset::get-file-count('test.fileset')} files." />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Functions.FileSetFunctions.HasFiles(System.String)">
- <summary>
- Determines whether <see cref="T:NAnt.Core.Types.FileSet"/> contains any files.
- </summary>
- <param name="fileset">The id of the fileset to check.</param>
- <returns><see langword="true"/> if the FileSet contains one or more files, otherwise <see langword="false"/>.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
- <example>
- <para>
- Perform conditional processing on a fileset if it contains files.
- </para>
- <code>
- <![CDATA[
- <fileset id="test.fileset">
- <include name="**/*.cs">
- </fileset>
- <if test="${fileset::has-files('test.fileset')}">
- <dostuff... />
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Functions.FileSetFunctions.ToString(System.String,System.String)">
- <summary>
- Returns a delimited string of all the filenames within a <see cref="T:NAnt.Core.Types.FileSet"/> with each filename
- separated by the specified delimiter string.
- </summary>
- <param name="fileset">The id of the fileset to check.</param>
- <param name="delimiter">String to separate filenames with.</param>
- <returns>A delimited string of the filenames within the specified FileSet.</returns>
- <exception cref="T:System.ArgumentException"><paramref name="fileset"/> is not a valid refid to a defined fileset.</exception>
- <example>
- <para>
- Displays a space-pipe-space separated string fo the files within a defined FileSet.
- </para>
- <code>
- <![CDATA[
- <fileset id="test.fileset">
- <include name="**/*.cs">
- </fileset>
- <echo message="${fileset::to-string('test.fileset', ' | ')}">
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Functions.ServiceFunctions">
- <summary>
- Allow information on a Windows service to be retrieved.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsInstalled(System.String,System.String)">
- <summary>
- Returns a value indicating whether the specified service is
- installed on a given machine.
- </summary>
- <param name="service">The short name that identifies the service to the system.</param>
- <param name="machineName">The computer on which the service resides.</param>
- <returns>
- <see langword="true"/> if the service is installed; otherwise,
- <see langword="false"/>.
- </returns>
- <remarks>
- For the machineName parameter, you can use "." or a zero-length
- <see cref="T:System.String"/> to represent the local computer.
- </remarks>
- <example>
- <para>
- The following example starts the "World Wide Web Publishing"
- service if it's installed on the local computer.
- </para>
- <code>
- <![CDATA[
- <if test="${service::is-installed('World Wide Web Publishing', '.')}">
- <servicecontroller action="Start" service="World Wide Web Publishing" />
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsRunning(System.String,System.String)">
- <summary>
- Returns a value indicating whether the specified service is running.
- </summary>
- <param name="service">The short name that identifies the service to the system.</param>
- <param name="machineName">The computer on which the service resides.</param>
- <returns>
- <see langword="true"/> if the service is running; otherwise,
- <see langword="false"/>.
- </returns>
- <remarks>
- For the machineName parameter, you can use "." or a zero-length
- <see cref="T:System.String"/> to represent the local computer.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsStopped(System.String,System.String)">
- <summary>
- Returns a value indicating whether the specified service is stopped.
- </summary>
- <param name="service">The short name that identifies the service to the system.</param>
- <param name="machineName">The computer on which the service resides.</param>
- <returns>
- <see langword="true"/> if the service is stopped; otherwise,
- <see langword="false"/>.
- </returns>
- <remarks>
- For the machineName parameter, you can use "." or a zero-length
- <see cref="T:System.String"/> to represent the local computer.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Functions.ServiceFunctions.IsPaused(System.String,System.String)">
- <summary>
- Returns a value indicating whether the specified service is paused.
- </summary>
- <param name="service">The short name that identifies the service to the system.</param>
- <param name="machineName">The computer on which the service resides.</param>
- <returns>
- <see langword="true"/> if the service is paused; otherwise,
- <see langword="false"/>.
- </returns>
- <remarks>
- For the machineName parameter, you can use "." or a zero-length
- <see cref="T:System.String"/> to represent the local computer.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetStatus(System.String,System.String)">
- <summary>
- Gets the status of the specified service.
- </summary>
- <param name="service">The short name that identifies the service to the system.</param>
- <param name="machineName">The computer on which the service resides.</param>
- <returns>
- One of the <see cref="T:System.ServiceProcess.ServiceControllerStatus"/> values that
- indicates whether the service is running, stopped, or paused, or
- whether a start, stop, pause, or continue command is pending.
- </returns>
- <remarks>
- <para>
- For the machineName parameter, you can use "." or a zero-length
- <see cref="T:System.String"/> to represent the local computer.
- </para>
- <para>
- The value returned by <see cref="M:NAnt.Contrib.Functions.ServiceFunctions.GetStatus(System.String,System.String)"/> can be compared
- to either a corresponding enum field name or the underlying
- integral value.
- </para>
- </remarks>
- <example>
- <para>
- Displays a warning if the <b>Alerter</b> service is stopping
- on <c>SV-ARD-EAI1</c>.
- </para>
- <code>
- <![CDATA[
- <if test="${service::get-status('Alerter', 'SV-ARD-EAI1') == 'StopPending'}">
- <echo level="Warning">The Alerter service is stopping.</echo>
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>
- The "deploy-web-application" target is only executed if
- IIS is running on the local computer.
- </para>
- <code>
- <![CDATA[
- <target name="deploy" depends="deploy-sql-scripts, deploy-web-application" />
-
- <target name="deploy-sql-scripts">
- ...
- </target>
-
- <target name="deploy-web-application" if="$(service::get-status('World Wide Web Publishing', '.') == 4)}">
- ...
- </target>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetDisplayName(System.String,System.String)">
- <summary>
- Gets the friendly name of the specified service.
- </summary>
- <param name="service">The short name that identifies the service to the system.</param>
- <param name="machineName">The computer on which the service resides.</param>
- <returns>
- The friendly name of the service, which can be used to identify the service.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Functions.ServiceFunctions.GetServiceName(System.String,System.String)">
- <summary>
- Gets the name that identifies the specified service
- </summary>
- <param name="service">The short name that identifies the service to the system.</param>
- <param name="machineName">The computer on which the service resides.</param>
- <returns>
- The name that identifies the service.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.BizTalkBase.Database">
- <summary>
- The name of the management SQL database.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.BizTalkBase.Server">
- <summary>
- The name of the SQL Server where the management database is
- located.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Deploy">
- <summary>
- Deploys an assembly to a given BizTalk configuration database.
- </summary>
- <remarks>
- Deployment will fail if the assembly is already deployed.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.BizTalk.Deploy.ExecuteTask">
- <summary>
- Deploys the assembly.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The assembly does not exist.</para>
- <para>-or-</para>
- <para>The assembly binding information file does not exist.</para>
- <para>-or-</para>
- <para>The assembly could not be deployed.</para>
- </exception>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.Assembly">
- <summary>
- The path to the BizTalk assembly to deploy.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.Install">
- <summary>
- Determines whether to install the assembly in the Global Assembly
- Cache. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.BindingFile">
- <summary>
- The path to an assembly binding information file to import bindings
- from.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Deploy.LogFile">
- <summary>
- The path to the HTML log file to generate.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Export">
- <summary>
- Exports bindings for a BizTalk assembly to an assembly binding
- information file.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.BizTalk.Export.ExecuteTask">
- <summary>
- Exports the bindings.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The assembly does not exist.</para>
- <para>-or-</para>
- <para>The bindings could not be exported.</para>
- </exception>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.Assembly">
- <summary>
- The path to the BizTalk assembly for which to export bindings.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.BindingFile">
- <summary>
- The path to an assembly binding information file in which the
- bindings will be saved.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Export.LogFile">
- <summary>
- The path to the HTML log file to generate.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Host">
- <summary>
- Allows BizTalk (in-process) host instances to be controlled.
- </summary>
- <example>
- <para>
- Starts the "BizTalkServerApplication" host instance
- on server "SV-ARD-EAI".
- </para>
- <code>
- <![CDATA[
- <btshost action="Start" host="BizTalkServerApplication" server="SV-ARD-EAI" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Stops all "BizTalkServerApplication" host instances.
- </para>
- <code>
- <![CDATA[
- <btshost action="Stop" host="BizTalkServerApplication" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.HostName">
- <summary>
- The name of the host on which the perform the action.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.Server">
- <summary>
- The name of the BizTalk server on which to perform the action.
- If not specified, the action will be performed on all instances.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Host.Action">
- <summary>
- The action that should be performed on the host.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Host.HostAction">
- <summary>
- Defines the actions that can be performed on a host instance.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Start">
- <summary>
- Starts the host instance.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Stop">
- <summary>
- Stops the host instance.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.Host.HostAction.Restart">
- <summary>
- Stops and restarts the host instance.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Import">
- <summary>
- Imports bindings from a given assembly binding information file into
- the specified BizTalk configuration database.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.BizTalk.Import.ExecuteTask">
- <summary>
- Imports the assembly binding information file.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The assembly binding information file does not exist.</para>
- <para>-or-</para>
- <para>The assembly binding information file could not be imported.</para>
- </exception>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Import.BindingFile">
- <summary>
- The path to the assembly binding information file containing the
- bindings to import.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Import.LogFile">
- <summary>
- The path to the HTML log file to generate.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration">
- <summary>
- Performs a set of actions on a given orchestration.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.Server">
- <summary>
- The name of the BizTalk server on which to perform the action.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationName">
- <summary>
- The name of the orchestration to perform an action on.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationActionBase.Log(NAnt.Core.Level,System.String)">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to be logged.</param>
- <remarks>
- The actual logging is delegated to the project.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.OrchestrationActionBase.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- The actual logging is delegated to the project.
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction">
- <summary>
- Starts the orchestration.
- </summary>
- <remarks>
- If the orchestration is not yet enlisted, then this will be done
- first.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoEnableReceiveLocation">
- <summary>
- Specifies whether receive locations associated with this
- orchestration should be automatically enabled. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoResumeOrchestrationInstance">
- <summary>
- Specifies whether service instances of this orchestration that
- were manually suspended previously should be automatically
- resumed. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StartOrchestrationAction.AutoStartSendPorts">
- <summary>
- Specifies whether send ports and send port groups imported by
- this orchestration should be automatically started. The default
- is <see langword="true" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction">
- <summary>
- Stops the orchestration.
- </summary>
- <remarks>
- If the status of the orchestration is <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Bound"/>,
- <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Unbound"/> or <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Stopped"/>,
- then no further processing is done.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.Invoke(System.Management.ManagementObject)">
- <summary>
- Stops the orchestration.
- </summary>
- <param name="orchestration">The orchestration to stop.</param>
- <remarks>
- If the status of orchestration is <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Bound"/>,
- <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Unbound"/> or <see cref="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Stopped"/>,
- then no further processing is done.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.AutoDisableReceiveLocation">
- <summary>
- Specifies whether receive locations associated with this
- orchestration should be automatically disabled. The default
- is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.StopOrchestrationAction.AutoSuspendOrchestrationInstance">
- <summary>
- Specifies whether instances of this orchestration should be
- automatically suspended. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.EnlistOrchestrationAction">
- <summary>
- Enlists the orchestration by creating its activation subscription.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.EnlistOrchestrationAction.Host">
- <summary>
- Specifies the BizTalk host on which to enlist the orchestration.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Orchestration.UnenlistOrchestrationAction">
- <summary>
- Unenlists the orchestration by removing its activation subscription.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Orchestration.UnenlistOrchestrationAction.AutoTerminateOrchestrationInstance">
- <summary>
- Specifies whether instances of this orchestration type should
- be automatically terminated. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Reset">
- <summary>
- Allows stopping, starting and resetting of BizTalk in-process host
- instances on the specified server.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Reset.Server">
- <summary>
- The name of the BizTalk server on which to perform the action.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Reset.Action">
- <summary>
- Specifies the action(s) to perform on the BizTalk host instances. The
- default is <see cref="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Reset"/>.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction">
- <summary>
- Defines the possible actions that can be performed on the BizTalk
- in-process host instances.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Stop">
- <summary>
- Stops all in-process host instances.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Start">
- <summary>
- Starts all in-process host instances.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.Reset.ResetAction.Reset">
- <summary>
- Stops and restarts all in-process host instances.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.SendPort">
- <summary>
- Allows BizTalk send ports to be controlled.
- </summary>
- <example>
- <para>
- Starts the "UmeHttpSendPort" port on server
- "SV-ARD-EAI".
- </para>
- <code>
- <![CDATA[
- <btssendport action="Start" port="UmeHttpSendPort" server="SV-ARD-EAI" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Unenlists the "UmeHttpSendPort" on server "SV-ARD-EAI".
- </para>
- <code>
- <![CDATA[
- <btssendport action="UnEnlist" port="UmeHttpSendPort" server="SV-ARD-EAI" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.PortName">
- <summary>
- The name of the send port on which the perform the action.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.Server">
- <summary>
- The name of the BizTalk server on which to perform the action.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.SendPort.Action">
- <summary>
- The action that should be performed on the send port.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction">
- <summary>
- Defines the actions that can be performed on a BizTalk send port.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Start">
- <summary>
- Starts the send port.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Stop">
- <summary>
- Stops the send port.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Restart">
- <summary>
- Stops and restarts the send port.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.Enlist">
- <summary>
- Enlists the send port.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.BizTalk.SendPort.SendPortAction.UnEnlist">
- <summary>
- Unenlists the send port.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Unbind">
- <summary>
- Removes all bindings for a given assembly from a BizTalk configuration
- database.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.BizTalk.Unbind.ExecuteTask">
- <summary>
- Removes bindings for the specified assembly.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The assembly does not exist.</para>
- <para>-or-</para>
- <para>The bindings could not be removed.</para>
- </exception>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.Assembly">
- <summary>
- The path to the BizTalk assembly for which to remove all bindings.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.Server">
- <summary>
- The name of the BizTalk server on which to perform the operation.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.ReceivePipeline">
- <summary>
- The assembly qualified name of the receive pipeline to set when
- unbinding a receive pipeline.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Unbind.SendPipeline">
- <summary>
- The assembly qualified name of the SEND pipeline to set when
- unbinding a send pipeline.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.BizTalk.Undeploy">
- <summary>
- Removes a given assembly from a BizTalk configuration database.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.BizTalk.Undeploy.ExecuteTask">
- <summary>
- Removes an assembly from a BizTalk configuration database.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The assembly does not exist.</para>
- <para>-or-</para>
- <para>The assembly could not be remove from the BizTalk configuration database.</para>
- </exception>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.Assembly">
- <summary>
- The path to the BizTalk assembly to remove.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.Uninstall">
- <summary>
- Determines whether to remove the assembly from the Global Assembly
- Cache. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.BizTalk.Undeploy.LogFile">
- <summary>
- The path to the HTML log file to generate.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase">
- <summary>
- Base class for all the ClearCase tasks.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.#ctor">
- <summary>
- Base Constructor.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.ExecuteTask">
- <summary>
- Execute the perforce command assembled by subclasses.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.CommandSpecificArguments">
- <summary>
- Derived classes should override this to provide command-specific
- commandline arguments.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseBase.ProgramArguments">
- <summary>
- Overrides the base class.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs">
- <summary>
- Displays a ClearCase config spec.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs.ViewTag">
- <summary>
- The view tag identifying the ClearCase view that will have its
- config spec displayed.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCatCs.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn">
- <summary>
- Checks files into a ClearCase VOB.
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut"/>
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut"/>
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool checkin</c> command to check in ClearCase elements.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase checkin on the file <c>c:/views/viewdir/afile</c>.
- All warning messages are suppressed, and the element is checked in even if identical to the original.
- Comment text from the file <c>acomment.txt</c> is added to ClearCase as a comment. All warning messages are suppressed. The file is checked in even if it is identical to the original.
- </para>
- <code>
- <![CDATA[
- <cccheckin viewpath="c:/views/viewdir/afile"
- commentfile="acomment.txt"
- nowarn="true"
- identical="true"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.ViewPath">
- <summary>
- Path to the ClearCase view file or directory that the command will
- operate on.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment">
- <summary>
- Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment"/> or
- <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile">
- <summary>
- Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Comment"/>
- or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.NoWarn">
- <summary>
- <see langword="true" /> if warning messages should be suppressed.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.PreserveTime">
- <summary>
- If <see langword="true" />, the modification time will be preserved.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.KeepCopy">
- <summary>
- <see langword="true" /> to keep a view-private copy of the file with
- a .keep extension. Default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.Identical">
- <summary>
- If <see langword="true" />, files may be checked in even if identical
- to the original. Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut">
- <summary>
- Checks files out of a ClearCase VOB.
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn"/>
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut"/>
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool checkout</c> command to check out ClearCase elements.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase checkout on the file <c>c:/views/viewdir/afile</c>.
- It is checked out as reserved on branch called <c>abranch</c>.
- All warning messages are suppressed.
- <c>Some comment text</c> is added to ClearCase as a comment.
- </para>
- <code>
- <![CDATA[
- <cccheckout viewpath="c:/views/viewdir/afile"
- reserved="true"
- branch="abranch"
- nowarn="true"
- comment="Some comment text"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.ViewPath">
- <summary>
- Path to the ClearCase view file or directory that the command will
- operate on.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Reserved">
- <summary>
- <see langword="true" /> to check the element out as reserved.
- Default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.OutFile">
- <summary>
- Creates a writable file under a different filename.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.NoData">
- <summary>
- If <see langword="true" />, checks out the file but does not create
- an editable file containing its data. Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Branch">
- <summary>
- Specify a branch to check out the file to.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Version">
- <summary>
- If <see langword="true" />, checkouts of elements with a version
- other than main latest will be allowed. Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.NoWarn">
- <summary>
- <see langword="true" /> if warning messages should be suppressed.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment">
- <summary>
- Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment"/> or
- <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile">
- <summary>
- Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.Comment"/>
- or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.PreserveTime">
- <summary>
- If <see langword="true" />, the modification time will be preserved.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock">
- <summary>
- Locks ClearCase elements.
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock"/>
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool lock</c> command to lock ClearCase elements.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase lock on the object <c>stream:Application_Integration@\MyProject_PVOB</c>.
- </para>
- <code>
- <![CDATA[
- <cclock objsel="stream:Application_Integration@\MyProject_PVOB" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Replace">
- <summary>
- If <see langword="true" /> an existing lock can be replaced.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers">
- <summary>
- Specifies user(s) who can still modify the object.
- Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete"/> may be
- used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete">
- <summary>
- If <see langword="true"/> the object will be marked obsolete.
- Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Nusers"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Obsolete"/> may
- be used. Default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment">
- <summary>
- Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment"/> or
- <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile">
- <summary>
- Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Comment"/>
- or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.Pname">
- <summary>
- Specifies the object pathname to be locked.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.ObjSel">
- <summary>
- Specifies the object(s) to be locked.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem">
- <summary>
- Creates elements in a ClearCase VOB.
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool mkelem</c> command to create ClearCase elements.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase mkelem on the file <c>c:/views/viewdir/afile</c> with element type <c>text_file</c>.
- It checks in the file after creation and adds <c>Some comment text</c> as a comment.
- </para>
- <code>
- <![CDATA[
- <ccmkelem viewpath="c:/views/viewdir/afile"
- eltype="text_file"
- checkin="true"
- comment="Some comment text"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.ViewPath">
- <summary>
- Path to the ClearCase view file or directory that the command will
- operate on.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment">
- <summary>
- Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment"/> or
- <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile">
- <summary>
- Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Comment"/>
- or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.NoWarn">
- <summary>
- If <see langword="true" />, warning will be suppressed.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.NoCheckout">
- <summary>
- Perform a checkout after element creation.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Checkin">
- <summary>
- Checkin element after creation.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.PreserveTime">
- <summary>
- If <see langword="true" />, the modification time will be preserved.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.Master">
- <summary>
- Assign mastership of the main branch to the current site.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.ElType">
- <summary>
- Element type to use during element creation.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.MkPath">
- <summary>
- Create elements from the view-private parent directories.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkElem.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel">
- <summary>
- Applies a ClearCase label.
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType"/>
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool mklabel</c> command to apply a ClearCase label to specified elements.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase mklabel on the file <c>c:/views/viewdir/afile</c> under
- the <c>main</c> branch for <c>version 2</c> (<c>\main\2</c>). All matching
- elements will be applied with label <c>VERSION_1</c>.
- <c>Some comment text</c> is added as a comment. Subdirectories will be recursed.
- </para>
- <code>
- <![CDATA[
- <ccmklabel viewpath="c:/views/viewdir/afile"
- comment="Some comment text"
- recurse="true"
- version="\main\2"
- typename="VERSION_1"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Typename">
- <summary>
- Name of the label type
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.ViewPath">
- <summary>
- Path to the ClearCase view file or directory that the command will
- operate on.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Replace">
- <summary>
- If <see langword="true" />, allow the replacement of a
- label of the same type on the same branch.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Recurse">
- <summary>
- If <see langword="true" />, process each subdirectory recursively under the viewpath.
- Default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Version">
- <summary>
- Identify a specific version to attach the label to.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Vob">
- <summary>
- Path to the ClearCase view file or directory that the command will operate on.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment">
- <summary>
- Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment"/> or
- <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile">
- <summary>
- Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Comment"/>
- or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.Follow">
- <summary>
- For any VOB symbolic links encountered, labels the corresponding target.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType">
- <summary>
- Creates a label object in a ClearCase VOB.
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLabel"/>
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool mklabeltype</c> command to create a ClearCase label object.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase mklbtype to create a label type named <c>VERSION_1</c>.
- It is created as <c>ordinary</c> so it is available only to the current VOB.
- The text <c>Development version 1</c> is added as a comment.
- </para>
- <code>
- <![CDATA[
- <ccmklbtype typename="VERSION_1"
- ordinary="true"
- comment="Development version 1"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Typename">
- <summary>
- Name of the label type to create.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Vob">
- <summary>
- Name of the VOB. Must be a valid path to somewhere on a VOB.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Replace">
- <summary>
- If <see langword="true" />, allow an existing label definition to be replaced.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Global">
- <summary>
- 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 <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Ordinary">
- <summary>
- Creates a label type that can be used only in the current VOB.
- Either global or ordinary can be specified, not both.
- Although <see langword="false" /> by default, if global is also <see langword="false" /> or not specified ordinary is the default behaviour.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.PBranch">
- <summary>
- If <see langword="true" /> the label type is allowed to be used once per branch in a given element's version tree.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Shared">
- <summary>
- Sets the way mastership is checked by ClearCase. See ClearCase documentation for details.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment">
- <summary>
- Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment"/> or
- <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile">
- <summary>
- Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.Comment"/>
- or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseMkLbType.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType">
- <summary>
- Removes elements from a ClearCase VOB.
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool rmtype</c> command to remove a ClearCase object.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase rmtype to remove a <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Label"/>
- type named <c>VERSION_1</c>.
- Comment text from the file <c>acomment.txt</c> is added as a comment.
- All instances of the type are removed, including the type object itself.
- </para>
- <code>
- <![CDATA[
- <ccrmtype typekind="Label"
- typename="VERSION_1"
- commentfile="acomment.txt"
- removeall="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.TypeKind">
- <summary>
- The kind of type to remove.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.TypeName">
- <summary>
- The name of the object to remove.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Ignore">
- <summary>
- Used with <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Trigger"/> types only.
- Forces removal of <see cref="F:NAnt.Contrib.Types.ClearCase.TypeKind.Trigger"/> type even if a
- pre-operation trigger would prevent its removal.
- The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.RemoveAll">
- <summary>
- Removes all instances of a type and the type object itself.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment">
- <summary>
- Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment"/> or
- <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile">
- <summary>
- Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.Comment"/>
- or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseRmType.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut">
- <summary>
- Uncheckout ClearCase elements.
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckIn"/>
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseCheckOut"/>
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool unco</c> command to remove a ClearCase object.
- </para>
- </remarks>
- <example>
- <para>
- Does a ClearCase uncheckout on the file <c>c:/views/viewdir/afile</c>.
- A copy of the file called <c>c:/views/viewdir/afile.keep</c> is kept.
- </para>
- <code>
- <![CDATA[
- <ccuncheckout viewpath="c:/views/viewdir/afile"
- keepcopy="true"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.ViewPath">
- <summary>
- Path to the ClearCase view file or directory that the command will
- operate on.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.KeepCopy">
- <summary>
- If <see langword="true" />, a view-private copy of the file with a
- .keep extension will be kept. Default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnCheckOut.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock">
- <summary>
- Unlocks ClearCase elements.
- <seealso cref="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseLock"/>
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool unlock</c> command to unlock a ClearCase object.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase unlock on the object <c>stream:Application_Integration@\MyProject_PVOB</c>.
- </para>
- <code>
- <![CDATA[
- <ccunlock objsel="stream:Application_Integration@\MyProject_PVOB" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment">
- <summary>
- Specify a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment"/> or
- <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile">
- <summary>
- Specify a file containing a comment. Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Comment"/>
- or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommentFile"/> may be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.Pname">
- <summary>
- Specifies the object pathname to be unlocked.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.ObjSel">
- <summary>
- Specifies the object(s) to be unlocked.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUnLock.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate">
- <summary>
- Updates a ClearCase view.
- </summary>
- <remarks>
- <para>
- This task uses the <c>cleartool update</c> command to update a ClearCase view.
- </para>
- </remarks>
- <example>
- <para>
- Performs a ClearCase update on the snapshot view directory <c>c:/views/viewdir</c>.
- A graphical dialog will be displayed.
- The output will be logged to <c>log.log</c> and it will overwrite any hijacked files.
- The modified time will be set to the current time.
- </para>
- <code>
- <![CDATA[
- <ccupdate viewpath="c:/views/viewdir"
- graphical="false"
- log="log.log"
- overwrite="true"
- currenttime="true"
- rename="false"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.ViewPath">
- <summary>
- Path to the ClearCase view file or directory that the command will
- operate on.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Graphical">
- <summary>
- Displays a graphical dialog during the update.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.LogFile">
- <summary>
- Specifies a log file for ClearCase to write to.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Overwrite">
- <summary>
- If <see langword="true" />, hijacked files will be overwritten.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.Rename">
- <summary>
- If <see langword="true" />, hijacked files will be renamed with a .keep extension.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime">
- <summary>
- Specifies that modification time should be written as the current time.
- Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime"/>
- can be specified. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime">
- <summary>
- Specifies that modification time should preserved from the VOB time.
- Only one of <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CurrentTime"/> or <see cref="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.PreserveTime"/>
- can be specified. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ClearCase.ClearCaseUpdate.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Grep.GrepTask">
- <summary>
- Searches files for a regular-expression and produces an XML report of
- the matches.
- </summary>
- <example>
- <para>
- Extract all <i>TODO:</i>, <i>UNDONE:</i> or <i>HACK:</i>-
- comment-tags from C# source files and write them to a file
- <i>out.xml</i>. (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.)
- </para>
- <para>
- <i>Path</i>, <i>File</i> and <i>LineNumber</i> are automatically
- generated elements.
- </para>
- <code>
- <![CDATA[
- <grep output="out.xml" pattern="// (?'Type'TODO|UNDONE|HACK): (\[(?'Author'\w*),(?'Date'.*)\])? (?'Text'[^\n\r]*)">
- <fileset>
- <include name="*.cs" />
- </fileset>
- </grep>
- ]]>
- </code>
- <para>
- The resulting XML file for a comment-tag
- 'TODO: [md, 14-02-2004] comment this method'
- will look like
- </para>
- <code>
- <![CDATA[
- <?xml version="1.0" encoding="utf-8" ?>
- <Matches>
- <Match>
- <Type>TODO</Type>
- <Text>comment this method</Text>
- <Path>C:\MyProjects\MyPath</Path>
- <File>MyFile.cs</Filename>
- <LineNumber>146</LineNumber>
- <Author>md</Author>
- <Date>14-02-2004</Date>
- </Match>
- ...
- </Matches>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.ExecuteTask">
- <summary>
- Performs the regex-search.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.WriteXml(NAnt.Contrib.Tasks.Grep.MatchCollection,System.IO.StreamWriter)">
- <summary>
- Writes the collection of matches to the specified <see cref="T:System.IO.StreamWriter"/>
- in XML format.
- </summary>
- <param name="matches">The matches to write.</param>
- <param name="writer"><see cref="T:System.IO.StreamWriter"/> to write the matches to.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.GrepTask.WriteMatches(NAnt.Contrib.Tasks.Grep.MatchCollection)">
- <summary>
- Writes the specified matches to <see cref="P:NAnt.Contrib.Tasks.Grep.GrepTask.OutputFile"/>.
- </summary>
- <param name="matches">The collection of matches to write.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.OutputFile">
- <summary>
- Specifies the name of the output file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.Pattern">
- <summary>
- Specifies the regular-expression to search for.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Grep.GrepTask.InputFiles">
- <summary>
- The set of files in which the expression is searched.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Grep.LineCounter">
- <summary>
- This purpose of this class is to get the line-numbers within
- a string for a specific position of a character
- (an index, as returned by the <see cref="T:System.Text.RegularExpressions.Regex"/> class).
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._string">
- <summary>
- The string to count in
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentPos">
- <summary>
- The current position within <see cref="F:NAnt.Contrib.Tasks.Grep.LineCounter._string"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentLine">
- <summary>
- The number of line feeds upto (but exluding) <see cref="F:NAnt.Contrib.Tasks.Grep.LineCounter._currentPos"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.#ctor(System.String)">
- <summary>
- Constructs a line-counter for a <see cref="T:System.String"/>.
- </summary>
- <param name="str"><see cref="T:System.String"/> for which lines are counted.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.CountTo(System.Int32)">
- <summary>
- Counts the line-numbers until the position <paramref name="pos" />
- is reached.
- </summary>
- <param name="pos">Index into the string given during construction </param>
- <returns>
- The number of lines.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.LineCounter.Count(System.String,System.Char,System.Int32,System.Int32)">
- <summary>
- Counts the number of occurences of <paramref name="c"/> in the
- range from <paramref name="start"/> to <paramref name="end"/> in
- string <paramref name="str"/>.
- </summary>
- <param name="str"><see cref="T:System.String"/> to count in.</param>
- <param name="c">Character to count.</param>
- <param name="start">Start of range.</param>
- <param name="end">End of range.</param>
- <returns>
- The number of occurences of <paramref name="c"/> in the range from
- <paramref name="start"/> to <paramref name="end"/> in string
- <paramref name="str"/>.
- </returns>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Grep.Match">
- <summary>
- Encapsulation of a match of a regular-expression with the
- associated named capture-groups.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Grep.Match.values">
- <summary>
- <see cref="T:System.Collections.Hashtable"/> containing the mapping from group names
- to values.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.Match.WriteXml(System.Xml.XmlTextWriter)">
- <summary>
- Writes this match to an <see cref="T:System.Xml.XmlTextWriter"/>.
- </summary>
- <param name="xmlWriter">The <see cref="T:System.Xml.XmlTextWriter"/> to write to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Grep.Match.Item(System.String)">
- <summary>
- Gets or sets the value for a capture group.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Grep.MatchCollection">
- <summary>
- A strongly-typed collection of <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.MatchCollection.Add(NAnt.Contrib.Tasks.Grep.Match)">
- <summary>
- Adds a <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> to this collection.
- </summary>
- <param name="match"><see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> to add.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.MatchCollection.Add(NAnt.Contrib.Tasks.Grep.MatchCollection)">
- <summary>
- Adds all <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances <paramref name="matches"/>
- to this collection.
- </summary>
- <param name="matches">Collection of <see cref="T:NAnt.Contrib.Tasks.Grep.Match"/> instances to add.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Grep.MatchCollection.Item(System.Int32)">
- <summary>
- Gets the <paramref name="idx" />th match stored in this collection.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Grep.Pattern">
- <summary>
- Encapsulation of a search pattern.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.Grep.Pattern"/> class from
- a regular-expression.
- </summary>
- <param name="regex">The regular-expression.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.ConcatenateCaptures(System.Text.RegularExpressions.Group)">
- <summary>
- Concatenates the captures of <paramref name="group"/> to a string.
- </summary>
- <param name="group"><see cref="T:System.Text.RegularExpressions.Group"/> containing the captures.</param>
- <returns>
- <see cref="T:System.String"/> containg the concatenated captures.
- </returns>
- <remarks>
- A named-group can captured multiple times, when the regular
- expression has a quantifier, e.g. (// (?'Text'.*) )* will match
- multiline comments with group <i>Text</i> having a capture for
- every line.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Grep.Pattern.Extract(System.String,System.String)">
- <summary>
- Extracts the matches of this pattern from <paramref name="source" />.
- </summary>
- <param name="filename">The name of the file associated with <paramref name="source" />.</param>
- <param name="source">The source string</param>
- <returns>
- A collection of found matches.
- </returns>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Mks.BaseTask">
- <summary>
- The base abstract class for all MKS Tasks.
- </summary>
- <remarks>
- Provides the core attributes, and functionality for opening an item
- in a MKS database.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Mks.BaseTask.Open">
- <summary>
- Opens the MKS database and sets the reference to the specified
- item and version.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Password">
- <summary>
- The password to use to login to the MKS database.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.UserName">
- <summary>
- The name of the user needed to access the MKS database.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Host">
- <summary>
- The name of the host MKS server to connect to
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.BaseTask.Port">
- <summary>
- The port number on which the host server is accepting requests
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Mks.CheckpointTask">
- <summary>
- Checkpoints a project in an MKS Source Integrity database.
- </summary>
- <example>
- <para>Checkpoint a project in an MKS database.</para>
- <code><![CDATA[
- <mkscheckpoint
- username="myusername"
- password="mypassword"
- host="servername"
- port="123"
- project="myproject"
- recursive="false"
- label="test from nant"
- description="this is a test description"
- />
- ]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Label">
- <summary>
- The label to apply to the checkpoint.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.ProjectName">
- <summary>
- The project to checkpoint.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Recursive">
- <summary>
- Apply label to all members. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.CheckpointTask.Description">
- <summary>
- The description of the checkpoint.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Mks.GetTask">
- <summary>
- Retrieves an item or project from MKS Source Integrity.
- </summary>
- <example>
- <para>Synchronise sandbox with MKS project.</para>
- <code><![CDATA[
- <mksget
- username="myusername"
- password="mypassword"
- host="servername"
- port="123"
- localpath="c:\sourcecode"
- project="e:/MKS projects/myproject/testproject.pj"
- />
- ]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.GetTask.LocalPath">
- <summary>
- The path to the local working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.GetTask.ProjectName">
- <summary>
- The project to get from MKS.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Mks.ChangesTask">
- <summary>
- Generates an XML file containing the differences between the sandbox and
- the project in the MKS database.
- </summary>
- <example>
- <para>Get changes to a project in an MKS database.</para>
- <code><![CDATA[
- <mkschanges
- username="myusername"
- password="mypassword"
- host="servername"
- port="123"
- sandbox="mysandbox.pj"
- output="mychanges.xml"
- />
- ]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.ChangesTask.Sandbox">
- <summary>
- The project to retrieve the changes for.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Mks.ChangesTask.OutputFile">
- <summary>
- The file where the output will be stored in XML format.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand">
- <summary>
- Base class for <see cref="T:NAnt.Contrib.Tasks.Msi.MsiCreationCommand"/> and <see cref="T:NAnt.Contrib.Tasks.Msi.MsmCreationCommand"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.IsVersion(System.String@)">
- <summary>
- 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
- </summary>
- <param name="Version">The version string to verify.</param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ReorderFiles(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32@)">
- <summary>
- 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.
- </summary>
- <param name="database">The MSI database.</param>
- <param name="LastSequence">The last file's sequence number.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CleanOutput(System.String,System.String)">
- <summary>
- Cleans the output directory after a build.
- </summary>
- <param name="cabFile">The path to the cabinet file.</param>
- <param name="tempPath">The path to temporary files.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the Properties table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDirectories(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the Directories table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddDirectory(NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,NAnt.Contrib.Schemas.Msi.MSIDirectory,System.Int32)">
- <summary>
- Adds a directory record to the directories table.
- </summary>
- <param name="database">The MSI database.</param>
- <param name="directoryTable">The MSI database view.</param>
- <param name="ParentDirectory">The parent directory.</param>
- <param name="Directory">This directory's Schema object.</param>
- <param name="Depth">The tree depth of this directory.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetRelativePath(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,System.String,System.String,System.Text.StringBuilder,NAnt.Contrib.Tasks.Msi.InstallerTable)">
- <summary>
- Retrieves the relative path of a file based on
- the component it belongs to and its entry in
- the MSI directory table.
- </summary>
- <param name="database">The MSI database.</param>
- <param name="Name">The Name of the Folder</param>
- <param name="Parent">The Parent of the Folder</param>
- <param name="Default">The Relative Filesystem Path of the Folder</param>
- <param name="Path">The Path to the Folder from previous calls.</param>
- <param name="directoryTable">The MSI database view.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetDisplayablePath(System.String)">
- <summary>
- If the specified path is longer than 40 characters, 37 are returned plus ...
- </summary>
- <param name="path">A shortened path</param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortFile(System.String)">
- <summary>
- Retrieves a DOS 8.3 filename for a file.
- </summary>
- <param name="LongFile">The file to shorten.</param>
- <returns>The new shortened file.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortPath(System.String)">
- <summary>
- Retrieves a DOS 8.3 filename for a directory.
- </summary>
- <param name="LongPath">The path to shorten.</param>
- <returns>The new shortened path.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetShortDir(System.String)">
- <summary>
- Retrieves a DOS 8.3 filename for a complete directory.
- </summary>
- <param name="LongPath">The path to shorten.</param>
- <returns>The new shortened path.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">
- <summary>
- Recursively expands properties of all attributes of
- a nodelist and their children.
- </summary>
- <param name="Nodes">The nodes to recurse.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.ByteArrayToString(System.Byte[])">
- <summary>
- Converts the Byte array in a public key
- token of an assembly to a string MSI expects.
- </summary>
- <param name="ByteArray">The array of bytes.</param>
- <returns>The string containing the array.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadTypeLibs(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads TypeLibs for the TypeLib table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadEnvironmentVariables(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads environment variables for the Environment table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadRegistry(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the Registry table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadRegistryLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the RegLocator table
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the CompLocator table
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIniLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the IniLocator table
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDirFileLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the DrLocator table
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDepreciatedLocators(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the RegLocator table
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.GetRegistryRootByName(System.String)">
- <summary>
- Gets the name of the registry root id by it's name.
- </summary>
- <param name="root">Name of the registry root</param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadApplicationSearch(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the AppSearch table
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIconData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the Icon table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadShortcutData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the Shortcut table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadUserDefinedTables(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Adds custom table(s) to the msi database
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddTableData(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,NAnt.Contrib.Schemas.Msi.MSITable,System.Collections.ArrayList)">
- <summary>
- Adds table data to the msi database table structure
- </summary>
- <param name="database">The MSI database.</param>
- <param name="currentTable">The current table name</param>
- <param name="xmlTable">Xml node representing the current table</param>
- <param name="columnList">List of column objects for the current table (Containing: column name, id, type).</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadBinaryData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- 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.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the Dialog table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the Control table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlConditionData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ControlCondtion table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadDialogControlEventData(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ControlEvent table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadCustomAction(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the CustomAction table
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadActionText(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ActionText table. Allows users to specify descriptions/templates for actions.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppMappings(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the _AppMappings table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadUrlProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the _UrlToDir table.
- "Load the url properties to convert
- url properties to a properties object" ??
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadVDirProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the _VDirToUrl table.
- Used for converting a vdir to an url
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadAppRootCreate(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the _AppRootCreate table.
- Used for making a virtual directory a virtual application
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadIISDirectoryProperties(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the _IISProperties table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CheckAssemblyForCOMInterop(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.String,System.Reflection.Assembly,System.String,System.String,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable)">
- <summary>
- 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.
- </summary>
- <param name="database">The MSI database.</param>
- <param name="fileName">The Assembly filename.</param>
- <param name="fileAssembly">The Assembly to check.</param>
- <param name="componentName">The name of the containing component.</param>
- <param name="assemblyComponentName">The name of the containing component's assembly GUID.</param>
- <param name="classTable">View containing the Class table.</param>
- <param name="progIdTable">View containing the ProgId table.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadSummaryInformation(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads properties for the Summary Information Stream.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.CreateCabFile(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Creates a .cab file with all source files included.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadSequence(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the sequence tables.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.AddFiles(NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Schemas.Msi.MSIComponent,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,System.String,System.Int32@,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable)">
- <summary>
- Adds a file record to the Files table.
- </summary>
- <param name="database">The MSI database.</param>
- <param name="directoryTable">The MSI database view.</param>
- <param name="Component">The Component's XML Element.</param>
- <param name="fileTable">The MSI database view.</param>
- <param name="ComponentDirectory">The directory of this file's component.</param>
- <param name="ComponentName">The name of this file's component.</param>
- <param name="Sequence">The installation sequence number of this file.</param>
- <param name="msiAssemblyTable">View containing the MsiAssembly table.</param>
- <param name="msiAssemblyNameTable">View containing the MsiAssemblyName table.</param>
- <param name="componentTable">View containing the Components table.</param>
- <param name="featureComponentTable">View containing the FeatureComponents table.</param>
- <param name="classTable">View containing the Class table.</param>
- <param name="progIdTable">View containing the ProgId table.</param>
- <param name="selfRegTable">View containing the SelfReg table.</param>
- <param name="modComponentTable">ModuleComponent table.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.LoadComponents(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32@)">
- <summary>
- Loads records for the Components table.
- </summary>
- <param name="database">The MSI database.</param>
- <param name="LastSequence">The sequence number of the last file in the .cab</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerCreationCommand.Execute">
- <summary>
- Executes the Task.
- </summary>
- <remarks>None.</remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.InstallerDatabase">
- <summary>
- .NET wrapper for a Windows Installer database
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.DropEmptyTables">
- <summary>
- Drops empty tables.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.DropEmptyTables(System.Boolean)">
- <summary>
- Drops the empty tables.
- </summary>
- <param name="isMergeModule">Determines if this is a merge module or not</param>
- <remarks>If it is a merge module, the FeatureComponents table should not be dropped.</remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.VerifyTableEmpty(System.String)">
- <summary>
- Checks to see if the specified table is empty.
- </summary>
- <param name="TableName">Name of the table to check existance.</param>
- <returns>True if empy and False if full.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerDatabase.VerifyTableExistance(System.String)">
- <summary>
- Checks to see if the specified table exists in the database
- already.
- </summary>
- <param name="TableName">Name of the table to check existance.</param>
- <returns>True if successful.</returns>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.Installer">
- <remarks>
- Helper class used to avoid errors when instantiating
- WindowsInstaller.Installer.
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.InstallerRecordReader">
- <summary>
- Use to read and manipulate existing records.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.#ctor(WindowsInstaller.View)">
- <summary>
- Creates a new reader for the entries in the view
- </summary>
- <param name="view">Database view to read entries from. Must be Execute()'ed already.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.Read">
- <summary>
- Moves to the next record
- </summary>
- <returns>False iff no more records</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.DeleteCurrentRecord">
- <summary>
- Deletes the current record. Needs no Commit().
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.SetValue(System.Int32,System.Object)">
- <summary>
- Set the value of a field in the current record. Remember to Commit()
- </summary>
- <param name="index">Zero-based index of the field to set</param>
- <param name="value">New value</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.GetString(System.Int32)">
- <summary>
- Get the string value of a field in the current record.
- </summary>
- <param name="index">Zero-based index of the field to get</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.InstallerRecordReader.Commit">
- <summary>
- Commits changes to the current record.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.InstallerSearchClause">
- <summary>
- A simple class for a single search clause.
- TODO: more comparison types, use of the Composite pattern, etc.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.InstallerTable">
- <summary>
- Represents a single table in a Windows Installer archive
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.InstallerTaskBase">
- <summary>
- Base class for msi/msm installer tasks
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SchemaValidatedTask">
- <summary>
- Abstract <see cref="T:NAnt.Core.Task"/> that validates inheriting classes against
- an XML schema of the same name.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes the task and verifies parameters.
- </summary>
- <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.Task_OnSchemaValidate(System.Object,System.Xml.Schema.ValidationEventArgs)">
- <summary>
- Occurs when a validation error is raised.
- </summary>
- <param name="sender">The object that sent the event.</param>
- <param name="args">Validation arguments passed in.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SchemaValidatedTask.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">
- <summary>
- Recursively expands properties of all attributes of
- a nodelist and their children.
- </summary>
- <param name="Nodes">The nodes to recurse.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SchemaValidatedTask.SchemaObject">
- <summary>
- Returns the object from the Schema wrapper after
- <see cref="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)"/> is called.
- </summary>
- <value>The object from the Schema wrapper after <see cref="M:NAnt.Contrib.Tasks.SchemaValidatedTask.InitializeTask(System.Xml.XmlNode)"/> is called.</value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiOutput">
- <summary>
- The name of the file that will be generated when the task completes
- execution (eg. MyInstall.msi or MyMergeModule.msm).
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiSourceDir">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiTemplate">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiErrorTemplate">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.MsiDebug">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSummaryInformationElement">
- <summary>
- <para>
- Sets various properties in the SummaryInformation stream
- (http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/summary_information_stream.asp)
- </para>
- <para>
- All of the sub-elements are optional.
- </para>
- <h3>Nested Elements:</h3>
- <h4><title></h4>
- <ul>
- Briefly describes the type of installer package. Phrases such as "Installation Database" or
- "Transform" or "Patch" may be used for this property.
- <br />Default value: Value of the <c>ProductName</c> property, if defined.
- </ul>
- <h4></title></h4>
- <h4><subject></h4>
- <ul>
- A short description of the product to be installed. This value is typically set from the installer
- property <c>ProductName</c>
- <br />Default value: Value of the <c>ProductName</c> property, if defined.
- </ul>
- <h4></subject></h4>
- <h4><author></h4>
- <ul>
- The manufacturer of the installation database. This value is typically set from the installer
- property <c>Manufacturer</c>.
- <br />Default value: Value of the <c>Manufacturer</c> property, if defined.
- </ul>
- <h4></author></h4>
- <h4><keywords></h4>
- <ul>
- 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.
- <br />Default value: Value of the <c>Keywords</c> property, if defined.
- </ul>
- <h4></keywords></h4>
- <h4><comments></h4>
- <ul>
- A general description/purpose of the installer database.
- <br />Default value: Value of the <c>Comments</c> property, if defined.
- </ul>
- <h4></comments></h4>
- <h4><template></h4>
- <ul>
- <para>
- 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.
- </para>
- <para>
- See http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/template_summary_property.asp for more information.
- </para>
- </ul>
- <h4></template></h4>
- <h4><revisionnumber></h4>
- <ul>
- 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
- </ul>
- <h4></revisionnumber></h4>
- <h4><creatingapplication></h4>
- <ul>
- The name of the application used to author the database. Note: Default value is NAnt.
- </ul>
- <h4></creatingapplication></h4>
- <h3>Examples</h3>
- <example>
- <para>Define specific summary information.</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerPropertiesElement">
- <summary>
- <para>
- Name/value pairs which will be set in the PROPERTY table of the
- installer database.
- </para>
- <para>
- The properties element contains within it one to any number of property elements.<br/>
- <see href="http://msdn.microsoft.com/library/en-us/msi/setup/protected_properties.asp">Public property</see> names cannot contain lowercase letters.<br/>
- <see href="http://msdn.microsoft.com/library/en-us/msi/setup/protected_properties.asp">Private property</see> names must contain some lowercase letters.<br/>
- Property names prefixed with % represent system and user environment variables. These are
- never entered into the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/property_table.asp">Property
- table</see>. The permanent settings of environment variables can only be modified using the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">Environment Table</see>.
- More information is available <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/msi/setup/properties.asp">here</see>.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A name used to refer to the property.</term>
- <term>True</term>
- </item>
- <item>
- <term>value</term>
- <term>string</term>
- <term>The value of the property. This value can contain references to other, predefined properties to build a compound property.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Define the required properties.</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSearchElement">
- <summary>
- <para>
- 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.
- </para>
- <h3><app></h3>
- <para>
- 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
- </para>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>componentid</term>
- <term>string</term>
- <term>The component ID of the component whose key path is to be used for the search.</term>
- <term>True</term>
- </item>
- <item>
- <term>type</term>
- <term>msi:MSILocatorTypeDirFile</term>
- <term>Valid input: <c>file</c> or <c>directory</c></term>
- <term>True</term>
- </item>
- <item>
- <term>setproperty</term>
- <term>string</term>
- <term>A name used to refer to the property within the Msi database. Set at install time.</term>
- <term>True</term>
- </item>
- </list>
- <h3></app></h3>
- <h3><registry></h3>
- <para>
- 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
- </para>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>type</term>
- <term>msi:MSILocatorTypeDirFileReg64</term>
- <term>Valid input: <c>registry</c>, <c>file</c>, <c>directory</c>, <c>64bit</c></term>
- <term>True</term>
- </item>
- <item>
- <term>path</term>
- <term>string</term>
- <term>Depending on the <c>type</c> specified:
- <list type="bullet">
- <item>Path is a directory.</item>
- <item>Path is a registry key.</item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>root</term>
- <term>msi:MSIRegistryKeyRoot</term>
- <term>Valid input:
- <list type="bullet">
- <item><c>dependent</c> - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1.</item>
- <item><c>machine</c> represents HKEY_LOCAL_MACHINE</item>
- <item><c>classes</c> represents HKEY_CLASSES_ROOT</item>
- <item><c>user</c> represents HKEY_CURRENT_USER</item>
- <item><c>users</c> represents HKEY_USERS</item>
- </list>
- </term>
- <term>True</term>
- </item>
- </list>
- <ul>
- <h3>Nested Elements:</h3>
- <h4><value></h4>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Depending on the <c>type</c> specified:
- <list type="bullet">
- <item>Key path is a file name.</item>
- <item>Key path is a registry value.</item>
- </list>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>setproperty</term>
- <term>string</term>
- <term>A name used to refer to the property within the Msi database. Set at install time.</term>
- <term>True</term>
- </item>
- </list>
- <h4></value></h4>
- </ul>
- <h3></registry></h3>
- <h3><ini></h3>
- <para>
- 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
- </para>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>filename</term>
- <term>string</term>
- <term>The .ini file name. (The .ini file must be present in the default Microsoft Windows directory.)
- </term>
- <term>True</term>
- </item>
- <item>
- <term>section</term>
- <term>string</term>
- <term>Section name within the .ini file.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>key</term>
- <term>string</term>
- <term>Key value within the section.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>field</term>
- <term>msi:nonNegativeInt</term>
- <term>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.
- </term>
- <term>False</term>
- </item>
- <item>
- <term>type</term>
- <term>msi:MSILocatorTypeDirFileRaw</term>
- <term>Valid input: <c>file</c> ,<c>directory</c>, or <c>raw</c></term>
- <term>True</term>
- </item>
- <item>
- <term>setproperty</term>
- <term>string</term>
- <term>A name used to refer to the property within the Msi database. Set at install time.</term>
- <term>True</term>
- </item>
- </list>
- <h3></ini></h3>
- <h3><dirfile></h3>
- <para>
- 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
- </para>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>parent</term>
- <term>string</term>
- <term>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.
- <br/>In order to determine what the key is for a table, prefix the property name assigned
- to that locator with SIG_
- </term>
- <term>False</term>
- </item>
- <item>
- <term>path</term>
- <term>string</term>
- <term>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.
- </term>
- <term>False</term>
- </item>
- <item>
- <term>depth</term>
- <term>msi:nonNegativeInt</term>
- <term>The depth below the path that the installer searches for the file or directory.
- </term>
- <term>False</term>
- </item>
- <item>
- <term>setproperty</term>
- <term>string</term>
- <term>A name used to refer to the property within the Msi database. Set at install time.</term>
- <term>True</term>
- </item>
- </list>
- <ul>
- <h3>Nested Elements:</h3>
- <h4><file></h4>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>The name of the file.</term>
- <term>True</term>
- </item>
- <item>
- <term>minversion</term>
- <term>string</term>
- <term>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.</term>
- <term>False</term>
- </item>
- <item>
- <term>maxversion</term>
- <term>string</term>
- <term>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.</term>
- <term>False</term>
- </item>
- <item>
- <term>minsize</term>
- <term>msi:nonNegativeInt</term>
- <term>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.</term>
- <term>False</term>
- </item>
- <item>
- <term>maxsize</term>
- <term>msi:nonNegativeInt</term>
- <term>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.</term>
- <term>False</term>
- </item>
- <item>
- <term>mindate</term>
- <term>msi:nonNegativeInt</term>
- <term>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.</term>
- <term>False</term>
- </item>
- <item>
- <term>maxdate</term>
- <term>msi:nonNegativeInt</term>
- <term>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.</term>
- <term>False</term>
- </item>
- <item>
- <term>languages</term>
- <term>string</term>
- <term>The languages supported by the file.</term>
- <term>False</term>
- </item>
- </list>
- <h4></file></h4>
- </ul>
- <h3></dirfile></h3>
- <h3>Examples</h3>
- <example>
- <para>Get the path of the web directory and the version of IIS. Create new properties in the Msi file with those values.</para>
- <code>
- <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>
- </code>
- </example>
- <example>
- <para>Shows two ways to get the default key value for the specified key. Create new properties in the Msi file with those values.</para>
- <code>
- <search>
- <registry type="registry" path="Software\Microsoft\MessengerService" root="machine" >
- <value setproperty="MSGSRVNAME" />
- <value name="" setproperty="MSGSRVNAME2" />
- </registry>
- </search>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerLaunchConditionsElement">
- <summary>
- <para>
- Contains within it one to any number of launchcondition elements.
- Launch conditions are conditions that all must be satisfied for the
- installation to begin.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A name used to identify the launch condition.</term>
- <term>True</term>
- </item>
- <item>
- <term>condition</term>
- <term>string</term>
- <term>Expression that must evaluate to True for installation to begin.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><description></h4>
- <ul>
- Localizable text to display when the condition fails and the installation must be terminated.
- </ul>
- <h4></description></h4>
- <h3>Examples</h3>
- <example>
- <para>Create a check to make sure that IIS 5.x is installed.</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerTablesElement">
- <summary>
- <para>
- Creates custom tables not directly managed by default features of
- the installer task.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A unique name used to identify the table.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><columns></h4>
- <ul>
- <h4><column></h4>
- <ul>
- Defines the columns making up the table
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A unique name used to define the column.</term>
- <term>True</term>
- </item>
- <item>
- <term>nullable</term>
- <term>bool</term>
- <term>When set to <c>true</c>, allows the column to accept null values; <c>false</c> does not allow null values.</term>
- <term>True</term>
- </item>
- <item>
- <term>category</term>
- <term>msi:MSITableColumnCategoryType</term>
- <term>Valid input:
- <list type="bullet">
- <item><c>Text</c></item>
- <item><c>UpperCase</c></item>
- <item><c>LowerCase</c></item>
- <item><c>Integer</c></item>
- <item><c>DoubleInteger</c></item>
- <item><c>Time/Date</c></item>
- <item><c>Identifier</c></item>
- <item><c>Property</c></item>
- <item><c>Filename</c></item>
- <item><c>WildCardFilename</c></item>
- <item><c>Path</c></item>
- <item><c>Paths</c></item>
- <item><c>AnyPath</c></item>
- <item><c>DefaultDir</c></item>
- <item><c>RegPath</c></item>
- <item><c>Formatted</c></item>
- <item><c>Template</c></item>
- <item><c>Condition</c></item>
- <item><c>GUID</c></item>
- <item><c>Version</c></item>
- <item><c>Language</c></item>
- <item><c>Binary</c></item>
- <item><c>Cabinet</c></item>
- <item><c>Shortcut</c></item>
- </list>
- More information here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp">http://msdn.microsoft.com/library/en-us/msi/setup/column_data_types.asp</a>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>type</term>
- <term>string</term>
- <term>Overrides the <c>category</c> specification. An example of valid input would be: <c>S255</c></term>
- <term>False</term>
- </item>
- <item>
- <term>key</term>
- <term>bool</term>
- <term>When set to <c>true</c>, the column is used to form the primary key for the table; <c>false</c> specifies that the column is not used to form the primary key.</term>
- <term>False</term>
- </item>
- <item>
- <term>minvalue</term>
- <term>int</term>
- <term>This field applies to columns having numeric value. The field contains the minimum permissible value. This can be the minimum value for an integer or the minimum value for a date or version string.</term>
- <term>False</term>
- </item>
- <item>
- <term>maxvalue</term>
- <term>int</term>
- <term>This field applies to columns having numeric value. The field is the maximum permissible value. This may be the maximum value for an integer or the maximum value for a date or version string. </term>
- <term>False</term>
- </item>
- <item>
- <term>keytable</term>
- <term>string</term>
- <term>This field applies to columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. This can be a list of tables separated by semicolons.</term>
- <term>False</term>
- </item>
- <item>
- <term>keycolumn</term>
- <term>int</term>
- <term>This field applies to table columns that are external keys. The field identified in Column must link to the column number specified by KeyColumn in the table named in KeyTable. The permissible range of the KeyColumn field is 1-32.</term>
- <term>False</term>
- </item>
- <item>
- <term>set</term>
- <term>string</term>
- <term>This is a list of permissible values for this field separated by semicolons. This field is usually used for enums.</term>
- <term>False</term>
- </item>
- <item>
- <term>description</term>
- <term>string</term>
- <term>A description of the data that is stored in the column. </term>
- <term>False</term>
- </item>
- </list>
- </ul>
- <h4></column></h4>
- </ul>
- <h4></columns></h4>
- <h4><rows></h4>
- <ul>
- <h4><row></h4>
- <ul>
- Defines the data for a row in the table
- <h4><columns></h4>
- <ul>
- <h4><column></h4>
- <ul>
- Defines data for a specific cell in the row
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Name of the column to populate.</term>
- <term>True</term>
- </item>
- <item>
- <term>value</term>
- <term>string</term>
- <term>Value to populate the cell with.</term>
- <term>True</term>
- </item>
- </list>
- </ul>
- <h4></column></h4>
- </ul>
- <h4></columns></h4>
- </ul>
- <h4></row></h4>
- </ul>
- <h4></rows></h4>
- <h3>Examples</h3>
- <example>
- <para>
- Build the IniFile table. Since the WriteIniValues and RemoveIniValues actions exist in the template, they will use this table.
- </para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerDirectoriesElement">
- <summary>
- <para>
- Specifies the directory layout for the product.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A name used to refer to the directory.</term>
- <term>True</term>
- </item>
- <item>
- <term>foldername</term>
- <term>string</term>
- <term>The directory's name (localizable)under the parent directory.</term>
- <term>True</term>
- </item>
- <item>
- <term>root</term>
- <term>string</term>
- <term>A reference to the directory's parent directory. This can be a property name or one of the predefined directories included with the default template:
- <list type="bullet">
- <item><c>AdminToolsFolder</c></item>
- <item><c>AppDataFolder</c></item>
- <item><c>CommonAppDataFolder</c></item>
- <item><c>CommonFiles64Folder</c></item>
- <item><c>CommonFilesFolder</c></item>
- <item><c>DesktopFolder</c></item>
- <item><c>FavoritesFolder</c></item>
- <item><c>FontsFolder</c></item>
- <item><c>LocalAppDataFolder</c></item>
- <item><c>MyPicturesFolder</c></item>
- <item><c>PersonalFolder</c></item>
- <item><c>ProgramFilesFolder</c></item>
- <item><c>ProgramMenuFolder</c></item>
- <item><c>ProgramFiles64Folder</c></item>
- <item><c>SendToFolder</c></item>
- <item><c>StartMenuFolder</c></item>
- <item><c>StartupFolder</c></item>
- <item><c>System16Folder</c></item>
- <item><c>System64Folder</c></item>
- <item><c>SystemFolder</c></item>
- <item><c>TARGETDIR</c></item>
- <item><c>TempFolder</c></item>
- <item><c>TemplateFolder</c></item>
- <item><c>WindowsFolder</c></item>
- <item><c>WindowsVolume</c></item>
- </list>
- </term>
- <term>True</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><directory></h4>
- <ul>
- Sub directories. Note, this element can contain nested <directory/> sub elements.
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A name used to refer to the directory.</term>
- <term>True</term>
- </item>
- <item>
- <term>foldername</term>
- <term>string</term>
- <term>The directory's name (localizable)under the parent directory.</term>
- <term>True</term>
- </item>
- </list>
- </ul>
- <h4></directory></h4>
- <h3>Examples</h3>
- <example>
- <para>Define a sample directory structure.</para>
- <code>
- <directories>
- <directory name="D__ACME" foldername="ACME" root="TARGETDIR" >
- <directory name="D__ACME_MyProduct" foldername="My Product" />
- </directory>
- </directories>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerEnvironmentElement">
- <summary>
- <para>
- Used to modify the environment variables of the target computer at
- runtime.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>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.
- <list type="table">
- <listheader>
- <term>Prefix</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>=</term>
- <description>Create the environment variable if it does not exist, and then set it during installation. If the environment variable exists, set it during the installation.</description>
- </item>
- <item>
- <term>+</term>
- <description>Create the environment variable if it does not exist, then set it during installation. This has no effect on the value of the environment variable if it already exists.</description>
- </item>
- <item>
- <term>-</term>
- <description>Remove the environment variable when the component is removed. This symbol can be combined with any prefix.</description>
- </item>
- <item>
- <term>!</term>
- <description>Remove the environment variable during an installation. The installer only removes an environment variable during an installation if the name and value of the variable match the entries in the Name and Value fields of the Environment table. If you want to remove an environment variable, regardless of its value, use the '!' syntax, and leave the Value field empty.</description>
- </item>
- <item>
- <term>*</term>
- <description>This prefix is used with Microsoft® Windows® NT/Windows® 2000 to indicate that the name refers to a system environment variable. If no asterisk is present, the installer writes the variable to the user's environment. Microsoft Windows 95/98 ignores the asterisk and add the environment variable to autoexec.bat. This symbol can be combined with any prefix. A package that is used for per-machine installations should write environment variables to the machine's environment by including * in the Name column. For more information, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp</a></description>
- </item>
- <item>
- <term>=-</term>
- <description>The environment variable is set on install and removed on uninstall. This is the usual behavior.</description>
- </item>
- <item>
- <term>!-</term>
- <description>Removes an environment variable during an install or uninstall.</description>
- </item>
- </list>
- More information can be found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/environment_table.asp</a>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>append</term>
- <term>string</term>
- <term>Localizable value that is to be set as a <a href="http://msdn.microsoft.com/library/en-us/msi/setup/formatted.asp">formatted</a> string</term>
- <term>True</term>
- </item>
- <item>
- <term>component</term>
- <term>string</term>
- <term>Refrence to a component. Allows the variabled to be modified when the component is un/installed.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Append the installation path to the user PATH variable.</para>
- <code>
- <environment>
- <variable name="PATH" append="'[TARGETDIR]'" component="C__MainFiles" />
- </environment>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerComponentsElement">
- <summary>
- <para>
- Groups sets of files into named sets, these can be used to install
- and perform operations on a set of files as one entity.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A name used to refer to the component.</term>
- <term>True</term>
- </item>
- <item>
- <term>id</term>
- <term>string</term>
- <term>A string GUID unique to this component, version, and language.<br/>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.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>attr</term>
- <term>int</term>
- <term>This column contains a bit flag that specifies options for remote execution. Add the indicated bit to the total value in the column to include an option.
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>0</term>
- <description>Component cannot be run from source. <br/>
- 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.
- </description>
- </item>
- <item>
- <term>1</term>
- <description>Component can only be run from source. <br/>
- 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.
- </description>
- </item>
- <item>
- <term>2</term>
- <description>Component can run locally or from source.</description>
- </item>
- <item>
- <term>4</term>
- <description>If this bit is set, the value in the key element is used as a key into the Registry table.<br/>
- 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.<br/>
- 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.
- </description>
- </item>
- <item>
- <term>16</term>
- <description>If this bit is set, the installer does not remove the component during an uninstall. The installer registers an extra system client for the component in the Windows Installer registry settings.
- </description>
- </item>
- <item>
- <term>32</term>
- <description>If this bit is set, the value in the KeyPath column is a key into the ODBCDataSource table.</description>
- </item>
- <item>
- <term>64</term>
- <description>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. <br/>This bit should only be set for transitive components. See Using Transitive
- Components.
- </description>
- </item>
- <item>
- <term>128</term>
- <description>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. <br/>
- Use this flag only for components that are being registered by the Registry table.
- </description>
- </item>
- <item>
- <term>256</term>
- <description>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.
- </description>
- </item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>directory</term>
- <term>string</term>
- <term>Refrence to a directory. Defines the directory location for where the files assigned to the component are to be placed.</term>
- <term>True</term>
- </item>
- <item>
- <term>feature</term>
- <term>string</term>
- <term>Refrence to a feature. Maps a feature to the component. Used to determine if the component is to be installed or not.</term>
- <term>True</term>
- </item>
- <item>
- <term>condition</term>
- <term>string</term>
- <term>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.</term>
- <term>False</term>
- </item>
- <item>
- <term>fileattr</term>
- <term>int</term>
- <term>Integer containing bit flags representing file attributes.<br/>
- The following table shows the definition of the bit field.
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>1</term>
- <description>Read-Only</description>
- </item>
- <item>
- <term>2</term>
- <description>Hidden</description>
- </item>
- <item>
- <term>4</term>
- <description>System</description>
- </item>
- <item>
- <term>512</term>
- <description>The file is vital for the proper operation of the component to which it belongs</description>
- </item>
- <item>
- <term>1024</term>
- <description>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</description>
- </item>
- <item>
- <term>4096</term>
- <description>This bit must only be added by a patch and if the file is being added by the patch.</description>
- </item>
- <item>
- <term>8192</term>
- <description>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.</description>
- </item>
- <item>
- <term>16384</term>
- <description>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.</description>
- </item>
- </list>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>checkinterop</term>
- <term>bool</term>
- <term>Used to determine if file(s) in the fileset are interop file(s). If <c>true</c>, extra information will be added in the install
- package to register each interop file. If <c>false</c>, the file(s) will not be not be checked and the extra registration information
- will not be added to the msi. </term>
- <term>False</term>
- </item>
- <item>
- <term>installassembliestogac</term>
- <term>bool</term>
- <term>Used to determine if assemblies should be installed to the Global Assembly Cache.
- If <c>true</c>, all assemblies in the fileset will be added to the GAC. If <c>false</c>, 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.</term>
- <term>False</term>
- </item>
- <item>
- <term>keepsubdirs</term>
- <term>bool</term>
- <term>Used to determine if directories in the fileset should be built.
- If <c>true</c>, all subdirectories of the fileset basedir will be built. If <c>false</c> the directories structure will be
- flattened. The default is <c>false</c>.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><keyfile></h4>
- <ul>
- 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.
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>file</term>
- <term>string</term>
- <term>Name of the key (file) to use. Also, this could be an id of a registry key value.</term>
- <term>True</term>
- </item>
- </list>
- </ul>
- <h4></keyfile></h4>
- <h4><fileset></h4>
- <ul>
- Specifies the files to include with the component
- </ul>
- <h4></fileset></h4>
- <h4><forceid></h4>
- <ul>
- Used to force specific attributes on a per file basis
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>file</term>
- <term>string</term>
- <term>Name of the file, in the fileset, to override.</term>
- <term>True</term>
- </item>
- <item>
- <term>id</term>
- <term>string</term>
- <term>Unique GUID to assign to the file.</term>
- <term>True</term>
- </item>
- <item>
- <term>attr</term>
- <term>int</term>
- <term>Integer containing bit flags representing file attributes.<br/>
- The following table shows the definition of the bit field.
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>1</term>
- <description>Read-Only</description>
- </item>
- <item>
- <term>2</term>
- <description>Hidden</description>
- </item>
- <item>
- <term>4</term>
- <description>System</description>
- </item>
- <item>
- <term>512</term>
- <description>The file is vital for the proper operation of the component to which it belongs</description>
- </item>
- <item>
- <term>1024</term>
- <description>The file contains a valid checksum. A checksum is required to repair a file that has become corrupted.</description>
- </item>
- <item>
- <term>4096</term>
- <description>This bit must only be added by a patch and if the file is being added by the patch.</description>
- </item>
- <item>
- <term>8192</term>
- <description>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.</description>
- </item>
- <item>
- <term>16384</term>
- <description>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.</description>
- </item>
- </list>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>version</term>
- <term>string</term>
- <term>This field is the version string for a versioned file. This field is blank for non-versioned files.</term>
- <term>False</term>
- </item>
- <item>
- <term>language</term>
- <term>string</term>
- <term>A list of decimal language IDs separated by commas.</term>
- <term>False</term>
- </item>
- <item>
- <term>checkinterop</term>
- <term>bool</term>
- <term>Used to determine if file is an interop file. If <c>true</c>, extra information will be added in the install
- package to register the interop file. If <c>false</c>, the file will not be not be checked and the extra registration information
- will not be added to the msi.</term>
- <term>False</term>
- </item>
- <item>
- <term>installtogac</term>
- <term>bool</term>
- <term>If <c>true</c>, and if the file is an assembly, it will be installed to the GAC. If <c>false</c>, the file
- 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.</term>
- <term>False</term>
- </item>
- </list>
- </ul>
- <h4></forceid></h4>
- <h3>Examples</h3>
- <example>
- <para>Define a sample component structure.</para>
- <code>
- <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>
- </code>
- </example>
- <example>
- <para>Install files to TARGETDIR and assemblies to the GAC (Global Assembly Cache). Do not install MyOtherAssembly.dll to the GAC, but rather install it with the other files (to TARGETDIR)</para>
- <code>
- <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>
- </code>
- </example>
- <example>
- <para>Assign a registry entry to a specific component.</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerDialogsElement">
- <summary>
- <para>
- Creates custom dialogs that can gather information not handled by
- the default installer template.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A name used to refer to the dialog.</term>
- <term>True</term>
- </item>
- <item>
- <term>hcenter</term>
- <term>int</term>
- <term>Horizontal position of the dialog box. The range is 0 to 100, with 0 at the left edge of the screen and 100 at the right edge.</term>
- <term>True</term>
- </item>
- <item>
- <term>vcenter</term>
- <term>int</term>
- <term>Vertical position of the dialog box. The range is 0 to 100, with 0 at the top edge of the screen and 100 at the bottom edge.</term>
- <term>True</term>
- </item>
- <item>
- <term>width</term>
- <term>int</term>
- <term>Width of the rectangular boundary of the dialog box. This number must be non-negative.</term>
- <term>True</term>
- </item>
- <item>
- <term>height</term>
- <term>int</term>
- <term>Height of the rectangular boundary of the dialog box. This number must be non-negative.</term>
- <term>True</term>
- </item>
- <item>
- <term>attr</term>
- <term>int</term>
- <term>A 32-bit word that specifies the attribute flags to be applied to this dialog box. This number must be non-negative.
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>1</term>
- <description>Visible</description>
- </item>
- <item>
- <term>2</term>
- <description>Modal</description>
- </item>
- <item>
- <term>4</term>
- <description>Minimize</description>
- </item>
- <item>
- <term>8</term>
- <description>SysModal</description>
- </item>
- <item>
- <term>16</term>
- <description>KeepModeless</description>
- </item>
- <item>
- <term>32</term>
- <description>TrackDiskSpace</description>
- </item>
- <item>
- <term>64</term>
- <description>UseCustomPalette</description>
- </item>
- <item>
- <term>128</term>
- <description>RTLRO</description>
- </item>
- <item>
- <term>256</term>
- <description>RightAligned</description>
- </item>
- <item>
- <term>512</term>
- <description>LeftScroll</description>
- </item>
- <item>
- <term>896</term>
- <description>BiDi</description>
- </item>
- <item>
- <term>65536</term>
- <description>Error</description>
- </item>
- </list>
- More information here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp">http://msdn.microsoft.com/library/en-us/msi/setup/dialog_style_bits.asp</a>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>title</term>
- <term>string</term>
- <term>A localizable text string specifying the title to be displayed in the title bar of the dialog box.</term>
- <term>True</term>
- </item>
- <item>
- <term>firstcontrol</term>
- <term>string</term>
- <term>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. <br/>
- 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.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>defaultcontrol</term>
- <term>string</term>
- <term>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.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>cancelcontrol</term>
- <term>string</term>
- <term>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. <br />
- 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.
- </term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Add a web folder dialog:</para>
- <code>
- <dialogs>
- <dialog name="WebFolderDlg" hcenter="50" vcenter="50" width="370" height="270" attr="39" title="[ProductName] [Setup]" firstcontrol="Next" defaultcontrol="Next" cancelcontrol="Cancel" />
- </dialogs>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlsElement">
- <summary>
- <para>
- Creates user interface controls displayed on custom dialogs.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes.</term>
- <term>True</term>
- </item>
- <item>
- <term>dialog</term>
- <term>string</term>
- <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
- <term>True</term>
- </item>
- <item>
- <term>type</term>
- <term>string</term>
- <term>The type of the control.
- <list type="table">
- <listheader>
- <term>Control name</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>Billboard</term>
- <description>Displays billboards based on progress messages.</description>
- </item>
- <item>
- <term>Bitmap</term>
- <description>Displays a static picture of a bitmap.</description>
- </item>
- <item>
- <term>CheckBox</term>
- <description>A two-state check box.</description>
- </item>
- <item>
- <term>ComboBox</term>
- <description>A drop-down list with an edit field.</description>
- </item>
- <item>
- <term>DirectoryCombo</term>
- <description>Select all except the last segment of the path.</description>
- </item>
- <item>
- <term>DirectoryList</term>
- <description>Displays folders below the main part of path.</description>
- </item>
- <item>
- <term>Edit</term>
- <description>A regular edit field for any string or integer.</description>
- </item>
- <item>
- <term>GroupBox</term>
- <description>Displays a rectangle that groups other controls together.</description>
- </item>
- <item>
- <term>Icon</term>
- <description>Displays a static picture of an icon.</description>
- </item>
- <item>
- <term>Line</term>
- <description>Displays a horizontal line.</description>
- </item>
- <item>
- <term>ListBox</term>
- <description>A drop-down list without an edit field.</description>
- </item>
- <item>
- <term>ListView</term>
- <description>Displays a column of values with icons for selection.</description>
- </item>
- <item>
- <term>MaskedEdit</term>
- <description>An edit field with a mask in the text field.</description>
- </item>
- <item>
- <term>PathEdit</term>
- <description>Displays folder name or entire path in an edit field.</description>
- </item>
- <item>
- <term>ProgressBar</term>
- <description>Bar graph that changes length as it receives progress messages.</description>
- </item>
- <item>
- <term>PushButton</term>
- <description>Displays a basic push button.</description>
- </item>
- <item>
- <term>RadioButtonGroup</term>
- <description>A group of radio buttons.</description>
- </item>
- <item>
- <term>ScrollableText</term>
- <description>Displays a long string of text.</description>
- </item>
- <item>
- <term>SelectionTree</term>
- <description>Displays information from the Feature table and enables the user to change their selection state.</description>
- </item>
- <item>
- <term>Text</term>
- <description>Displays static text.</description>
- </item>
- <item>
- <term>VolumeCostList</term>
- <description>Displays costing information on different volumes.</description>
- </item>
- <item>
- <term>VolumeSelectCombo</term>
- <description>Selects volume from an alphabetical list.</description>
- </item>
- </list>
- More information found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp">http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp</a></term>
- <term>True</term>
- </item>
- <item>
- <term>x</term>
- <term>int</term>
- <term>Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</term>
- <term>True</term>
- </item>
- <item>
- <term>y</term>
- <term>int</term>
- <term>Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number.</term>
- <term>True</term>
- </item>
- <item>
- <term>width</term>
- <term>int</term>
- <term>Width of the rectangular boundary of the control. This must be a non-negative number.</term>
- <term>True</term>
- </item>
- <item>
- <term>height</term>
- <term>int</term>
- <term>Height of the rectangular boundary of the control. This must be a non-negative number.</term>
- <term>True</term>
- </item>
- <item>
- <term>attr</term>
- <term>int</term>
- <term>A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/control_attributes.asp">Control Attributes</a>.</term>
- <term>True</term>
- </item>
- <item>
- <term>property</term>
- <term>string</term>
- <term>The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls.</term>
- <term>False</term>
- </item>
- <item>
- <term>text</term>
- <term>string</term>
- <term>A localizable string used to set the initial text contained in a control. The string can also contain embedded properties.</term>
- <term>False</term>
- </item>
- <item>
- <term>nextcontrol</term>
- <term>string</term>
- <term>The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. </term>
- <term>False</term>
- </item>
- <item>
- <term>help</term>
- <term>string</term>
- <term>Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present.</term>
- <term>False</term>
- </item>
- <item>
- <term>remove</term>
- <term>bool</term>
- <term>If <c>true</c>, the control is removed. If <c>false</c>, the control is added.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Remove the Browse button from the customize dialog and add controls for a web dialog</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlConditionsElement">
- <summary>
- <para>
- Used to validate and perform operations as the result of information
- entered by the user into controls on custom dialogs.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>dialog</term>
- <term>string</term>
- <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
- <term>True</term>
- </item>
- <item>
- <term>control</term>
- <term>string</term>
- <term>Refrence to a control. Maps to a control for the specified dialog.</term>
- <term>True</term>
- </item>
- <item>
- <term>action</term>
- <term>string</term>
- <term>The action that is to be taken on the control. The possible actions are shown in the following table.
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>Default</term>
- <description>Set control as the default.</description>
- </item>
- <item>
- <term>Disable</term>
- <description>Disable the control.</description>
- </item>
- <item>
- <term>Enable</term>
- <description>Enable the control.</description>
- </item>
- <item>
- <term>Hide</term>
- <description>Hide the control.</description>
- </item>
- <item>
- <term>Show</term>
- <description>Display the control.</description>
- </item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>condition</term>
- <term>string</term>
- <term>A conditional statement that specifies under which conditions the action should be triggered. If this statement does not evaluate to TRUE, the action does not take place. If it is set to 1, the action is always applied. </term>
- <term>True</term>
- </item>
- <item>
- <term>remove</term>
- <term>bool</term>
- <term>If <c>true</c>, the control condition is removed. If <c>false</c>, the control condition is added.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Remove the control condition for the Browse button from the customize dialog and add control conditions for a web dialog</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerControlEventsElement">
- <summary>
- <para>
- Used to route the flow of the installation process as the result of
- events raised by the user interacting with controls on dialogs.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>dialog</term>
- <term>string</term>
- <term>Refrence to a dialog. Used to associate the control with the dialog.</term>
- <term>True</term>
- </item>
- <item>
- <term>control</term>
- <term>string</term>
- <term>Refrence to a control. Maps to a control for the specified dialog.</term>
- <term>True</term>
- </item>
- <item>
- <term>name</term>
- <term>string</term>
- <term>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 <a href="http://msdn.microsoft.com/library/en-us/msi/setup/controlevent_overview.asp">ControlEvent Overview</a>. <br/>
- 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.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>argument</term>
- <term>string</term>
- <term>A value used as a modifier when triggering a particular event.</term>
- <term>True</term>
- </item>
- <item>
- <term>condition</term>
- <term>string</term>
- <term>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.</term>
- <term>False</term>
- </item>
- <item>
- <term>order</term>
- <term>int</term>
- <term>An integer used to order several events tied to the same control. This must be a non-negative number.</term>
- <term>False</term>
- </item>
- <item>
- <term>remove</term>
- <term>bool</term>
- <term>If <c>true</c>, the control condition is removed. If <c>false</c>, the control condition is added.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog</para>
- <code>
- <!-- Make sure the dialog is put into the execute order -->
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerRegistryElement">
- <summary>
- <para>
- Makes modifications to the Windows Registry of the target computer
- at runtime.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>component</term>
- <term>string</term>
- <term>Refrence to a component. The component that controls the installation of the registry value.</term>
- <term>True</term>
- </item>
- <item>
- <term>root</term>
- <term>msi:MSIRegistryKeyRoot</term>
- <term>Valid input:
- <list type="bullet">
- <item><c>dependent</c> - If this is a per-user installation, the registry value is written under HKEY_CURRENT_USER. If this is a per-machine installation, the registry value is written under HKEY_LOCAL_MACHINE. Note that a per-machine installation is specified by setting the ALLUSERS property to 1.</item>
- <item><c>machine</c> represents HKEY_LOCAL_MACHINE</item>
- <item><c>classes</c> represents HKEY_CLASSES_ROOT</item>
- <item><c>user</c> represents HKEY_CURRENT_USER</item>
- <item><c>users</c> represents HKEY_USERS</item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>path</term>
- <term>string</term>
- <term>Registry key.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><value></h4>
- <ul>
- Specifies the registry value to add to the target machine.
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>The registry value name (localizable). If this is Null, then the data entered into the Value column are
- written to the default registry key. <br/>
- If the Value column is Null, then the strings shown in the following table in the Name column have special
- significance.
- <list type="table">
- <listheader>
- <term>String</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>+</term>
- <description>The key is to be created, if absent, when the component is installed.</description>
- </item>
- <item>
- <term>-</term>
- <description>The key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled.</description>
- </item>
- <item>
- <term>*</term>
- <description>The key is to be created, if absent, when the component is installed. Additionally, the key is to be deleted, if present, with all of its values and subkeys, when the component is uninstalled.</description>
- </item>
- </list>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>value</term>
- <term>string</term>
- <term>The localizable registry value. The field is <a href="http://msdn.microsoft.com/library/en-us/msi/setup/formatted.asp">Formatted</a>. If the value is attached to one of the following prefixes (i.e. #%value) then the value is interpreted as described in the table. Note that each prefix begins with a number sign (#). If the value begins with two or more consecutive number signs (#), the first # is ignored and value is interpreted and stored as a string.
- <list type="table">
- <listheader>
- <term>Prefix</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>#x</term>
- <description>The value is interpreted and stored as a hexadecimal value (REG_BINARY).</description>
- </item>
- <item>
- <term>#%</term>
- <description>The value is interpreted and stored as an expandable string (REG_EXPAND_SZ).</description>
- </item>
- <item>
- <term>#</term>
- <description>The value is interpreted and stored as an integer (REG_DWORD).</description>
- </item>
- </list>
- <list type="bullet">
- <item>If the value contains the sequence tilde [~], then the value is interpreted as a Null-delimited list of strings (REG_MULTI_SZ). For example, to specify a list containing the three strings a, b and c, use "a[~]b[~]c." </item>
- <item>The sequence [~] within the value separates the individual strings and is interpreted and stored as a Null character.</item>
- <item>If a [~] precedes the string list, the strings are to be appended to any existing registry value strings. If an appending string already occurs in the registry value, the original occurrence of the string is removed.</item>
- <item>If a [~] follows the end of the string list, the strings are to be prepended to any existing registry value strings. If a prepending string already occurs in the registry value, the original occurrence of the string is removed.</item>
- <item>If a [~] is at both the beginning and the end or at neither the beginning nor the end of the string list, the strings are to replace any existing registry value strings.</item>
- <item>Otherwise, the value is interpreted and stored as a string (REG_SZ). </item>
- </list>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>dword</term>
- <term>string</term>
- <term>A dword value to input, if the value attribute is null. This removes the requirement of adding "#" before the value.</term>
- <term>False</term>
- </item>
- <item>
- <term>id</term>
- <term>string</term>
- <term>Primary key used to identify a registry record.</term>
- <term>False</term>
- </item>
- </list>
- </ul>
- <h4></value></h4>
- <h3>Examples</h3>
- <example>
- <para>Add the a couple registry entries on the target machine.</para>
- <code>
- <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>
- </code>
- </example>
- <example>
- <para>Add a default key value to the specified registry key path</para>
- <code>
- <registry>
- <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" >
- <value value="1.0.0" />
- </key>
- </registry>
- </code>
- </example>
- <example>
- <para>Another way to add a default key value to the specified registry key path</para>
- <code>
- <registry>
- <key component="C__MainFiles" root="machine" path="SOFTWARE\ACME\My Product\" >
- <value name="" value="1.0.0" />
- </key>
- </registry>
- </code>
- </example>
- <example>
- <para>Specify hexadecimal value (REG_BINARY) for the default key</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerIconsElement">
- <summary>
- <para>
- Stores icons to be used with shortcuts, file extensions, CLSIDs or
- similar uses.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Name of the icon file.</term>
- <term>True</term>
- </item>
- <item>
- <term>value</term>
- <term>string</term>
- <term>The binary icon data in PE (.dll or .exe) or icon (.ico) format.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Add a compiled help icon to the msi database; To be used with a shortcut.</para>
- <code>
- <icons>
- <icon name="CHMICON" value="${resource.dir}\chm.ico" />
- </icons>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerShortcutsElement">
- <summary>
- <para>
- Creates shortcuts on the target computer.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Unique name identifying the shortcut.</term>
- <term>True</term>
- </item>
- <item>
- <term>directory</term>
- <term>string</term>
- <term>Reference to a directory. The location of where the shortcut should be created.</term>
- <term>True</term>
- </item>
- <item>
- <term>filename</term>
- <term>string</term>
- <term>The localizable name of the shortcut to be created.</term>
- <term>True</term>
- </item>
- <item>
- <term>component</term>
- <term>string</term>
- <term>Reference to a component. The installer uses the installation state of this specified component to determine whether the shortcut is created or deleted. This component must have a valid key path for the shortcut to be installed. If the Target column contains the name of a feature, the file launched by the shortcut is the key file of the component listed in this column. </term>
- <term>True</term>
- </item>
- <item>
- <term>target</term>
- <term>string</term>
- <term>The shortcut target. The installer evaluates this field as a Formatted string. The field should contains a property identifier enclosed by square brackets ([ ]), that is expanded into the file or a folder pointed to by the shortcut.</term>
- <term>True</term>
- </item>
- <item>
- <term>arguments</term>
- <term>string</term>
- <term>The command-line arguments for the shortcut. <br/>Note that the resolution of properties in the Arguments field is limited. A property formatted as [Property] in this field can only be resolved if the property already has the intended value when the component owning the shortcut is installed. For example, for the argument "[#MyDoc.doc]" to resolve to the correct value, the same process must be installing the file MyDoc.doc and the component that owns the shortcut.
- </term>
- <term>False</term>
- </item>
- <item>
- <term>hotkey</term>
- <term>string</term>
- <term>The hotkey for the shortcut. The low-order byte contains the virtual-key code for the key, and the high-order byte contains modifier flags. This must be a non-negative number. Authors of installation packages are generally recommend not to set this option, because this can add duplicate hotkeys to a users desktop. In addition, the practice of assigning hotkeys to shortcuts can be problematic for users using hotkeys for accessibility.</term>
- <term>False</term>
- </item>
- <item>
- <term>icon</term>
- <term>string</term>
- <term>Reference to an icon. </term>
- <term>False</term>
- </item>
- <item>
- <term>iconindex</term>
- <term>int</term>
- <term>The icon index for the shortcut. This must be a non-negative number.</term>
- <term>False</term>
- </item>
- <item>
- <term>showcmd</term>
- <term>int</term>
- <term>The Show command for the application window. <br/>The following values may be used. The values are as defined for the Windows API function ShowWindow.
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>1</term>
- <description>SW_SHOWNORMAL</description>
- </item>
- <item>
- <term>3</term>
- <description>SW_SHOWMAXIMIZED</description>
- </item>
- <item>
- <term>7</term>
- <description>SW_SHOWMINNOACTIVE</description>
- </item>
- </list>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>wkdir</term>
- <term>string</term>
- <term>The name of the property that has the path of the working directory for the shortcut.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><description></h4>
- <ul>
- The localizable description of the shortcut.
- </ul>
- <h4></description></h4>
- <h3>Examples</h3>
- <example>
- <para>Add a compiled help icon to the msi database; To be used with a shortcut.</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerBinariesElement">
- <summary>
- <para>
- Stores the binary data for items such as bitmaps, animations, and
- icons. The binary table is also used to store data for custom
- actions.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A unique key that identifies the particular binary data. If the binary data is for a control, the key appears in the Text column of the associated control in the Control table. This key must be unique among all controls requiring binary data.</term>
- <term>True</term>
- </item>
- <item>
- <term>value</term>
- <term>string</term>
- <term>The binary file to add.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Add the custom action dll to create/modify virtual directories</para>
- <code>
- <binaries>
- <binary name="MSVBDPCADLL" value="${resource.dir}\MSVBDPCA.DLL" />
- </binaries>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerCustomActionsElement">
- <summary>
- <para>
- 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.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>action</term>
- <term>string</term>
- <term>Name of the action. The action normally appears in a sequence table unless it is called by another custom action. If the name matches any built-in action, then the custom action is never called. </term>
- <term>True</term>
- </item>
- <item>
- <term>type</term>
- <term>string</term>
- <term>A field of flag bits specifying the basic type of custom action and options. See <a href="http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp">Summary List of All Custom Action Types</a> for a list of the basic types. See <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_return_processing_options.asp">Custom Action Return Processing Options</a>, <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_execution_scheduling_options.asp">Custom Action Execution Scheduling Options</a>, <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_hidden_target_option.asp">Custom Action Hidden Target Option</a>, and <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_in_script_execution_options.asp">Custom Action In-Script Execution Options</a>. </term>
- <term>True</term>
- </item>
- <item>
- <term>source</term>
- <term>string</term>
- <term>A property name or external key into another table. For a discussion of the possible custom action sources, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/custom_action_sources.asp">Custom Action Sources</a> and the <a href="http://msdn.microsoft.com/library/en-us/msi/setup/summary_list_of_all_custom_action_types.asp">Summary List of All Custom Action Types</a>. For example, the Source column may contain an external key into the first column of one of the following tables containing the source of the custom action code. <br/>
- Directory table for calling existing executables.<br/>
- File table for calling executables and DLLs that have just been installed.<br/>
- Binary table for calling executables, DLLs, and data stored in the database.<br/>
- Property table for calling executables whose paths are held by a property.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>target</term>
- <term>string</term>
- <term>An execution parameter that depends on the basic type of custom action. See the Summary List of All Custom Action Types for a description of what should be entered in this field for each type of custom action. For example, this field may contain the following depending on the custom action.
- <list type="table">
- <listheader>
- <term>Target</term>
- <term>Custom Action</term>
- </listheader>
- <item>
- <term>Entry point (required)</term>
- <term>Calling a DLL.</term>
- </item>
- <item>
- <term>Executable name with arguments (required)</term>
- <term>Calling an existing executable.</term>
- </item>
- <item>
- <term>Command line arguments (optional)</term>
- <term>Calling an executable just installed.</term>
- </item>
- <item>
- <term>Target file name (required)</term>
- <term>Creating a file from custom data.</term>
- </item>
- <item>
- <term>Null</term>
- <term>Executing script code.</term>
- </item>
- </list>
- </term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Add some custom actions related to the virtual directory dialog and custom action.</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerSequencesElement">
- <summary>
- <para>
- Used to modify the sequence of tasks/events that execute during the
- overall installation process.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>type</term>
- <term>msi:MSISequenceTable</term>
- <term>Valid inputs:
- <list type="bullet">
- <item><c>installexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/installexecutesequence_table.asp">InstallExecuteSequence Table</a>.</item>
- <item><c>installui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/installuisequence_table.asp">InstallUISequence Table</a></item>
- <item><c>adminexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/adminexecutesequence_table.asp">AdminExecuteSequence Table</a></item>
- <item><c>adminui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/adminuisequence_table.asp">AdminUISequence Table</a></item>
- <item><c>advtexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/advtuisequence_table.asp">AdvtUISequence Table</a></item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>action</term>
- <term>string</term>
- <term>Name of the action to execute. This is either a built-in action or a custom action.</term>
- <term>True</term>
- </item>
- <item>
- <term>value</term>
- <term>int</term>
- <term>Number that determines the sequence position in which this action is to be executed. <br/>
- 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.
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>-1</term>
- <description>Successful completion.</description>
- </item>
- <item>
- <term>-2</term>
- <description>User terminates install.</description>
- </item>
- <item>
- <term>-3</term>
- <description>Fatal exit terminates.</description>
- </item>
- <item>
- <term>-4</term>
- <description>Install is suspended.</description>
- </item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>condition</term>
- <term>string</term>
- <term>This field contains a conditional expression. If the expression evaluates to False, then the action is skipped. If the expression syntax is invalid, then the sequence terminates, returning iesBadActionData. </term>
- <term>False</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Add the sequences to support virtual directories</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerActionTextElement">
- <summary>
- <para>
- 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.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Unique name identifying the action.</term>
- <term>True</term>
- </item>
- <item>
- <term>template</term>
- <term>string</term>
- <term>A localized format template is used to format action data records for display during action execution. If no template is supplied, then the action data will not be displayed.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><description></h4>
- <ul>
- Localized description displayed in the progress dialog box or written to the log when the action is executing.
- </ul>
- <h4></description></h4>
- <h3>Examples</h3>
- <example>
- <para>Add the related action text for the web folder actions.</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerAppMappingsElement">
- <summary>
- <para>
- Adds Verbs and a handler for the specified file type.
- </para>
- <note>This not an officially Microsoft supported table.</note>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>directory</term>
- <term>string</term>
- <term>Refrence to a directory. The directory to add the specific verb/handler to IIS for the specified file type.</term>
- <term>True</term>
- </item>
- <item>
- <term>extension</term>
- <term>string</term>
- <term>File name extension to specifically handle</term>
- <term>False</term>
- </item>
- <item>
- <term>exepath</term>
- <term>string</term>
- <term>Path to the Internet Server API (ISAPI) or Common Gateway Interface (CGI) program to run to process a request.</term>
- <term>False</term>
- </item>
- <item>
- <term>verbs</term>
- <term>string</term>
- <term>Internet Information Services verbs that are allowed for the executable file. Only verbs entered in this field will be allowed.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Add the aspx app mapping</para>
- <code>
- <appmappings>
- <appmapping directory="D__ACME_MyProduct" extension=".aspx" exepath="[DOTNETFOLDER]aspnet_isapi.dll" verbs="GET,HEAD,POST,DEBUG" />
- </appmappings>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerUrlPropertiesElement">
- <summary>
- <para>
- Determines the local path equivalent for a url and stores this
- information in a property.
- </para>
- <note>This not an officially Microsoft supported table.</note>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>The name of the URLProperty to convert</term>
- <term>True</term>
- </item>
- <item>
- <term>property</term>
- <term>string</term>
- <term>The name of the property to store the directory information.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Convert the TARGETURL property to a directory and store that information in TARGETDIR</para>
- <code>
- <urlproperties>
- <urlproperty name="TARGETURL" property="TARGETDIR" />
- </urlproperties>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerVDirPropertiesElement">
- <summary>
- <para>
- Creates a URLProperty representing the virtual directory and port.
- </para>
- <note>This not an officially Microsoft supported table.</note>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Property containing the virtual directory</term>
- <term>True</term>
- </item>
- <item>
- <term>portproperty</term>
- <term>string</term>
- <term>Property containing the network port number to use.</term>
- <term>True</term>
- </item>
- <item>
- <term>urlproperty</term>
- <term>string</term>
- <term>URLProperty to store the url in</term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Convert the virtual directory and port to a url and store the value in a property.</para>
- <code>
- <vdirproperties>
- <vdirproperty name="TARGETVDIR" portproperty="TARGETPORT" urlproperty="TARGETURL" />
- </vdirproperties>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerAppRootsElement">
- <summary>
- <para>
- 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.
- </para>
- <note>This not an officially Microsoft supported table.</note>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>component</term>
- <term>string</term>
- <term>Reference to a component. Determines when the approot will be created.</term>
- <term>True</term>
- </item>
- <item>
- <term>urlproperty</term>
- <term>string</term>
- <term>URLProperty with stored url</term>
- <term>True</term>
- </item>
- <item>
- <term>inprocflag</term>
- <term>int</term>
- <term>Specifies whether the application being created is to run in-process (0), out-of-process (1), or in a pooled process (2). If the application already exists and is running, changing the value of this flag will cause the application definition to be deleted and a new application created to run in the specified process space.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Convert the virtual directory and port to a url and store the value in a property.</para>
- <code>
- <approots>
- <approot component="C__MainFiles" urlproperty="TARGETURL" inprocflag="2" />
- </approots>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.InstallerTaskBase.InstallerIISPropertiesElement">
- <summary>
- <para>
- Specifies directory security in IIS. Can also configure the default
- documents supported by each directory.
- </para>
- <note>This not an officially Microsoft supported table.</note>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>directory</term>
- <term>string</term>
- <term>Reference to a directory. This is the directory that gets modified with the specific attributes.</term>
- <term>True</term>
- </item>
- <item>
- <term>attr</term>
- <term>int</term>
- <term>Attributes to set for the directory.
- <list type="table">
- <listheader>
- <term>Value</term>
- <term>Flag Name</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>1</term>
- <term>AccessRead</term>
- <description>The file or the contents of the folder may be read through Microsoft Internet Explorer.</description>
- </item>
- <item>
- <term>2</term>
- <term>AccessWrite</term>
- <description>Users are allowed to upload files and their associated properties to the enabled directory on your server or to change content in a Write-enabled file. Write can be implemented only with a browser that supports the PUT feature of the HTTP 1.1 protocol standard.</description>
- </item>
- <item>
- <term>4</term>
- <term>AccessExecute</term>
- <description>The file or the contents of the folder may be executed, regardless of file type.</description>
- </item>
- <item>
- <term>8</term>
- <term>AccessSSL</term>
- <description>File access requires SSL file permission processing, with or without a client certificate.</description>
- </item>
- <item>
- <term>16</term>
- <term>AccessSource</term>
- <description>Users are allowed to access source code if either Read or Write permissions are set. Source code includes scripts in Microsoft ® Active Server Pages (ASP) applications.</description>
- </item>
- <item>
- <term>32</term>
- <term>AccessSSLNegotiateCert</term>
- <description>SSL file access processing requests a certificate from the client. A value of false indicates that access continues if the client does not have a certificate. Some versions of Internet Explorer will close the connection if the server requests a certificate and a certificate is not available (even if AccessSSLRequireCert is also set to true).</description>
- </item>
- <item>
- <term>64</term>
- <term>AccessSSLRequireCert</term>
- <description>SSL file access processing requests a certificate from the client. If the client provides no certificate, the connection is closed. AccessSSLNegotiateCert must also be set to true when using AccessSSLRequireCert.</description>
- </item>
- <item>
- <term>128</term>
- <term>AccessSSLMapCert</term>
- <description>SSL file permission processing maps a client certificate to a Microsoft Windows ® operating system user-account. The AccessSSLNegotiateCert property must also be set to true for the mapping to occur.</description>
- </item>
- <item>
- <term>256</term>
- <term>AccessSSL128</term>
- <description>File access requires SSL file permission processing with a minimum key size of 128 bits, with or without a client certificate.</description>
- </item>
- <item>
- <term>512</term>
- <term>AccessScript</term>
- <description>The file or the contents of the folder may be executed if they are script files or static content. A value of false only allows static files, such as HTML files, to be served.</description>
- </item>
- <item>
- <term>1024</term>
- <term>AccessNoRemoteWrite</term>
- <description>Remote requests to create or change files are denied; only requests from the same computer as the IIS server succeed if the AccessWrite property is set to true. You cannot set AccessNoRemoteWrite to false to enable remote requests, and set AccessWrite to false to disable local requests.</description>
- </item>
- <item>
- <term>4096</term>
- <term>AccessNoRemoteRead</term>
- <description>Remote requests to view files are denied; only requests from the same computer as the IIS server succeed if the AccessRead property is set to true. You cannot set AccessNoRemoteRead to false to enable remote requests, and set AccessRead to false to disable local requests.</description>
- </item>
- <item>
- <term>8192</term>
- <term>AccessNoRemoteExecute</term>
- <description>Remote requests to execute applications are denied; only requests from the same computer as the IIS server succeed if the AccessExecute property is set to true. You cannot set AccessNoRemoteExecute to false to enable remote requests, and set AccessExecute to false to disable local requests.</description>
- </item>
- <item>
- <term>16384</term>
- <term>AccessNoRemoteScript</term>
- <description>Requests to view dynamic content are denied; only requests from the same computer as the IIS server succeed if the AccessScript property is set to true. You cannot set AccessNoRemoteScript to false to enable remote requests, and set AccessScript to false to disable local requests.</description>
- </item>
- <item>
- <term>32768</term>
- <term>AccessNoPhysicalDir</term>
- <description>Access to the physical path is not allowed.</description>
- </item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>defaultdoc</term>
- <term>string</term>
- <term>Adds a filename to the <a href="http://msdn.microsoft.com/library/en-us/iissdk/iis/ref_mb_defaultdoc.asp">Default Documents</a> to process. Add multiple separated with a comma (Eg. "Default.aspx,Default.htm")</term>
- <term>False</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Specify permissions for the directory structure.</para>
- <code>
- <iisproperties>
- <iisproperty directory="TARGETDIR" attr="626" defaultdoc="Default.aspx" />
- <iisproperty directory="D__BIN" attr="112" />
- <iisproperty directory="D__SomeSubDir" attr="114" />
- </iisproperties>
- </code>
- </example>
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.MsiCreationCommand">
- <summary>
- Summary description for MsiTaskInfo.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadBannerImage(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads the banner image.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadBackgroundImage(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads the background image.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadLicense(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads the license file.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadMedia(NAnt.Contrib.Tasks.Msi.InstallerDatabase,System.Int32)">
- <summary>
- Loads records for the Media table.
- </summary>
- <param name="database">The MSI database.</param>
- <param name="LastSequence">The sequence number of the last file in the .cab.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadFeatures(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the Features table.
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.AddFeature(NAnt.Contrib.Tasks.Msi.InstallerTable,NAnt.Contrib.Tasks.Msi.InstallerTable,System.String,NAnt.Contrib.Tasks.Msi.InstallerDatabase,NAnt.Contrib.Schemas.Msi.MSIFeature,System.Int32,System.Int32)">
- <summary>
- Adds a feature record to the Features table.
- </summary>
- <param name="featureTable">The MSI database Feature table.</param>
- <param name="conditionTable">The MSI database Condition table.</param>
- <param name="ParentFeature">The name of this feature's parent.</param>
- <param name="database">The MSI database.</param>
- <param name="Feature">This Feature's Schema element.</param>
- <param name="Depth">The tree depth of this feature.</param>
- <param name="Order">The tree order of this feature.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadLaunchCondition(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the LaunchCondition table
- </summary>
- <param name="database">The MSI database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiCreationCommand.LoadMergeModules(System.String,System.String)">
- <summary>
- Merges Merge Modules into the MSI Database.
- </summary>
- <param name="Database">The MSI Database.</param>
- <param name="TempPath">The path to temporary files.</param>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.MsiTask">
- <summary>
- Creates a Windows Installer (also known as Microsoft Installer, or MSI) setup database for installing software on the Windows Platform.
- </summary>
- <remarks>
- <para>
- Requires <c>cabarc.exe</c> in the path. This tool is part of the
- <see href="http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">Microsoft Cabinet SDK</see>.
- </para>
- <para>
- Requires <c>mergemod.dll</c> version 2.0 or greater. This dll is part of the
- <see href="http://www.microsoft.com/msdownload/platformsdk/instmsi.htm">Microsoft Platform SDK</see>.
- </para>
- <para>
- See the <see href="http://msdn.microsoft.com/library/en-us/msi/setup/roadmap_to_windows_installer_documentation.asp?frame=true" >Roadmap to Windows Installer Documentation</see>
- at Microsoft's MSDN website for more information.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and verifies parameters.
- </summary>
- <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsiTask.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiLicense">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiBanner">
- <summary>
- A .bmp (bitmap) file 495x60 pixels in size that will be displayed
- as the banner (top) image of the installation user interface.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiBackground">
- <summary>
- A .bmp (bitmap) file 495x315 pixels in size that will be displayed
- as the background image of the installation user interface.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiFeaturesElement">
- <summary>
- <para>
- 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.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>A name used to refer to the feature.</term>
- <term>True</term>
- </item>
- <item>
- <term>display</term>
- <term>int</term>
- <term>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.<br/>
- 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.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>title</term>
- <term>string</term>
- <term>Short string of text identifying the feature. This string is listed as an item by the SelectionTree control of the Selection Dialog.</term>
- <term>False</term>
- </item>
- <item>
- <term>typical</term>
- <term>bool</term>
- <term>Determines if the feature should be included in a "typical" install. This is useful for when the user selects to just install the typical features.</term>
- <term>False</term>
- </item>
- <item>
- <term>directory</term>
- <term>string</term>
- <term>Refrence to a directory. Specify a corresponding directory to go with the feature.</term>
- <term>False</term>
- </item>
- <item>
- <term>attr</term>
- <term>int</term>
- <term>Any combination of the following:
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>0</term>
- <description>Components of this feature that are not marked for installation from source are installed locally.</description>
- </item>
- <item>
- <term>1</term>
- <description>Components of this feature not marked for local installation are installed to run from the source CD-ROM or server.</description>
- </item>
- <item>
- <term>2</term>
- <description>Set this attribute and the state of the feature is the same as the state of the feature's parent.</description>
- </item>
- <item>
- <term>4</term>
- <description>Set this attribute and the feature state is Advertise.</description>
- </item>
- <item>
- <term>8</term>
- <description>Note that this bit works only with features that are listed by the ADVERTISE property. <br/>Set this attribute to prevent the feature from being advertised.</description>
- </item>
- <item>
- <term>16</term>
- <description>Set this attribute and the user interface does not display an option to change the feature state to Absent. Setting this attribute forces the feature to the installation state, whether or not the feature is visible in the UI.</description>
- </item>
- <item>
- <term>32</term>
- <description>Set this attribute and advertising is disabled for the feature if the operating system shell does not support Windows Installer descriptors.</description>
- </item>
- </list>
- More information found here: <a href="http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp">http://msdn.microsoft.com/library/en-us/msi/setup/feature_table.asp</a>
- </term>
- <term>False</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><feature></h4>
- <ul>
- Nested feature elements are supported.
- </ul>
- <h4></feature></h4>
- <h4><description></h4>
- <ul>
- Longer string of text describing the feature. This localizable string is displayed by the Text control of the Selection Dialog.
- </ul>
- <h4></description></h4>
- <h4><conditions></h4>
- <ul>
- <h4><condition></h4>
- <ul>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>expression</term>
- <term>string</term>
- <term>If this conditional expression evaluates to TRUE, then the Level column in the Feature table is set to the
- conditional install level. <br/>
- 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.<br/>
- For information on the syntax of conditional statements, see <a href="http://msdn.microsoft.com/library/en-us/msi/setup/conditional_statement_syntax.asp">Conditional Statement Syntax</a>.
- </term>
- <term>True</term>
- </item>
- <item>
- <term>level</term>
- <term>int</term>
- <term>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.<br/>
- 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.<br/>
- 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.</term>
- <term>True</term>
- </item>
- </list>
- </ul>
- <h4></condition></h4>
- </ul>
- <h4></conditions></h4>
- <h3>Examples</h3>
- <example>
- <para>Define a sample features structure.</para>
- <code>
- <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>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsiTask.MsiMergeModulesElement">
- <summary>
- <para>
- 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 <see cref="T:NAnt.Contrib.Tasks.Msi.MsmTask"/>.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>feature</term>
- <term>string</term>
- <term>Refrence to a feature. Used to associate the merge module with the feature (and the feature's directory) for when to install the components in the merge module.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Nested Elements:</h3>
- <h4><modules></h4>
- <ul>
- Specifies the merge module(s) to include with the specified feature.
- </ul>
- <h4></modules></h4>
- <h4><configurationitems></h4>
- <ul>
- <h4><configurationitem></h4>
- <ul>
- Specifies the value for a configurable item
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>module</term>
- <term>string</term>
- <term>Merge module filename to limit the configuration item to. If this is not set, the configuration item will be applied to all merge modules in the fileset.</term>
- <term>True</term>
- </item>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Name of item for which data is to be set</term>
- <term>True</term>
- </item>
- <item>
- <term>value</term>
- <term>string</term>
- <term>Value of the configurable item</term>
- <term>True</term>
- </item>
- </list>
- </ul>
- <h4></configurationitem></h4>
- </ul>
- <h4></configurationitems></h4>
- <h3>Examples</h3>
- <example>
- <para>Add the NAnt merge module to the install.</para>
- <code>
- <mergemodules>
- <merge feature="F__NAntMSM">
- <modules>
- <include name="${nant.dir}\Install\NAnt.msm" />
- </modules>
- </merge>
- </mergemodules>
- </code>
- </example>
- <example>
- <para>Add a Visual Studio .wid package (merge module) and specify some configurable items.</para>
- <code>
- <mergemodules>
- <merge feature="F__DefaultFeature">
- <modules>
- <include name="VsdReadmeDlg.wid" />
- </modules>
- <configurationitems>
- <configurationitem name="BannerBitmap" value="CONFIGURED_BANNERBITMAP" />
- <configurationitem module="VsdReadmeDlg.wid" name="ReadmeText" value="CONFIGURED_READMETEXT" />
- </configurationitems>
- </merge>
- </mergemodules>
- </code>
- </example>
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.MsmCreationCommand">
- <summary>
- Summary description for MsmTaskInfo.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSignature(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ModuleSignature table.
- </summary>
- <param name="database">The MSM database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleDependency(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ModuleDependency table.
- </summary>
- <param name="database">The MSM database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleExclusion(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ModuleExclusion table.
- </summary>
- <param name="database">The MSM database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSequence(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ModuleInstallUISequence, ModuleInstallExecuteSequence,
- ModuleAdminUISequence, ModuleAdminExecute, and ModuleAdvtExecuteSequence tables.
- </summary>
- <param name="database">The MSM database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleIgnoreTable(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ModuleIgnoreTable table.
- </summary>
- <param name="database">The MSM database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleSubstitution(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ModuleSubstitution table.
- </summary>
- <param name="database">The MSM database.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmCreationCommand.LoadModuleConfiguration(NAnt.Contrib.Tasks.Msi.InstallerDatabase)">
- <summary>
- Loads records for the ModuleConfiguration table.
- </summary>
- <param name="database">The MSM database.</param>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.MsmTask">
- <summary>
- Builds a Windows Installer Merge Module (MSM) database.
- </summary>
- <para>
- Requires <c>cabarc.exe</c> in the path. This tool is part of the
- <see href="http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">http://msdn.microsoft.com/library/en-us/dncabsdk/html/cabdl.asp">Microsoft Cabinet SDK</see>.
- </para>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and verifies parameters.
- </summary>
- <param name="TaskNode">Node that contains the XML fragment used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.MsmTask.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmId">
- <summary>
- Stores a unique identifier for a merge module. To be used as the merge module's ModuleSignature
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmLanguage">
- <summary>
- Specifies the numeric language ID or IDs for a merge module.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmVersion">
- <summary>
- Stores the version number of a merge module.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleDependenciesElement">
- <summary>
- <para>
- Lists other merge modules that are required for this merge module
- to operate properly.
- </para>
- <para>
- Contains any number of dependency elements.
- </para>
- <para>
- More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduledependency_table.asp">here</see>.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>id</term>
- <term>string</term>
- <term>Identifier of the merge module required</term>
- <term>True</term>
- </item>
- <item>
- <term>language</term>
- <term>string</term>
- <term>Numeric language ID of the dependent merge module. Can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. If the field contains a group language ID, any merge module with having a language code in that group satisfies the dependency. If the RequiredLanguage is set to 0, any merge module filling the other requirements satisfies the dependency.</term>
- <term>True</term>
- </item>
- <item>
- <term>version</term>
- <term>string</term>
- <term>Version of the dependent merge module. If ommited, any version fills the dependency.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Make sure that the NAnt merge module is included</para>
- <code>
- <moduledependencies>
- <dependency id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" />
- </moduledependencies>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleExclusionsElement">
- <summary>
- <para>
- Lists other merge modules that are incompatible in the same
- installer database.
- </para>
- <para>
- Contains any number of exclusion elements.
- </para>
- <para>
- More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleexclusion_table.asp">here</see>.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>id</term>
- <term>string</term>
- <term>Identifier of the merge module required</term>
- <term>True</term>
- </item>
- <item>
- <term>language</term>
- <term>string</term>
- <term>Numeric language ID of the merge module in ExcludedID. The ExcludedLanguage column can specify the language ID for a single language, such as 1033 for U.S. English, or specify the language ID for a language group, such as 9 for any English. The ExcludedLanguage column can accept negative language IDs. The meaning of the value in the ExcludedLanguage column is as follows.
- <list type="table">
- <listheader>
- <term>ExcludedLanguage</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>> 0</term>
- <description>Exclude the language IDs specified by ExcludedLanguage.</description>
- </item>
- <item>
- <term>= 0</term>
- <description>Exclude no language IDs.</description>
- </item>
- <item>
- <term>< 0</term>
- <description>Exclude all language IDs except those specified by ExcludedLanguage.</description>
- </item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>minversion</term>
- <term>string</term>
- <term>Minimum version excluded from a range. If ommitted, all versions before maxversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version.</term>
- <term>False</term>
- </item>
- <item>
- <term>maxversion</term>
- <term>string</term>
- <term>Maximum version excluded from a range. If ommitted, all versions after minversion are excluded. If both minversion and maxversion are ommitted there is no exclusion based on version.</term>
- <term>False</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Exclude the all NAnt merge modules created before version 0.85.0</para>
- <code>
- <moduleexclusions>
- <exclusion id="NAnt_MergeModule.2D2FB50C_DADF_4813_8932_8EF1E8CB8E80" language="0" maxversion="0.85.0" />
- </moduleexclusions>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleSequencesElement">
- <summary>
- <para>
- Used to modify the sequence of tasks/events that execute during the
- overall installation process.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>type</term>
- <term>msi:MSISequenceTable</term>
- <term>Valid inputs:
- <list type="bullet">
- <item><c>installexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleinstallexecutesequence_table.asp">ModuleInstallExecuteSequence Table</a>.</item>
- <item><c>installui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleinstalluisequence_table.asp">ModuleInstallUISequence Table</a></item>
- <item><c>adminexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadminexecutesequence_table.asp">ModuleAdminExecuteSequence Table</a></item>
- <item><c>adminui</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadminuisequence_table.asp">ModuleAdminUISequence Table</a></item>
- <item><c>advtexecute</c> represents <a href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleadvtuisequence_table.asp">ModuleAdvtUISequence Table</a></item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>action</term>
- <term>string</term>
- <term>Action to insert into sequence. Refers to one of the installer standard actions, or an entry in the merge module's CustomAction table or Dialog table.<br/>If a standard action is used in the Action column of a merge module sequence table, the BaseAction and After attributes must be ommitted.</term>
- <term>True</term>
- </item>
- <item>
- <term>sequence</term>
- <term>int</term>
- <term>The sequence number of a standard action. If a custom action or dialog is entered into the Action column of this row, this attribute must be ommitted <br/>When using standard actions in merge module sequence tables, the value in the Sequence column should be the recommended action sequence number. If the sequence number in the merge module differs from that for the same action in the .msi file sequence table, the merge tool uses the sequence number from the .msi file. See the suggested sequences in Using a Sequence Table for the recommended sequence numbers of standard actions.</term>
- <term>False</term>
- </item>
- <item>
- <term>baseaction</term>
- <term>string</term>
- <term>Can contain a standard action, a custom action specified in the merge module's custom action table, or a dialog specified in the module's dialog table. Is a key into the Action column of this table. It cannot be a foreign key into another merge table or table in the .msi file. This means that every standard action, custom action, or dialog listed in the BaseAction column must also be listed in the Action column of another record in this table.</term>
- <term>False</term>
- </item>
- <item>
- <term>after</term>
- <term>bool</term>
- <term>Boolean for whether Action comes before or after BaseAction
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>True</term>
- <description>Action to come after BaseAction</description>
- </item>
- <item>
- <term>False</term>
- <description>Action to come before BaseAction</description>
- </item>
- </list>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>condition</term>
- <term>string</term>
- <term>A conditional statement that indicates if the action is be executed.</term>
- <term>False</term>
- </item>
- </list>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleIgnoreTablesElement">
- <summary>
- <para>
- 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.
- </para>
- <para>
- More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleignoretable_table.asp?frame=true">here</see>.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>table</term>
- <term>string</term>
- <term>Name of the table in the merge module that is not to be merged into the .msi file.</term>
- <term>True</term>
- </item>
- </list>
- <h3>Examples</h3>
- <example>
- <para>Ensure the module is compatible for users who have versions of Mergemod.dll earlier than 2.0</para>
- <code>
- <moduleignoretables>
- <table name="ModuleConfiguration" />
- <table name="ModuleSubstitution" />
- <table name="_ModuleConfigurationGroup" />
- </moduleignoretables>
- </code>
- </example>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleSubstitutionsElement">
- <summary>
- <para>
- 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.
- </para>
- <para>
- More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/modulesubstitution_table.asp">here</see>.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>table</term>
- <term>string</term>
- <term>Name of the table being modified in the module database.</term>
- <term>True</term>
- </item>
- <item>
- <term>row</term>
- <term>string</term>
- <term>Specifies the primary keys of the target row in the table named in the Table column. Multiple primary keys are separated by semicolons. Target rows are selected for modification before any changes are made to the target table. If one record in the ModuleSubstitution table changes the primary key field of a target row, other records in the ModuleSubstitution table are applied based on the original primary key data, not the resulting of primary key substitutions. The order of row substitution is undefined.<br/>Values in this column are always in CMSM special format. A literal semicolon (';') or equal sign ('=') can be added by prefixing the character with a backslash. '\'. A null value for a key is signified by a null, a leading semicolon, two consecutive semicolons, or a trailing semicolon, depending on whether the null value is a sole, first, middle, or final key column value.</term>
- <term>True</term>
- </item>
- <item>
- <term>column</term>
- <term>string</term>
- <term>Specifies the target column in the row named in the Row column. If multiple rows in the ModuleSubstitution table change different columns of the same target row, all the column substitutions are performed before the modified row is inserted into the database. The order of column substitution is undefined.</term>
- <term>True</term>
- </item>
- <item>
- <term>value</term>
- <term>string</term>
- <term>Contains a string that provides a formatting template for the data being substituted into the target field specified by Table, Row, and Column. When a substitution string of the form [=ItemA] is encountered, the string, including the bracket characters, is replaced by the value for the configurable "ItemA." The configurable item "ItemA" is specified in the Name column of the ModuleConfiguration table and its value is provided by the merge tool. If the merge tool declines to provide a value for any item in a replacement string, the default value specified in the DefaultValue column of the ModuleConfiguration Table is substituted. If a string references an item not in the ModuleConfiguration table, the merge fails.
- <list type="bullet">
- <item>
- 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. '\'.
- </item>
- <item>
- 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."
- </item>
- <item>
- Replacement strings must not be nested. The template "[=AB[=CDE]]" is invalid.
- </item>
- <item>
- 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.
- </item>
- <item>
- 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.
- </item>
- <item>
- 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.
- </item>
- <item>
- 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.
- </item>
- <item>
- 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.
- </item>
- <item>
- 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.
- </item>
- <item>
- 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.
- </item>
- </list>
- </term>
- <term>False</term>
- </item>
- </list>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.MsmTask.MsmModuleConfigurationsElement">
- <summary>
- <para>
- Identifies the configurable attributes of the module. This table is
- not merged into the database.
- </para>
- <para>
- More information is available <see href="http://msdn.microsoft.com/library/en-us/msi/setup/moduleconfiguration_table.asp">here</see>.
- </para>
- <h3>Parameters</h3>
- <list type="table">
- <listheader>
- <term>Attribute</term>
- <term>Type</term>
- <term>Description</term>
- <term>Required</term>
- </listheader>
- <item>
- <term>name</term>
- <term>string</term>
- <term>Name of the configurable item. This name is referenced in the formatting template in the Value column of the ModuleSubstitution table.</term>
- <term>True</term>
- </item>
- <item>
- <term>format</term>
- <term>msi:MSMModuleConfigurationFormat</term>
- <term>Specifies the format of the data being changed
- <list type="bullet">
- <item>text</item>
- <item>key</item>
- <item>integer</item>
- <item>bitfield</item>
- </list>
- </term>
- <term>True</term>
- </item>
- <item>
- <term>type</term>
- <term>string</term>
- <term>Specifies the type for the data being changed. This type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this depend on the value in the Format attribute.</term>
- <term>False</term>
- </item>
- <item>
- <term>contextdata</term>
- <term>string</term>
- <term>Specifies a semantic context for the requested data. The type is used to provide a context for any user-interface and is not used in the merge process. The valid values for this column depend on the values in the Format and Type attributes.</term>
- <term>False</term>
- </item>
- <item>
- <term>defaultvalue</term>
- <term>string</term>
- <term>Specifies a default value for the item in this record if the merge tool declines to provide a value. This value must have the format, type, and context of the item. If this is a "Key" format item, the foreign key must be a valid key into the tables of the module. Null may be a valid value for this column depending on the item. For "Key" format items, this value is in CMSM special format. For all other types, the value is treated literally.<br/>Module authors must ensure that the module is valid in its default state. This ensures that versions of Mergemod.dll earlier than version 2.0 can still use the module in its default state.</term>
- <term>False</term>
- </item>
- <item>
- <term>attr</term>
- <term>int</term>
- <term>Bit field containing attributes for this configurable item. Null is equivalent to 0.
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>1</term>
- <description>This attribute only applies to records that list a foreign key to a module table in their DefaultValue field.</description>
- </item>
- <item>
- <term>2</term>
- <description>When this attribute is set, null is not a valid response for this item. This attribute has no effect for Integer Format Types or Bitfield Format Types.</description>
- </item>
- </list>
- </term>
- <term>False</term>
- </item>
- <item>
- <term>displayname</term>
- <term>string</term>
- <term>Provides a short description of this item that the authoring tool may use in the user interface. This column may not be localized. Set this column to null to have the module is request that the authoring tool not expose this property in the UI.</term>
- <term>False</term>
- </item>
- <item>
- <term>description</term>
- <term>string</term>
- <term>Provides a description of this item that the authoring tool may use in UI elements. This string may be localized by the module's language transform.</term>
- <term>False</term>
- </item>
- <item>
- <term>helplocation</term>
- <term>string</term>
- <term>Provides either the name of a help file (without the .chm extension) or a semicolon delimited list of help namespaces. This can be ommitted if no help is available.</term>
- <term>False</term>
- </item>
- <item>
- <term>helpkeyword</term>
- <term>string</term>
- <term>Provides a keyword into the help file or namespace from the HelpLocation column. The interpretation of this keyword depends on the HelpLocation attribute.</term>
- <term>False</term>
- </item>
- </list>
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Msi.TypeLibRecord">
- <summary>
- Maintains a forward reference to a .tlb file
- in the same directory as an assembly .dll
- that has been registered for COM interop.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Msi.TypeLibRecord.#ctor(System.String,System.String,System.Reflection.AssemblyName,System.String,System.String)">
- <summary>
- Creates a new <see cref="T:NAnt.Contrib.Tasks.Msi.TypeLibRecord"/>.
- </summary>
- <param name="LibId">The typelibrary id.</param>
- <param name="TypeLibFileName">The typelibrary filename.</param>
- <param name="AssemblyName">The name of the assembly.</param>
- <param name="FeatureName">The feature containing the typelibrary's file.</param>
- <param name="AssemblyComponent">The name of the Assembly's component.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.AssemblyComponent">
- <summary>
- Retrieves the name of the Assembly's component.
- </summary>
- <value>The Assembly's component Name.</value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.TypeLibFileName">
- <summary>
- Retrieves the typelibrary filename.
- </summary>
- <value>The typelibrary filename.</value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.LibId">
- <summary>
- Retrieves the typelibrary id.
- </summary>
- <value>The typelibrary id.</value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.AssemblyName">
- <summary>
- Retrieves the name of the assembly.
- </summary>
- <value>The name of the assembly.</value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Msi.TypeLibRecord.FeatureName">
- <summary>
- Retrieves the feature containing the typelibrary's file.
- </summary>
- <value>The feature containing the typelibrary's file.</value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask">
- <summary>
- A task that generates a summary HTML
- from a set of NUnit xml report files.
- </summary>
- <remarks>
- <para>
- This task can generate a combined HTML report out of a set of NUnit
- result files generated using the XML Result Formatter.
- </para>
- <para>
- 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.
- </para>
- </remarks>
- <example>
- <code>
- <![CDATA[
- <nunit2report todir="${outputdir}">
- <fileset>
- <includes name="${outputdir}\results.xml" />
- </fileset>
- </nunit2report>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.ExecuteTask">
- <summary>
- This is where the work is done
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LoadStyleSheet(System.String)">
- <summary>
- Load a stylesheet from the assemblies resource stream.
- </summary>
- <param name="xslFileName">File name of the file to extract.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LoadStyleSheet(System.IO.FileInfo)">
- <summary>
- Load a stylesheet from the file system.
- </summary>
- <param name="xslFile">The XSLT file to load.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.CreateSummaryXmlDoc">
- <summary>
- Initializes the XmlDocument instance
- used to summarize the test results
- </summary>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.GetPropertyList">
- <summary>
- Builds an XsltArgumentList with all
- the properties defined in the
- current project as XSLT parameters.
- </summary>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Write(System.IO.StringReader,System.String)">
- <summary>
- Run the transform and output to filename
- </summary>
- <param name="stream"></param>
- <param name="fileName"></param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Format">
- <summary>
- The format of the generated report. The default is
- <see cref="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.NoFrames"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Language">
- <summary>
- The output language.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.OpenDescription">
- <summary>
- Open all description method. Default to "false".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.ToDir">
- <summary>
- The directory where the files resulting from the transformation
- should be written to. The default is the project's base directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XmlFileSet">
- <summary>
- Set of XML files to use as input
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XmlSummaries">
- <summary>
- Set of summary XML files to use as input.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.XslFile">
- <summary>
- XSLT file used to generate the report if <see cref="P:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.Format"/> is
- <see cref="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.NoFrames"/>.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LocalResXmlResolver">
- <summary>
- Custom XmlResolver used to load the
- XSLT files out of this assembly resources.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask.LocalResXmlResolver.GetEntity(System.Uri,System.String,System.Type)">
- <summary>
- Loads the specified file from our internal resources if its there
- </summary>
- <param name="absoluteUri"></param>
- <param name="role"></param>
- <param name="objToReturn"></param>
- <returns></returns>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask">
- <summary>
- Adds files to a PVCS repository.
- </summary>
- <remarks>
- <para>
- This task uses the <c>addfiles</c> PCLI command to add files to a PVCS repository.
- </para>
- </remarks>
- <example>
- <para>
- Adds <c>File1.txt</c> and <c>File2.txt</c> to the root level of the
- project database specified by the <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control.">
- <entities>
- <entity name="C:\Data\File1.txt"/>
- <entity name="C:\Data\Folder\File2.txt"/>
- </entities>
- </pvcsaddfiles>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Adds <c>File1.txt</c> and <c>File2.txt</c> to the <c>folder</c> project
- of the project database specified by the <c>project-database</c>
- property.
- </para>
- <code>
- <![CDATA[
- <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." projectpath="/folder">
- <entities>
- <entity name="C:\Data\File1.txt"/>
- <entity name="C:\Data\Folder\File2.txt"/>
- </entities>
- </pvcsaddfiles>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Adds <c>another_file.txt</c> and all files and folders at and below
- <c>C:\Data</c> to the project database specified by the <c>project-database</c>
- property.
- </para>
- <code>
- <![CDATA[
- <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Adding files to source control." includesubprojects="true">
- <entities>
- <entity name="C:\Data\"/>
- <entity name="C:\Temp\another_file.txt"/>
- </entities>
- </pvcsaddfiles>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Adds all files at and below <c>C:\Data\</c> to the project database specified by the <c>project-database</c>
- property. Workfiles will be copied to the workfile location and will overwrite any existing files (as
- dictated by the <c>copymode</c> attribute). The relevant revisions will be locked in PVCS. Added files
- will be assigned the <c>SYSTEST</c> promotion group.
- </para>
- <code>
- <![CDATA[
- <pvcsaddfiles projectdatabase="${project-database}" archivedescription="Files." copymode="CopyWorkfileWithOverwrite" lock="true" promotiongroup="SYSTEST" includesubprojects="true">
- <entities>
- <entity name="C:\Data\"/>
- </entities>
- </pvcsaddfiles>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask">
- <summary>
- Base class for all PVCS project database tasks that operate against one or more entities.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask">
- <summary>
- A base class for PVCS tasks that deal with project databases.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSTask">
- <summary>
- Base class functionality for all PVCS tasks.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSTask._pvcsBin">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PVCSBin"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSTask._process">
- <summary>
- This is the PCLI process that is run by this task.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.StartProcess">
- <summary>
- Starts the process that is wrapped by this PVCS task.
- </summary>
- <remarks>
- Provided only to seal the implementation of <c>StartProcess()</c>.
- </remarks>
- <returns>The process that was started.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- <remarks>
- Provided only to seal the implementation of <c>ExecuteTask()</c>.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Prepares the process wrapped by this task for execution.
- </summary>
- <param name="process">The process to prepare for execution.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <summary>
- Allows tasks to add their task-specific arguments to the collection of arguments to be passed to the
- PVCS command-line tool.
- </summary>
- <param name="arguments">The collection of arguments.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.GetProgramArguments">
- <summary>
- Constructs the program arguments that should be used when executing the wrapped PVCS process.
- </summary>
- <returns>A <c>string</c> containing the program arguments.</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PVCSBin">
- <summary>
- Gets or sets the location of the PVCS binary command-line tools.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.Process">
- <summary>
- Gets or sets the process that is run as a result of running this task.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.ProgramArguments">
- <summary>
- Gets the program arguments with which to run the wrapped PVCS process.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.ExeName">
- <summary>
- Gets the executable name for the command-line tool to run for the PVCS task.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PCLICommandName">
- <summary>
- Gets the PCLI command name that corresponds to the operation the task performs.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._includeSubprojects">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._password">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Password"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._projectDatabase">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectDatabase"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._projectPath">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectPath"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._userId">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.UserId"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._workspace">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Workspace"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask._includeSubProjectsUsed">
- <summary>
- Set to <c>true</c> if the <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects"/> property is manipulated. Some tasks don't
- support this property and so an exception will be thrown if the property is used.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.IncludeSubprojects">
- <summary>
- Gets or sets a value indicating whether the operation should include subprojects.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-z</c> command-line option.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects">
- <summary>
- Gets a value indicating whether the specific task implementation supports the <c>includesubprojects</c>
- task attribute. If not, an exception will be thrown if an attempt is made to set the attribute.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Password">
- <summary>
- Gets or sets the password to use when connecting to the project database.
- </summary>
- <remarks>
- <para>
- This is equivalent to the password part of the <c>-id</c> command-line option.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.UserId">
- <summary>
- Gets or sets the user ID to use when connecting to the project database.
- </summary>
- <remarks>
- <para>
- This is equivalent to the user ID part of the <c>-id</c> command-line option.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.Workspace">
- <summary>
- Gets or sets the workspace to use when connecting to the project database.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-sp</c> command-line option.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectDatabase">
- <summary>
- Gets or sets the project database to utilize during the operation.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-pr</c> command-line option.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.ProjectPath">
- <summary>
- Gets or sets the project path to utilize during the operation.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-pp</c> command-line option.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask._entities">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.Entities"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSMultipleEntityTask</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask.Entities">
- <summary>
- Gets or sets the entities involved in the operation.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._archiveDescription">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.ArchiveDescription"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._copyMode">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.CopyMode"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._deleteWorkfiles">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.DeleteWorkfiles"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._description">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Description"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._lock">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Lock"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._promotionGroup">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PromotionGroup"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._suppressAddIfExists">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.SuppressAddIfExists"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask._versionLabel">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.VersionLabel"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSAddFilesTask</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.ArchiveDescription">
- <summary>
- Gets or sets the archive description for versioned files.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-t</c> parameter to the <c>pcli addfiles</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.CopyMode">
- <summary>
- Gets or sets the copy mode for the operation.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.DeleteWorkfiles">
- <summary>
- Gets or sets a value indicating whether workfiles will be deleted after adding them to PVCS.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-d</c> parameter to the <c>pcli addfiles</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Description">
- <summary>
- Gets or sets the description for versioned files.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-m</c> parameter to the <c>pcli addfiles</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.Lock">
- <summary>
- Gets or sets a value indicating whether versioned files should be locked after being added to PVCS.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-l</c> parameter to the <c>pcli addfiles</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PromotionGroup">
- <summary>
- 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.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-g</c> parameter to the <c>pcli addfiles</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.SuppressAddIfExists">
- <summary>
- Gets or sets a value indicating whether workfiles shouldn't be added if they already exist in the PVCS
- repository.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-qw</c> parameter to the <c>pcli addfiles</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.VersionLabel">
- <summary>
- Gets or sets the version label to assign to the added versioned files.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-v</c> parameter to the <c>pcli addfiles</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode">
- <summary>
- Specifies possible copy modes for the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask"/> task.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.Default">
- <summary>
- Indicates the default copy mode should be used.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.CopyWorkfileIfRequired">
- <summary>
- Indicates that workfiles should be copied to the project workfile location is it doesn't already exist.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddFilesTask.PVCSCopyMode.CopyWorkfileWithOverwrite">
- <summary>
- Indicates that workfiles should be copied to the project workfile location and overwrite any existing
- workfile.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask">
- <summary>
- Adds a user to a PVCS project or project database.
- </summary>
- <remarks>
- <para>
- This task uses the <c>adduser</c> PCLI command to add the user to the PVCS project or database.
- </para>
- </remarks>
- <example>
- <para>
- Adds a user with name <c>kb</c> and password <c>*Muse*</c> to the project database specified by the
- <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsadduser projectdatabase="${project-database}" username="kb" password="*Muse*"/>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Adds a user with name <c>kb</c> and password <c>*Muse*</c> to the project database specified by the
- <c>project-database</c> property. The user's logon will expire on the 26th of October, 2005.
- </para>
- <code>
- <![CDATA[
- <pvcsadduser projectdatabase="${project-database}" username="kb" password="*Muse*" expirydate="10/26/2005"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._expiryDate">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.ExpiryDate"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._userPassword">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserPassword"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask._userName">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserName"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSAddUserTask</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.ExpiryDate">
- <summary>
- Gets or sets the expiration date for the new user.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-e</c> parameter to the <c>pcli adduser</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserPassword">
- <summary>
- Gets or sets the password for the new user.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.UserName">
- <summary>
- Gets or sets the user name for the new user.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAddUserTask.SupportsIncludeSubprojects">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask">
- <summary>
- Assigns a promotion group to versioned files.
- </summary>
- <remarks>
- <para>
- This task uses the <c>assigngroup</c> PCLI command to assign the group to versioned files.
- </para>
- </remarks>
- <example>
- <para>
- Assigns the <c>SYSTEST</c> promotion group to all entities with the <c>DEV</c> promotion group in the
- <c>folder</c> project.
- </para>
- <code>
- <![CDATA[
- <pvcsassigngroup projectdatabase="${project-database}" entity="/folder" assignpromotiongroup="SYSTEST" promotiongroup="DEV"/>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Assigns the <c>SYSTEST</c> promotion group to revision <c>1.2</c> of all entities.
- </para>
- <code>
- <![CDATA[
- <pvcsassigngroup projectdatabase="${project-database}" entity="/" includesubprojects="true" assignpromotiongroup="SYSTEST" revision="1.2"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask">
- <summary>
- Base class for all PVCS project database tasks that operate against a single entity.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask._entity">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.Entity"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSSingleEntityTask.Entity">
- <summary>
- Gets or sets the entity involved in the operation.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._assignPromotionGroup">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AssignPromotionGroup"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._promotionGroup">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.PromotionGroup"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._revision">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.Revision"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask._versionLabel">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.VersionLabel"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSAssignGroupTask</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.AssignPromotionGroup">
- <summary>
- Gets or sets the promotion group to assign to the versioned files.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-g</c> parameter to the <c>pcli assigngroup</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.PromotionGroup">
- <summary>
- Gets or sets the promotion group for the versioned files to be assigned the promotion group.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.Revision">
- <summary>
- Gets or sets the revision for the versioned files to be assigned the promotion group.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
- </para>
- <para>
- If this property has not yet been set, it will return <c>Double.MaxValue</c>.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSAssignGroupTask.VersionLabel">
- <summary>
- Gets or sets the version label for the versioned files to be assigned the promotion group.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-r</c> parameter to the <c>pcli assigngroup</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask">
- <summary>
- Changes the promotion group for specified versioned files.
- </summary>
- <remarks>
- <para>
- This task uses the <c>changegroup</c> PCLI command to change the group for versioned files.
- </para>
- </remarks>
- <example>
- <para>
- Changes the promotion group for <c>file.txt</c> from <c>SYSTEST</c> to <c>DEV</c>.
- </para>
- <code>
- <![CDATA[
- <pvcschangegroup projectdatabase="${project-database}" from="SYSTEST" to="DEV" entity="/file.txt"/>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Changes the promotion group for all files from <c>DEV</c> to <c>PROD</c>.
- </para>
- <code>
- <![CDATA[
- <pvcschangegroup projectdatabase="${project-database}" from="DEV" to="PROD" entity="/" includesubprojects="true"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask._from">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.From"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask._to">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.To"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.From">
- <summary>
- Gets or sets the promotion group to change from.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-gf</c> parameter to the <c>pcli changegroup</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSChangeGroupTask.To">
- <summary>
- Gets or sets the promotion group to change to.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-gt</c> parameter to the <c>pcli changegroup</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument">
- <summary>
- Encapsulates the details of a PVCS command argument.
- </summary>
- <remarks>
- <para>
- PVCS tasks must "fill in" a collection of arguments to be passed to the PVCS command line interface (PCLI).
- This class represents one such argument.
- </para>
- <para>
- Each argument consists of a command and an optional command value. The command is always passed to the PVCS
- command line utility and is therefore required. An example of a command is "-g" which is passed to many
- PVCS command line utilities to specify a promotion group.
- </para>
- <para>
- The command value is used to specify extra information to the command. For example, if the command is "-g"
- then the command value would be the name of the promotion group.
- </para>
- <para>
- The command can be assigned a position (see the <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position"/> property). This position defines
- where the command appears relative to other commands. For example, some commands must appear after other
- commands. Therefore, they should be assigned a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._command">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._commandValue">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CommandValue"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument._position">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String)">
- <summary>
- Constructs an instance of <c>PVCSCommandArgument</c> with the specified information. No value is
- applied and the argument has a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>.
- </summary>
- <param name="command">The command string.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String,System.Object)">
- <summary>
- Constructs an instance of <c>PVCSCommandArgument</c> with the specified information. The argument has
- a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>.
- </summary>
- <param name="command">The command string.</param>
- <param name="commandValue">The value for the command, or <c>null</c> if no value applies.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.#ctor(System.String,System.Object,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition)">
- <summary>
- Constructs an instance of <c>PVCSCommandArgument</c> with the specified information.
- </summary>
- <param name="command">The command string.</param>
- <param name="commandValue">The value for the command, or <c>null</c> if no value applies.</param>
- <param name="position">The position for the command.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CompareTo(System.Object)">
- <summary>
- Compares two PVCS command arguments based on their position.
- </summary>
- <param name="o">The PVCS command argument to compare to <c>this</c>.</param>
- <returns>
- Less than zero if this instance is less than <paramref name="o"/>.
- Zero if this instance is equal to <paramref name="o"/>.
- Greater than zero if this instance is greater than <paramref name="o"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.ToString">
- <summary>
- Converts this command argument to its <c>string</c> representation.
- </summary>
- <returns>The <c>string</c> representation of this command argument.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.EscapeStringCommandArgument(System.String)">
- <summary>
- Escapes a <c>string</c> command line argument.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- </remarks>
- <param name="argument">The string argument to escape.</param>
- <returns>The escaped string argument.</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command">
- <summary>
- Gets a <c>string</c> that contains the command to pass to PVCS.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.CommandValue">
- <summary>
- Gets the value to append to <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Command"/>.
- </summary>
- <remarks>
- <para>
- If this property is <c>null</c>, no value will be appended to the command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument.Position">
- <summary>
- Gets the position for the command.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection">
- <summary>
- Implements a type-safe collection of <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/>s.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
- <see cref="M:System.Collections.IList.Add(System.Object)"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String)">
- <summary>
- Adds a new command argument to this collection with the specified information.
- </summary>
- <param name="command">The command string for the new command.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String,System.Object)">
- <summary>
- Adds a new command argument to this collection with the specified information.
- </summary>
- <param name="command">The command string for the new command.</param>
- <param name="commandValue">
- The command value for the new command, or <c>null</c> if no value applies.
- </param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Add(System.String,System.Object,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition)">
- <summary>
- Adds a new command argument to this collection with the specified information.
- </summary>
- <param name="command">The command string for the new command.</param>
- <param name="commandValue">
- The command value for the new command, or <c>null</c> if no value applies.
- </param>
- <param name="position">The position for the new command.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.AddRange(System.Collections.ICollection)">
- <summary>
- Adds all specified command arguments to this collection.
- </summary>
- <param name="commandArguments">The collection of command arguments to add.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.IndexOf(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
- <see cref="M:System.Collections.IList.IndexOf(System.Object)"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Insert(System.Int32,NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
- <see cref="M:System.Collections.IList.Insert(System.Int32,System.Object)"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Remove(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
- <see cref="M:System.Collections.IList.Remove(System.Object)"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Contains(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument)">
- <see cref="M:System.Collections.IList.Contains(System.Object)"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.ToArray">
- <summary>
- Retrieves an array of <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/> objects in this collection.
- </summary>
- <returns>An array of command arguments in this collection.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnInsert(System.Int32,System.Object)">
- <see cref="M:System.Collections.CollectionBase.OnInsert(System.Int32,System.Object)"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnSet(System.Int32,System.Object,System.Object)">
- <see cref="M:System.Collections.CollectionBase.OnSet(System.Int32,System.Object,System.Object)"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.OnValidate(System.Object)">
- <see cref="M:System.Collections.CollectionBase.OnValidate(System.Object)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection.Item(System.Int32)">
- <summary>
- Allows the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgument"/> objects in the collection to be manipulated.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition">
- <summary>
- Defines possible values for specifying positions for PCLI command arguments and arguments to PCLI itself.
- </summary>
- <remarks>
- <para>
- Members of this enumeration are used to specify relative positions of PCLI command arguments. All arguments
- given a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/> will appear after arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/>
- or <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>. Similarly, arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle"/> will appear after
- those with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/> but before those with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/>.
- </para>
- <para>
- No order is guaranteed for arguments with the same position. That is, if two arguments have a position of
- <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>, it is not possible to specify which one is output to the command line first.
- </para>
- <para>
- The <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.BeforePCLICommand"/> member is special in that it ensures the argument will appear before
- the PCLI command name. This is useful when the argument is to PCLI itself, not the PCLI command.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.BeforePCLICommand">
- <summary>
- Arguments that should appear before the PCLI command argument. This is useful for arguments to PCLI
- itself (as opposed to the PCLI command).
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start">
- <summary>
- PCLI command arguments that should appear before other PCLI command arguments.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Middle">
- <summary>
- PCLI command arguments that should appear before other arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End"/>
- but after other arguments with a position of <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.Start"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentPosition.End">
- <summary>
- PCLI command arguments that should appear after other PCLI command arguments.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask">
- <summary>
- Creates a project in a PVCS repository.
- </summary>
- <remarks>
- <para>
- This task uses the <c>createproject</c> PCLI command to create the project in the PVCS repository.
- </para>
- </remarks>
- <example>
- <para>
- Creates a project called <c>Songs</c> in the project database specified by the <c>project-database</c>
- property. The workfile location for the project is set to <c>C:\Work\Songs</c>.
- </para>
- <code>
- <![CDATA[
- <pvcscreateproject projectdatabase="${project-database}" workfilelocation="C:\Work\Songs" entity="/Songs"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask._workfileLocation">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.WorkfileLocation"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.WorkfileLocation">
- <summary>
- Gets or sets the workfile location for the created project.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-w</c> parameter to the <c>pcli createproject</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSCreateProjectTask.SupportsIncludeSubprojects">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask">
- <summary>
- Removes a specified promotion group from versioned files.
- </summary>
- <remarks>
- <para>
- This task uses the <c>deletegroup</c> PCLI command to remove the promotion group from the versioned files.
- </para>
- </remarks>
- <example>
- <para>
- Removes the <c>DEV</c> promotion group from <c>App.ico</c> in the project database specified by the
- <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsdeletegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/App.ico"/>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Removes the <c>DEV</c> promotion group all files in the project database specified by the
- <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsdeletegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/" includesubprojects="true"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask._promotionGroup">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.PromotionGroup"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteGroupTask.PromotionGroup">
- <summary>
- Gets or sets the promotion group to delete.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-g</c> parameter to the <c>pcli deletegroup</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask">
- <summary>
- Removes a label from specified versioned files or projects.
- </summary>
- <remarks>
- <para>
- This task uses the <c>deletelabel</c> PCLI command to remove the version label from the versioned files.
- </para>
- </remarks>
- <example>
- <para>
- Removes the label called <c>My Label</c> from the versioned file called <c>App.ico</c> from the project
- database specified by the <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label">
- <entities>
- <entity name="/App.ico"/>
- </entities>
- </pvcsdeletelabel>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Removes the label called <c>My Label</c> from all files at and below both <c>folder1</c> and <c>folder2</c>
- in the project database specified by the <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsdeletelabel projectdatabase="${project-database}" versionlabel="My Label" includesubprojects="true">
- <entities>
- <entity name="/folder1"/>
- <entity name="/folder2"/>
- </entities>
- </pvcsdeletelabel>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask._versionLabel">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.VersionLabel"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteLabelTask.VersionLabel">
- <summary>
- Gets or sets the version label to remove.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-v</c> parameter to the <c>pcli deletelabel</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteTask">
- <summary>
- Deletes folder, projects, versioned items and workspaces in a PVCS repository.
- </summary>
- <remarks>
- <para>
- This task uses the <c>delete</c> PCLI command to delete the items.
- </para>
- </remarks>
- <example>
- <para>
- Deletes the versioned file called <c>App.ico</c> from the project database specified by the
- <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsdelete projectdatabase="${project-database}">
- <entities>
- <entity name="/App.ico"/>
- </entities>
- </pvcsdelete>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Deletes the files called <c>file1.txt</c> and <c>file2.txt</c> from the project called <c>folder</c> in the
- project database specified by the <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsdelete projectdatabase="${project-database}" projectpath="/folder">
- <entities>
- <entity name="file1.txt"/>
- <entity name="file2.txt"/>
- </entities>
- </pvcsdelete>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteTask.SupportsIncludeSubprojects">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask">
- <summary>
- Deletes the specified users from the PVCS access control database.
- </summary>
- <remarks>
- <para>
- This task uses the <c>deleteuser</c> PCLI command to delete the users.
- </para>
- </remarks>
- <example>
- <para>
- Deletes the users called <c>kb</c>, <c>kv</c> and <c>tb</c> from the project database specified by the
- <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsdeleteusers projectdatabase="${project-database}">
- <entities>
- <entity name="kb"/>
- <entity name="kv"/>
- <entity name="tb"/>
- </entities>
- </pvcsdeleteusers>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask.SupportsIncludeSubprojects">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSProjectDatabaseTask.SupportsIncludeSubprojects"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSDeleteUsersTask.PCLICommandName">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSTask.PCLICommandName"/>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSGetTask">
- <summary>
- Gets files from a PVCS repository.
- </summary>
- <remarks>
- <para>
- This task uses the <c>get</c> PCLI command to get the versioned files from PVCS.
- </para>
- </remarks>
- <example>
- <para>
- Gets the versioned file called <c>App.ico</c> from the project database specified by the
- <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsget projectdatabase="${project-database}">
- <entities>
- <entity name="/App.ico"/>
- </entities>
- </pvcsget>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Gets the versioned file called <c>App.ico</c> from the project database specified by the
- <c>project-database</c> property. The file is also locked.
- </para>
- <code>
- <![CDATA[
- <pvcsget projectdatabase="${project-database}" lock="true">
- <entities>
- <entity name="/App.ico"/>
- </entities>
- </pvcsget>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Gets all revisions assigned the <c>SYSTEST</c> promotion group from the project database specified by the
- <c>project-database</c> property. The workfiles are touched after the get operation.
- </para>
- <code>
- <![CDATA[
- <pvcsget projectdatabase="${project-database}" includesubprojects="true" promotiongroup="SYSTEST" touch="true">
- <entities>
- <entity name="/"/>
- </entities>
- </pvcsget>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._baseProjectPath">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.BaseProjectPath"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._location">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Location"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._lock">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Lock"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._makeWritable">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MakeWritable"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._maxDateTime">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MaxDateTime"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._overrideWorkfileLocation">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.OverrideWorkfileLocation"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._promotionGroup">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.PromotionGroup"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._revision">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Revision"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._touch">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Touch"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._updateOnly">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.UpdateOnly"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSGetTask._versionLabel">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.VersionLabel"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSGetTask</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.BaseProjectPath">
- <summary>
- Gets or sets the base project path.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-bp</c> parameter to the <c>pcli get</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Location">
- <summary>
- Gets or sets an alternative location for workfiles.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-a</c> parameter to the <c>pcli get</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Lock">
- <summary>
- Gets or sets a value indicating whether revisions involved in the get operation should be locked.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-l</c> parameter to the <c>pcli get</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MakeWritable">
- <summary>
- Gets or sets whether the workfiles should be made writable.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-w</c> parameter to the <c>pcli get</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.MaxDateTime">
- <summary>
- Gets or sets the maximum date and time of workfiles to retrieve.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-d</c> parameter to the <c>pcli get</c> command.
- </para>
- <para>
- If this property has not yet been set, it will return <c>DateTime.MaxValue</c>.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.OverrideWorkfileLocation">
- <summary>
- Gets or sets a value indicating whether the workfile location for files should be overridden.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-o</c> parameter to the <c>pcli get</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.PromotionGroup">
- <summary>
- Gets or sets the promotion group to get.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-g</c> parameter to the <c>pcli get</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Revision">
- <summary>
- Gets or sets the revision to get against.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-r</c> parameter to the <c>pcli get</c> command.
- </para>
- <para>
- If this property has not yet been set, it will return <c>Double.MaxValue</c>.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.Touch">
- <summary>
- Gets or sets a value indicating whether workfiles should be touched after the get.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-t</c> parameter to the <c>pcli get</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.UpdateOnly">
- <summary>
- Gets or sets a value indicating whether workfiles should only be gotten if they are newer than the
- current workfile.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-u</c> parameter to the <c>pcli get</c> command (without specifying a
- date or time).
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSGetTask.VersionLabel">
- <summary>
- Gets or sets the version label to get against.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-v</c> parameter to the <c>pcli get</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask">
- <summary>
- Assigns a version label to a revision of the specified versioned files.
- </summary>
- <remarks>
- <para>
- This task uses the <c>label</c> PCLI command to label the items.
- </para>
- </remarks>
- <example>
- <para>
- Labels all files in the project database specified by the <c>project-database</c> property. The label
- applied is <c>Beta</c>.
- </para>
- <code>
- <![CDATA[
- <pvcslabel projectdatabase="${project-database}" versionlabel="Beta" includesubprojects="true">
- <entities>
- <entity name="/"/>
- </entities>
- </pvcslabel>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Labels revision <c>1.8</c> of <c>App.ico</c> as <c>Dodgy</c> in the project database specified by the
- <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcslabel projectdatabase="${project-database}" versionlabel="Dodgy" revision="1.8">
- <entities>
- <entity name="App.ico"/>
- </entities>
- </pvcslabel>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._floating">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Floating"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._revision">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Revision"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask._versionLabel">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.VersionLabel"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSLabel</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Floating">
- <summary>
- Gets or sets a value indicating whether the label should "float" to the newest revision.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-f</c> parameter to the <c>pcli label</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.Revision">
- <summary>
- Gets or sets the revision to label.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-r</c> parameter to the <c>pcli label</c> command.
- </para>
- <para>
- If this property has not yet been set, it will return <c>Double.MaxValue</c>.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLabelTask.VersionLabel">
- <summary>
- Gets or sets the version label to assign.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-v</c> parameter to the <c>pcli label</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSLockTask">
- <summary>
- Locks a revision of the specified versioned files.
- </summary>
- <remarks>
- <para>
- This task uses the <c>lock</c> PCLI command to lock the versioned files.
- </para>
- </remarks>
- <example>
- <para>
- Locks <c>App.ico</c> in the project database specified by the <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcslock projectdatabase="${project-database}">
- <entities>
- <entity name="/App.ico"/>
- </entities>
- </pvcslock>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Locks all files at and below <c>folder</c> in the project database specified by the <c>project-database</c>
- property.
- </para>
- <code>
- <![CDATA[
- <pvcslock projectdatabase="${project-database}" includesubprojects="true">
- <entities>
- <entity name="/folder"/>
- </entities>
- </pvcslock>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._noBranching">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoBranching"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._noMultilock">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoMultilock"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._promotionGroup">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.PromotionGroup"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._revision">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.Revision"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._yesToBranching">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToBranching"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSLockTask._yesToMultilock">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToMultilock"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSLock</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoBranching">
- <summary>
- Gets or sets a value indicating whether locking files will take place if checking in those files would
- result in a branch.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-nb</c> parameter to the <c>pcli lock</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.NoMultilock">
- <summary>
- Gets or sets a value indicating whether already locked revisions will be locked.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-nm</c> parameter to the <c>pcli lock</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.PromotionGroup">
- <summary>
- Gets or sets the promotion group to assign the locked revision.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-g</c> parameter to the <c>pcli lock</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.Revision">
- <summary>
- Gets or sets the revision to lock.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-r</c> parameter to the <c>pcli lock</c> command.
- </para>
- <para>
- If this property has not yet been set, it will return <c>Double.MaxValue</c>.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToBranching">
- <summary>
- Gets or sets a value indicating whether revisions will be locked even if that will result in a branch
- upon check in.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-yb</c> parameter to the <c>pcli lock</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSLockTask.YesToMultilock">
- <summary>
- Gets or sets a value indicating whether revisions will be locked even if that will result in multiple
- locks against the same revision.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-ym</c> parameter to the <c>pcli lock</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask">
- <summary>
- Promotes versioned files to the next promotion group.
- </summary>
- <remarks>
- <para>
- This task uses the <c>promotegroup</c> PCLI command to promote versioned files.
- </para>
- </remarks>
- <example>
- <para>
- Promotes all files in the root of the project database specified by the <c>project-database</c> property.
- The files are promoted from the <c>DEV</c> promotion group to the next. Promotion will not take place across
- branches.
- </para>
- <code>
- <![CDATA[
- <pvcspromotegroup projectdatabase="${project-database}" promotiongroup="DEV" entity="/" acrossbranches="false"/>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Promotes all files in the project database specified by the <c>project-database</c> property. The files are
- promoted from the <c>SYSTEST</c> promotion group to the next. Promotion will take place across branches.
- </para>
- <code>
- <![CDATA[
- <pvcspromotegroup projectdatabase="${project-database}" promotiongroup="SYSTEST" entity="/" includesubprojects="true" acrossbranches="true"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask._acrossBrances">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AcrossBranches"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask._promotionGroup">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.PromotionGroup"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.AcrossBranches">
- <summary>
- Gets or sets a value indicating whether the promotion may occur across branches.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-nb</c> and <c>-yb</c> parameters to the <c>pcli promotegroup</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPromoteGroupTask.PromotionGroup">
- <summary>
- Gets or sets the promotion group to be promoted.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-g</c> parameter to the <c>pcli promotegroup</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSPutTask">
- <summary>
- Puts files into a PVCS repository.
- </summary>
- <remarks>
- <para>
- This task uses the <c>put</c> PCLI command to put the files into PVCS.
- </para>
- </remarks>
- <example>
- <para>
- Puts the file called <c>App.ico</c> into the project database specified by the <c>project-database</c>
- property. The description for the change is <c>Added more colour</c>.
- </para>
- <code>
- <![CDATA[
- <pvcsput projectdatabase="${project-database}" description="Added more colour">
- <entities>
- <entity name="/App.ico"/>
- </entities>
- </pvcsput>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Puts all files into the project database specified by the <c>project-database</c> property. The description
- for the changes is <c>Major changes</c>. Even if the workfiles have not been changed, they will result in a
- new revision in PVCS.
- </para>
- <code>
- <![CDATA[
- <pvcsput projectdatabase="${project-database}" description="Major changes" checkinunchanged="true" includesubprojects="true">
- <entities>
- <entity name="/"/>
- </entities>
- </pvcsput>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Puts <c>file.txt</c> and all files in <c>folder</c> into the project database specified by the
- <c>project-database</c> property. The description for the changes is <c>Some changes</c>. A new branch is
- forcibly created via the <c>forcebranch</c> attribute. Leading and trailing whitespace is ignored when
- determining whether the workfile has been altered.
- </para>
- <code>
- <![CDATA[
- <pvcsput projectdatabase="${project-database}" description="Some changes" forcebranch="true" ignorespaces="true">
- <entities>
- <entity name="/folder"/>
- <entity name="/file.txt"/>
- </entities>
- </pvcsput>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._baseProjectPath">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.BaseProjectPath"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._checkInUnchanged">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.CheckInUnchanged"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._description">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Description"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._floatLabel">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.FloatLabel"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._forceBranch">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ForceBranch"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._ignoreSpaces">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.IgnoreSpaces"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._keepWorkfile">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.KeepWorkfile"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._location">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Location"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._lock">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Lock"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._overrideWorkfileLocation">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.OverrideWorkfileLocation"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._promotionGroup">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.PromotionGroup"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._reassignLabelIfExists">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ReassignLabelIfExists"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._revision">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Revision"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._useSameDescription">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.UseSameDescription"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSPutTask._versionLabel">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSPut</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.BaseProjectPath">
- <summary>
- Gets or sets the base project path.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-bp</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.CheckInUnchanged">
- <summary>
- Gets or sets a value indicating whether unchanged workfiles should be checked in.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-yf</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Description">
- <summary>
- Gets or sets the description to be applied to the checked in revisions.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-m</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.FloatLabel">
- <summary>
- Gets or sets a value indicating whether the version label specified by <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
- should float.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-fv</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ForceBranch">
- <summary>
- Gets or sets a value indicating whether a new branch will be created.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-fb</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.IgnoreSpaces">
- <summary>
- Gets or sets a value indicating whether leading and trailing spaces should be ignored when determining
- whether the revision has changed.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-b</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.KeepWorkfile">
- <summary>
- Gets or sets a value indicating whether the workfile should kept in its original state.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-k</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Location">
- <summary>
- Gets or sets an alternative location for workfiles.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-a</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Lock">
- <summary>
- Gets or sets a value indicating the files should be locked after the put operation.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-l</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.OverrideWorkfileLocation">
- <summary>
- Gets or sets a value indicating whether the workfile location for files should be overridden.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-o</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.PromotionGroup">
- <summary>
- 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.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-g</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.ReassignLabelIfExists">
- <summary>
- Gets or sets a value indicating whether the version label specified by <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel"/>
- should be reassigned if it already exists.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-yv</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.Revision">
- <summary>
- Gets or sets the revision number to use for the new revision.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-r</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.UseSameDescription">
- <summary>
- Gets or sets a value indicating whether the same description should be used for all versioned items.
- This is <c>true</c> by default.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-ym</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSPutTask.VersionLabel">
- <summary>
- Gets or sets the version label to assign to the new revisions.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-v</c> parameter to the <c>pcli put</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask">
- <summary>
- Renames a label in a PVCS repository.
- </summary>
- <remarks>
- <para>
- This task uses the <c>renamelabel</c> PCLI command to rename the label.
- </para>
- </remarks>
- <example>
- <para>
- Renames the label on <c>App.ico</c> from <c>Beater</c> to <c>Beta</c> in the project database specified by
- the <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsrenamelabel projectdatabase="${project-database}" from="Beater" to="Beta">
- <entities>
- <entity name="App.ico"/>
- </entities>
- </pvcsrenamelabel>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Renames the label on all files from <c>Alfa</c> to <c>Alpha</c> in the project database specified by the
- <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsrenamelabel projectdatabase="${project-database}" from="Alfa" to="Alpha" includesubprojects="true">
- <entities>
- <entity name="/"/>
- </entities>
- </pvcsrenamelabel>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask._from">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.From"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask._to">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.To"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.From">
- <summary>
- Gets or sets the existing label.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-vf</c> parameter to the <c>pcli renamelabel</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSRenameLabelTask.To">
- <summary>
- Gets or sets the new label.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-vt</c> parameter to the <c>pcli renamelabel</c> command.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask">
- <summary>
- Unlocks revisions of versioned files in a PVCS repository.
- </summary>
- <remarks>
- <para>
- This task uses the <c>unlock</c> PCLI command to perform the unlock operation.
- </para>
- </remarks>
- <example>
- <para>
- Unlocks <c>App.ico</c> in the project database specified by the <c>project-database</c> property.
- </para>
- <code>
- <![CDATA[
- <pvcsunlock projectdatabase="${project-database}">
- <entities>
- <entity name="/App.ico"/>
- </entities>
- </pvcsunlock>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Unlocks all files in the project specified by the <c>project-database</c> property. Locks by all users are
- removed.
- </para>
- <code>
- <![CDATA[
- <pvcsunlock projectdatabase="${project-database}" includesubprojects="true" unlockmode="AllUsers">
- <entities>
- <entity name="/"/>
- </entities>
- </pvcsunlock>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._revision">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.Revision"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._unlockMode">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask._user">
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.User"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.#ctor">
- <summary>
- Constructs and initializes an instance of <c>PVCSUnlock</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)">
- <see cref="M:NAnt.Contrib.Tasks.PVCS.PVCSTask.AddCommandLineArguments(NAnt.Contrib.Tasks.PVCS.PVCSCommandArgumentCollection)"/>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.Revision">
- <summary>
- Gets or sets the revision number to use for the new revision.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-r</c> parameter to the <c>pcli unlock</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode">
- <summary>
- Gets or sets the unlock mode for the operation.
- </summary>
- <remarks>
- <para>
- This is equivalent to the <c>-u</c> parameter to the <c>pcli unlock</c> command.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.User">
- <summary>
- Gets or sets the user whose locked files are to be unlocked. This is relevant only when
- <see cref="P:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.UnlockMode"/> is set to <see cref="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser"/>.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode">
- <summary>
- Specifies possible modes for the <see cref="T:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask"/> task.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.CurrentUser">
- <summary>
- All locks held by the current user are removed.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.SpecifiedUser">
- <summary>
- All locks held by a specified user are removed.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.PVCS.PVCSUnlockTask.PVCSUnlockMode.AllUsers">
- <summary>
- All locks held by all users are removed.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Add">
- <summary>
- Open file(s) in a client workspace for addition to the depot.
- </summary>
- <example>
- <para>
- Add all cs files under the given directory into the "new" changelist
- (will be created if it doesn't already exist).
- </para>
- <code>
- <![CDATA[
- <p4add file="C:\Src\Project\*.cs" changelist="new" />
- ]]>
- </code>
- </example>
- <example>
- <para>Add Test.txt into the default changelist.</para>
- <code>
- <![CDATA[
- <p4add file="C:\Src\Project\Test.txt" />
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Base">
- <summary>
- Base class for Perforce (P4) NAnt tasks. See individual task for example usage.
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Add">P4Add</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Change">P4Change</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Delete">P4Delete</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Edit">P4Edit</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Label">P4Label</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Labelsync">P4Labelsync</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Print">P4Print</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Reopen">P4Reopen</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Revert">P4Revert</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Submit">P4Submit</seealso>
- <seealso cref="T:NAnt.Contrib.Tasks.Perforce.P4Sync">P4Sync</seealso>
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Base.ExecuteTask">
- <summary>
- Execute the perforce command assembled by subclasses.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Port">
- <summary>
- The p4 server and port to connect to. The default is "perforce:1666".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Client">
- <summary>
- The p4 client spec to use. The default is the current client.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.User">
- <summary>
- The p4 username. The default is the current user.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.View">
- <summary>
- The client, branch or label view to operate upon. The default is
- "//...".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.Script">
- <summary>
- 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 <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.ProgramArguments">
- <summary>
- Gets the command line arguments for the external program.
- </summary>
- <value>
- The command line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.ExeName">
- <summary>
- Override the ExeName paramater for p4.exe
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Base.CommandSpecificArguments">
- <summary>
- Derived classes should override this to provide command-specific
- commandline arguments.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Add.getSpecificCommandArguments">
- <summary>
- Build the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.File">
- <summary>
- File(s) to add. File name can contain wildcard characters. (Note:
- this is not using p4 wildcard syntax, but the OS wildcards).
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.Changelist">
- <summary>
- Changelist that files will be added into. Changelist will be created
- if not already present.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.Type">
- <summary>
- File Type settings. Applied to all files in the <see cref="P:NAnt.Contrib.Tasks.Perforce.P4Add.File"/>
- parameter.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Add.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Change">
- <summary>
- Create or delete a changelist specification.
- </summary>
- <example>
- <para>Create a new changelist called "mynewchange".</para>
- <code>
- <![CDATA[
- <p4change changelist="mynewchange" />
- ]]>
- </code>
- </example>
- <example>
- <para>Delete the changelist called "mynewchange".</para>
- <code>
- <![CDATA[
- <p4change changelist="mynewchange" delete="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Change.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.Changelist">
- <summary>
- Changelist to create or delete.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.Delete">
- <summary>
- If <see langword="false" /> causes passed in changelist to be
- deleted. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Change.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Client">
- <summary>
- Add/modify/delete a client spec in perforce.
- </summary>
- <example>
- <para>
- Add a client (modify if already present and have sufficient rights).
- </para>
- <code>
- <![CDATA[
- <p4client clientname="myClient" view="//root/test/..." />
- ]]>
- </code>
- </example>
- <example>
- <para>Delete a client.</para>
- <code>
- <![CDATA[
- <p4client delete="true" clientname="myClient" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Client.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.ClientName">
- <summary>
- Name of client to create/delete.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Root">
- <summary>
- Root path for client spec.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Delete">
- <summary>
- Delete the named client. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.Force">
- <summary>
- Force a delete even if files are open. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Client.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Delete">
- <summary>
- Open file(s) in a client workspace for deletion from the depot.
- </summary>
- <example>
- <para>
- Mark all cs files under the give view for deletion and place them in
- the "Deleting" changelist.
- </para>
- <code>
- <![CDATA[
- <p4delete view="//Root/ProjectX/Test/...*.cs" changelist="Deleting" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Delete.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.Changelist">
- <summary>
- Changelist to place the marked for deletion item into.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.View">
- <summary>
- The client, branch or label view to operate upon.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Delete.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Edit">
- <summary>
- Opens file(s) in a client workspace for edit.
- </summary>
- <example>
- <para>
- Open all files in the ProjectX Test folder for edit, and place into
- the default changelist.
- </para>
- <code>
- <![CDATA[
- <p4edit view="//Root/ProjectX/Test/..." />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Open all *.txt files in the ProjectX Test folder for edit, and place
- into the "testing" changelist.
- </para>
- <code>
- <![CDATA[
- <p4edit view="//Root/ProjectX/Test/...*.txt" changelist="testing" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Edit.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.Changelist">
- <summary>
- Changelist to place the opened files into.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.Type">
- <summary>
- File Type settings.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.View">
- <summary>
- The client, branch or label view to operate upon.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Edit.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Info">
- <summary>
- Returns information from the "p4 info" command back into variables for
- use within the build process.
- </summary>
- <example>
- <para>Fill the variables using the task.</para>
- <code>
- <![CDATA[
- <p4info user="myuser" client="myclient" host="myhost" root="myroot" />
- <echo message="User: ${myuser} - Client: ${myclient} - Host: ${myhost} - Root: ${myroot}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.User">
- <summary>
- The name of the property to store the p4 user name in.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Client">
- <summary>
- The name of the property to store the p4 client name in.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Host">
- <summary>
- The name of the property to store the p4 host name in.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Info.Root">
- <summary>
- The name of the property to store the p4 client root in.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Label">
- <summary>
- Create or edit a label specification and its view.
- </summary>
- <example>
- <para>Create a new label called "SDK_V1.2".</para>
- <code>
- <![CDATA[
- <p4label label="SDK_V1.2" view="//Root/ProjectX/Test/...*.txt" />
- ]]>
- </code>
- </example>
- <example>
- <para>Delete the previously created label.</para>
- <code>
- <![CDATA[
- <p4label label="SDK_V1.2" delete="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Label.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.Label">
- <summary>
- Name of label to create/delete.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.Delete">
- <summary>
- Delete the named label. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Label.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Labelsync">
- <summary>
- Synchronize a label with the contents of the current client workspace.
- </summary>
- <example>
- <para>Apply a previously created label to the specified view.</para>
- <code>
- <![CDATA[
- <p4labelsync label="SDK_V1.2" view="//Root/..." />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Labelsync.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.Label">
- <summary>
- Name of the label to sync the specified or default view with.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.Delete">
- <summary>
- Delete the view defined in the label, or matching the input view
- from the label. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Labelsync.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Print">
- <summary>
- Fetch a specific file from a Perforce depot without needing a clientspec
- to map it.
- </summary>
- <example>
- <code>
- <![CDATA[
- <p4print file="//depot/foo/mainline/clientspec" outputfile=".\clientspec" />
- <p4client input=".\clientspec" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Print.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.File">
- <summary>
- The depot or local filename (including optional path) of the file
- to fetch.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.P4OutputFile">
- <summary>
- The local filename to write the fetched file to.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Print.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Reopen">
- <summary>
- Move opened files between changelists or change the files’ type.
- </summary>
- <remarks>
- This task has two different but related uses:
- Moving opened files between changelists (default or named).
- Changing the type of an opened file.
- </remarks>
- <example>
- <para>
- Move the specified files matching the view into the "New" changelist.
- </para>
- <code>
- <![CDATA[
- <p4reopen view="//Root/...Version.xml" changelist="New" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Modify the specified files matching the view to the given file type.
- The change won't affect the repository until submitted.
- </para>
- <code>
- <![CDATA[
- <p4reopen view="//Root/...*.res" type="binary" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Reopen.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.View">
- <summary>
- The client, branch or label view to operate upon.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.Changelist">
- <summary>
- Changelist to place the reopened files into.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.Type">
- <summary>
- File Type settings.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Reopen.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Revert">
- <summary>
- Discard changes made to open files.
- </summary>
- <example>
- <para>Revert all txt files in a given changelist.</para>
- <code>
- <![CDATA[
- <p4revert changelist="Test" view="//...*.txt" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Revert all unchanged files opened in the given changelist.
- </para>
- <code>
- <![CDATA[
- <p4revert changelist="Test" revertunchanged="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>Revert all unchanged files opened in any changelist.</para>
- <code>
- <![CDATA[
- <p4revert revertunchanged="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Revert.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.Changelist">
- <summary>
- Changelist to perform the revert action on. optional.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.RevertUnchanged">
- <summary>
- Revert all unchanged or missing files from the changelist. default is false. optional.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Revert.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Set">
- <summary>
- Set registry variables that perforce uses.
- </summary>
- <remarks>
- Note: the environment variables that p4 uses will be set, but will not
- be validated.
- </remarks>
- <example>
- <para>Modify any of the three variables (at least one required).</para>
- <code>
- <![CDATA[
- <p4set client="myClient" user="jonb" port="server:1666" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Set.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Set.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Submit">
- <summary>
- Send changes made to open files to the depot.
- </summary>
- <example>
- <para>
- Submit changelist "Temp", but first revert all unchanged files in the
- changelist.
- </para>
- <code>
- <![CDATA[
- <p4submit changelist="Temp" revertunchanged="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>Submit changelist, but leave the files open afterwards.</para>
- <code>
- <![CDATA[
- <p4submit changelist="Temp" remainopen="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Submit.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.Changelist">
- <summary>
- Changelist to submit.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.RemainOpen">
- <summary>
- Keep the files open after submitting. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.RevertUnchanged">
- <summary>
- Revert all unchanged or missing files from the changelist.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Submit.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.P4Sync">
- <summary>
- Synchronize client space to a Perforce depot view.
- </summary>
- <example>
- <para>
- Sync to head using P4USER, P4PORT and P4CLIENT settings specified.
- </para>
- <code>
- <![CDATA[
- <p4sync
- view="//projects/foo/main/source/..."
- user="fbloggs"
- port="km01:1666"
- client="fbloggsclient"
- />
- ]]>
- </code>
- </example>
- <example>
- <para>Sync to head using default p4 environment variables.</para>
- <code>
- <![CDATA[
- <p4sync view="//projects/foo/main/source/..." />
- ]]>
- </code>
- </example>
- <example>
- <para>Force a re-sync to head, refreshing all files.</para>
- <code>
- <![CDATA[
- <p4sync force="true" view="//projects/foo/main/source/..." />
- ]]>
- </code>
- </example>
- <example>
- <para>Sync to a label.</para>
- <code>
- <![CDATA[
- <p4sync label="myPerforceLabel" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.P4Sync.getSpecificCommandArguments">
- <summary>
- Builds the command string for this particular command.
- </summary>
- <returns>
- The command string for this particular command.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.Label">
- <summary> Label to sync client to; optional.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.Force">
- <summary>
- Force a refresh of files. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Perforce.P4Sync.CommandSpecificArguments">
- <summary>
- This is an override used by the base class to get command specific args.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Perforce.Perforce">
- <summary>
- Static helper class for Perforce tasks.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetUserName">
- <summary>
- ask p4 for the user name
- </summary>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetClient">
- <summary>
- ask p4 for the client name
- </summary>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetChangelistNumber(System.String,System.String,System.String,System.Boolean)">
- <summary>
- Get a changelist number based on on its name
- </summary>
- <param name="User"></param>
- <param name="Client"></param>
- <param name="ChangeList"></param>
- <param name="CreateIfMissing"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetChangelistNumber(System.String,System.String,System.String)">
- <summary>
- Get a changelist number based on on its name
- </summary>
- <param name="User"></param>
- <param name="Client"></param>
- <param name="ChangeList"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateLabel(System.String,System.String,System.String)">
- <summary>
- Create a new label
- </summary>
- <param name="User"></param>
- <param name="Labelname"></param>
- <param name="View"></param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateClient(System.String,System.String,System.String,System.String)">
- <summary>
- Create a new Client
- </summary>
- <param name="User"></param>
- <param name="Clientname"></param>
- <param name="Root"></param>
- <param name="View"></param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.CreateChangelist(System.String,System.String,System.String)">
- <summary>
- Create a new changelist
- </summary>
- <param name="User"></param>
- <param name="Client"></param>
- <param name="ChangeList">Description of Changelist</param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetP4Info(System.String)">
- <summary>
- call the p4 process to
- </summary>
- <param name="SearchPattern"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.GetP4Info(System.String[])">
- <summary>
- call the p4 process to
- </summary>
- <param name="SearchPatterns"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.getProcessOutput(System.String,System.String,System.String)">
- <summary>
- Execute a process and return its ourput
- </summary>
- <param name="exe"></param>
- <param name="prms"></param>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.RunProcess(System.String,System.String,System.String,System.String@)">
- <summary>
- Execute a process and return its ourput
- </summary>
- <param name="exe"></param>
- <param name="prms"></param>
- <param name="input"></param>
- <param name="output"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Perforce.Perforce.RunProcess(System.String,System.String,System.String)">
- <summary>
- Execute a process by name
- </summary>
- <param name="exe"></param>
- <param name="prms"></param>
- <param name="input"></param>
- <returns></returns>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.AddTask">
- <summary>
- 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.
- </summary>
- <remarks>
- This version does not support recursive adds. Only adds in the root directory will be added to the
- SourceSafe database.
- </remarks>
- <example>
- <code><![CDATA[
- <vssadd dbpath="C:\SourceSafeFolder\srcsafe.ini" user="user1" password="" path="$/Somefolder">
- <fileset basedir="C:\SourceFolder\">
- <include name="*.dll"/>
- </fileset>
- </vssadd>
- ]]></code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.BaseTask">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Open">
- <summary>
- Opens the Source Safe database and sets the reference to the specified
- item and version.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SourceSafe.BaseTask.GetFileTimestampFlags(NAnt.Contrib.Tasks.SourceSafe.FileTimestamp)">
- <summary>
- Gets the <see cref="T:SourceSafeTypeLib.VSSFlags"/> value corresponding with the
- specified <see cref="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp"/>.
- </summary>
- <param name="timestamp">A <see cref="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp"/>.</param>
- <returns>
- An <see cref="T:System.Int32"/> representing the <see cref="T:SourceSafeTypeLib.VSSFlags"/> value
- for the <paramref name="timestamp"/>.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.DBPath">
- <summary>
- The path to the folder that contains "srcsafe.ini".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Path">
- <summary>
- The Visual SourceSafe project or file path you wish the perform the
- action on (starting with "$/").
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Password">
- <summary>
- The password to use to login to the SourceSafe database.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName">
- <summary>
- The name of the user needed to access the Visual SourceSafe database.
- When no <see cref="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName"/> is specified and "Use network
- name for automatic user log in" is enabled for the Visual SourceSafe
- database, then the current Windows username will be used to log in.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Login">
- <summary>
- The name of the user needed to access the Visual SourceSafe database.
- When no <see cref="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.UserName"/> is specified and "Use network
- name for automatic user log in" is enabled, then the current
- Windows username will be used to log in.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.BaseTask.Version">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SourceSafe.AddTask.ExecuteTask">
- <summary>
- Main task execution method
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SourceSafe.AddTask.CreateProjectPath(System.String)">
- <summary>
- Create project hierarchy in vss
- </summary>
- <param name="file"></param>
- <returns></returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.AddTask.Comment">
- <summary>
- Places a comment on all files added into the SourceSafe repository.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.AddTask.AddFileSet">
- <summary>
- List of files that should be added to SourceSafe.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp">
- <summary>
- Defines how the local timestamp of files retrieved from a SourceSafe
- database should be set.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Current">
- <summary>
- The timestamp of the local file is set to the current date and time.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Modified">
- <summary>
- The timestamp of the local file is set to the file's last
- modification date and time.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.SourceSafe.FileTimestamp.Updated">
- <summary>
- The timestamp of the local file is set to the date and time that
- the file was last checked in to the database.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.CheckinTask">
- <summary>
- Used to checkin files into Visual Source Safe.
- </summary>
- <example>
- <para>Checkin all files from an absolute directory to a local sourcesafe database.</para>
- <code><![CDATA[
- <vsscheckin
- user="myusername"
- password="mypassword"
- localpath="C:\Dev\Latest"
- recursive="true"
- writable="true"
- dbpath="C:\VSS\srcsafe.ini"
- path="$/MyProduct"
- comment="NAnt checkin"
- />
- ]]></code>
- </example>
- <example>
- <para>Checkin a file from a relative directory to a remote sourcesafe database.</para>
- <code><![CDATA[
- <vsscheckin
- user="myusername"
- password="mypassword"
- localpath="Latest\myFile.cs"
- recursive="false"
- writable="true"
- dbpath="\\MyServer\VSS\srcsafe.ini"
- path="$/MyProduct/myFile.cs"
- comment="NAnt checkin"
- />
- ]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Comment">
- <summary>
- The comment for the new version.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.LocalPath">
- <summary>
- The path to the local working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Recursive">
- <summary>
- Determines whether to perform a recursive checkin.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckinTask.Writable">
- <summary>
- Determines whether to leave the file(s) as writable.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask">
- <summary>
- Task used to checkout files from Visual Source Safe.
- </summary>
- <example>
- <para>Checkout the latest files from a local sourcesafe database.</para>
- <code><![CDATA[
- <vsscheckout
- user="myusername"
- password="mypassword"
- localpath="C:\Dev\Latest"
- recursive="true"
- writable="true"
- dbpath="C:\VSS\srcsafe.ini"
- path="$/MyProduct"
- />
- ]]></code>
- </example>
- <example>
- <para>Checkout a file from a remote sourcesafe database. Put it in a relative directory.</para>
- <code><![CDATA[
- <vsscheckout
- user="myusername"
- password="mypassword"
- localpath="Latest"
- recursive="false"
- writable="true"
- dbpath="\\MyServer\VSS\srcsafe.ini"
- path="$/MyProduct/myFile.cs"
- />
- ]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.LocalPath">
- <summary>
- The path to the local working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.Recursive">
- <summary>
- Determines whether to perform a recursive checkout.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.Writable">
- <summary>
- Determines whether to leave the file(s) as writable.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.CheckoutTask.FileTimestamp">
- <summary>
- Set the behavior for timestamps of local files. The default is
- <see cref="F:FileTimestamp.Current" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.DeleteTask">
- <summary>
- Used to delete or Destroy files or projects in Visual Source Safe.
- </summary>
- <example>
- <para>Delete a project from a local sourcesafe database.</para>
- <code><![CDATA[
- <vssdelete
- user="myusername"
- password="mypassword"
- dbpath="C:\VSS\srcsafe.ini"
- path="$/MyProduct"
- />
- ]]></code>
- </example>
- <example>
- <para>Delete a file from the remote sourcesafe database.</para>
- <code><![CDATA[
- <vsscheckin
- user="myusername"
- password="mypassword"
- dbpath="\\MyServer\VSS\srcsafe.ini"
- path="$/MyProduct/myFile.cs"
- />
- ]]></code>
- </example>
- <example>
- <para>Destroy a project from a local sourcesafe database.</para>
- <code><![CDATA[
- <vssdelete
- user="myusername"
- password="mypassword"
- dbpath="C:\VSS\srcsafe.ini"
- path="$/MyProduct"
- Destroy="true"
- />
- ]]></code>
- </example>
- <example>
- <para>Destroy a file from the remote sourcesafe database.</para>
- <code><![CDATA[
- <vssdelete
- user="myusername"
- password="mypassword"
- dbpath="\\MyServer\VSS\srcsafe.ini"
- path="$/MyProduct/myFile.cs"
- Destroy="true"
- />
- ]]></code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.DeleteItem">
- <summary>
- Deletes the item unless <see cref="P:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.Destroy"/> is <see langword="true"/>
- then the item is destroyed.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.DeleteTask.Destroy">
- <summary>
- Determines whether or not the item is Destroyed.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.DiffTask">
- <summary>
- Used to generate differences in a vss database. It will show all changes to a project
- after the specified label.
- </summary>
- <remarks>
- This only shows differences between the current version and the version specified.
- </remarks>
- <example>
- <code><![CDATA[
- <vssdiff
- dbpath='ss.ini'
- path='$/My Project'
- label='My Label'
- user='ssuser'
- outputfile='diff.xml'
- />
- ]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.DiffTask.Label">
- <summary>
- The value of the label to compare to. Required.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.DiffTask.OutputFile">
- <summary>
- The output file to generate (xml)
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.GetTask">
- <summary>
- Used to retrieve an item or project from a Visual Source Safe database.
- </summary>
- <example>
- <para>Get the latest files from a local sourcesafe database.</para>
- <code><![CDATA[
- <vssget
- user="myusername"
- password="mypassword"
- localpath="C:\Dev\Latest"
- recursive="true"
- replace="true"
- writable="true"
- dbpath="C:\VSS\srcsafe.ini"
- path="$/MyProduct"
- />
- ]]></code>
- </example>
- <example>
- <para>Get the latest version of a file from a remote sourcesafe database. Put it in a relative directory.</para>
- <code><![CDATA[
- <vssget
- user="myusername"
- password="mypassword"
- localpath="Latest"
- recursive="true"
- replace="true"
- writable="true"
- dbpath="\\MyServer\VSS\srcsafe.ini"
- path="$/MyProduct/myFile.cs"
- />
- ]]></code>
- </example>
- <example>
- <para>Get the latest version of a file from a remote sourcesafe database. Remove any deleted files from local image.</para>
- <code><![CDATA[
- <vssget
- user="myusername"
- password="mypassword"
- localpath="C:\Dev\Latest"
- recursive="true"
- replace="true"
- writable="true"
- removedeleted="true"
- dbpath="\\MyServer\VSS\srcsafe.ini"
- path="$/MyProduct/myFile.cs"
- />
- ]]></code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeletedFromLocalImage">
- <summary>
- Checks to see if we should remove local copies of deleted files, and starts
- the scan.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeletedFromLocalImage(SourceSafeTypeLib.IVSSItem,System.String)">
- <summary>
- 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).
- </summary>
- <param name="item">The VSS Item (project) to check for deletions</param>
- <param name="localPathPrefix">The path to the folder of the item being processed</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.LocalPath">
- <summary>
- The path to the local working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Recursive">
- <summary>
- Determines whether to perform the get recursively.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Replace">
- <summary>
- Determines whether to replace writable files.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.Writable">
- <summary>
- Determines whether the files will be writable.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.RemoveDeleted">
- <summary>
- If <see cref="T:System.IO.Path"/> refers to a project, determines whether files
- marked "deleted" in the repository will be removed from the local
- copy. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.UseModificationTime">
- <summary>
- Determines whether the timestamp on the local copy
- will be the modification time (if false or omitted,
- the checkout time will be used)
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.GetTask.FileTimestamp">
- <summary>
- Set the behavior for timestamps of local files. The default is
- <see cref="F:FileTimestamp.Current" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.History">
- <summary>
- Generates an XML file showing all changes made to a Visual SourceSafe
- project/file between specified labels or dates (by a given user).
- </summary>
- <example>
- <para>
- Write all changes between "Release1" and "Release2" to XML file
- "changelog.xml".
- </para>
- <code>
- <![CDATA[
- <vsshistory
- dbpath="C:\VSS\srcsafe.ini"
- path="$/My Project"
- fromlabel="Release1"
- tolabel="Release2"
- output="changelog.xml" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Write all changes between January 1st 2004 and March 31st 2004 to XML
- file "history.xml".
- </para>
- <code>
- <![CDATA[
- <vsshistory
- dbpath="C:\VSS\srcsafe.ini"
- path="$/My Project"
- fromdate="01/01/2004"
- todate="03/31/2004"
- output="history.xml"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.FromLabel">
- <summary>
- The value of the label to start comparing to. If it is not included,
- the compare will start with the very first history item.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.ToLabel">
- <summary>
- The value of the label to compare up to. If it is not included,
- the compare will end with the last history item.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.FromDate">
- <summary>
- Start date for comparison.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.ToDate">
- <summary>
- End date for comparison.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Output">
- <summary>
- Output file to save history to (as XML).
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Recursive">
- <summary>
- Determines whether to perform the comparison recursively.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.User">
- <summary>
- Name of the user whose changes you want to see.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.VersionFlags">
- <summary>
- Gets the flags that should be used to retrieve the history of
- <see cref="T:System.IO.Path"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Login">
- <summary>
- Override to avoid exposing the corresponding attribute to build
- authors.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.History.Version">
- <summary>
- Override to avoid exposing the corresponding attribute to build
- authors.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.LabelTask">
- <summary>
- Used to apply a label to a Visual Source Safe item.
- </summary>
- <example>
- <para>Label all files in a local sourcesafe database. (Automatically applies the label recursively)</para>
- <code><![CDATA[
- <vsslabel
- user="myusername"
- password="mypassword"
- dbpath="C:\VSS\srcsafe.ini"
- path="$/MyProduct"
- comment="NAnt label"
- label="myLabel"
- />
- ]]></code>
- </example>
- <example>
- <para>Label a file in a remote sourcesafe database.</para>
- <code><![CDATA[
- <vsslabel
- user="myusername"
- password="mypassword"
- dbpath="\\MyServer\VSS\srcsafe.ini"
- path="$/MyProduct/myFile.cs"
- comment="NAnt label"
- label="myLabel"
- />
- ]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.LabelTask.Comment">
- <summary>
- The label comment.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.LabelTask.Label">
- <summary>
- The name of the label.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask">
- <summary>
- Task is used to undo a checkout from SourceSafe
- </summary>
- <example>
- <para>Undo a checkout of all of the files from a local sourcesafe database.</para>
- <code><![CDATA[
- <vssundocheckout
- user="myusername"
- password="mypassword"
- localpath="C:\Dev\Latest"
- recursive="true"
- dbpath="C:\VSS\srcsafe.ini"
- path="$/MyProduct"
- />
- ]]></code>
- </example>
- <example>
- <para>Checkout a file from a remote sourcesafe database. Put it in a relative directory.</para>
- <code><![CDATA[
- <vssundocheckout
- user="myusername"
- password="mypassword"
- localpath="Latest"
- recursive="false"
- dbpath="\\MyServer\VSS\srcsafe.ini"
- path="$/MyProduct/myFile.cs"
- />
- ]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask.LocalPath">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SourceSafe.UndoCheckoutTask.Recursive">
- <summary>
- Determines whether to perform a recursive undo of the checkout.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.StarTeam.LabelTask">
- <summary>
- Allows creation of view labels in StarTeam repositories.
- </summary>
- <remarks>
- <para>Often when building projects you wish to label the source control repository.</para>
- <para>By default this task creates view labels with the build option turned on.</para>
- <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel </para>
- <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
- </remarks>
- <example>
- <para>Creates a label in a StarTeam repository.</para>
- <code>
- <![CDATA[
- <!--
- constructs a 'url' containing connection information to pass to the task
- alternatively you can set each attribute manually
- -->
- <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
- <stlabel label="3.1 (label title goes here)" description="This is a label description" url="${ST.url}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamTask">
- <summary>
- Base star team task.
- </summary>
- <remarks>
- <para>
- Common super class for all StarTeam tasks. At this level of the hierarchy we are concerned only with obtaining a
- connection to the StarTeam server. The subclass <see cref="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask"/>, abstracts tree-walking
- behavior common to many subtasks.
- </para>
- <para>This class ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html </para>
- <para>You need to have the StarTeam SDK installed for StarTeam tasks to function correctly.</para>
- </remarks>
- <seealso cref="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask"/>
- <author> <a href="mailto:jcyip@thoughtworks.com">Jason Yip</a></author>
- <author> <a href="mailto:stevec@ignitesports.com">Steve Cohen</a></author>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._username">
- <value> The username of the connection</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._password">
- <value> The username of the connection</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._servername">
- <value> name of Starteam server to connect to</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._serverport">
- <value> port of Starteam server to connect to</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._projectname">
- <value> name of Starteam project to connect to</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._viewname">
- <value> name of Starteam view to connect to</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamTask._server">
- <value>The starteam server through which all activities will be done.</value>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.createSnapshotView(StarTeam.StView)">
- <summary>
- Derived classes must override this method to instantiate a view configured appropriately to its task.
- </summary>
- <param name="rawview">the unconfigured <code>View</code></param>
- <returns>the view appropriately configured.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.openView">
- <summary>
- All tasks will call on this method to connect to StarTeam and open the view for processing.
- </summary>
- <returns>the a view to be used for processing.</returns>
- <seealso cref="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.createSnapshotView(StarTeam.StView)"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.getUserName(System.Int32)">
- <summary> Returns the name of the user or a blank string if the user is not found.</summary>
- <param name="userID">a user's ID</param>
- <returns>the name of the user</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.servername">
- <summary>
- Name of StarTeamServer.
- </summary>
- <remarks>
- Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
- connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.serverport">
- <summary>
- Port number of the StarTeam connection.
- </summary>
- <remarks>
- Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
- connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.projectname">
- <summary>
- The name of the StarTeam project to be acted on
- </summary>
- <remarks>
- Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
- connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.viewname">
- <summary>
- The name of the StarTeam view to be acted on.
- </summary>
- <remarks>
- Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
- connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.username">
- <summary>
- The StarTeam user name used for login.
- </summary>
- <remarks>
- Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
- connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.password">
- <summary>
- The password used for login.
- </summary>
- <remarks>
- Required if <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/> is not set. If you wish to set all
- connection parameters at once set <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.url">
- <summary>
- One stop to set all parameters needed to connect to a StarTeam server.
- </summary>
- <remarks>
- <para>If you do not wish to specify a url you can set each parameter individually.
- You must set all connection parameters for the task to be able to connect to the StarTeam server.</para>
- </remarks>
- <example>
- <para>Here is how to configure the url string.</para>
- <code>servername:portnum/project/view</code>
- <para>You can optionally specify a username and password.</para>
- <code>username:password@servername:portnum/project/view</code>
- </example>
- <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.servername"/>
- <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.serverport"/>
- <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.projectname"/>
- <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.viewname"/>
- <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.username"/>
- <seealso cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamTask.password"/>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._labelName">
- <summary> The name of the label to be set in Starteam.</summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._description">
- <summary> The label description to be set in Starteam.</summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isBuildLabel">
- <summary> Is the label being created a build label.</summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._labelAsOfDate">
- <summary> If set the datetime to set the label as of.</summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isAsOfDateSet">
- <summary> 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</summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.LabelTask._isRevision">
- <summary> Does user wish to make a revision label?</summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.LabelTask.createSnapshotView(StarTeam.StView)">
- <summary>
- Override of base-class abstract function creates an appropriately configured view.
- For labels this a view configured as of this.lastBuild.
- </summary>
- <param name="raw">the unconfigured <code>View</code></param>
- <returns>the snapshot <code>View</code> appropriately configured.</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label">
- <summary>
- The name to be given to the label; required.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.BuildLabel">
- <summary> Should label be marked build : default is true</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.RevisionLabel">
- <summary>
- Should label created be a revision label. The default is
- <see langword="false"/>.
- </summary>
- <remarks>
- <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.BuildLabel"/> has no effect if this is set to <see langword="true"/>
- as revision labels cannot have a build status.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Description">
- <summary> Optional description of the label to be stored in the StarTeam project.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.LastBuild">
- <summary>
- Optional: If this property is set the label will be created as of the datetime specified.
- Please provide a datetime format that can be parsed via
- <see cref="M:System.DateTime.Parse(System.String,System.IFormatProvider)"/>.
- </summary>
- <remarks>
- This property is ignored when <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.RevisionLabel"/> set to
- <see langword="true"/>.
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel">
- <summary>
- Task for supporting labeling of repositories with incremented version
- numbers. The version number calculated will be concatenated to the
- <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label"/>.
- </summary>
- <remarks>
- <para>
- Instruments root of repository with <c>versionnumber.xml</c> file.
- </para>
- <para>
- If this file is not present, it is created and checked into StarTeam.
- The default version number is 1.0.0. By default the build number is
- incremented. Properties are present to allow setting and incrementing
- of major, minor, and build versions.
- </para>
- <para>
- When label is created, properties are set to expose version information
- and the new label :
- </para>
- <list type="bullet">
- <item>
- <description>label</description>
- </item>
- <item>
- <description>Version.text</description>
- </item>
- <item>
- <description>Version.major</description>
- </item>
- <item>
- <description>Version.minor</description>
- </item>
- <item>
- <description>Version.build</description>
- </item>
- </list>
- <note>
- Incrementing or setting major or minor versions does NOT reset the
- build version.
- </note>
- </remarks>
- <example>
- <para>Increment the build version.</para>
- <code>
- <![CDATA[
- <stautolabel url="${ST.url}" />
- ]]>
- </code>
- </example>
- <example>
- <para>Set the major version.</para>
- <code>
- <![CDATA[
- <stautolabel majorversion="2" url="${ST.url}" />
- ]]>
- </code>
- </example>
- <example>
- <para>Increment the minor version.</para>
- <code>
- <![CDATA[
- <stautolabel incrementminor="true" url="${ST.url}" />
- ]]>
- </code>
- </example>
- <example>
- <para>Example <c>versionnumber.xml</c> file.</para>
- <code>
- <![CDATA[
- <?xml version="1.0"?>
- <stautolabel>
- <version major="1" minor="0" build="0" />
- </stautolabel>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.ExecuteTask">
- <summary>
- Looks for versionnumber.xml at root of repository.
- Updates the xml in this file to correspond with properties set by user and checks in changes.
- A label is then created based on properties set.
- </summary>
- <remarks>
- Default behavior is to <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild"/> number.
- If user sets <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion"/>, <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion"/>, or <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion"/> no incrementing is done
- and the exact version set and/or read from versionnumber.xml is used.
- <para>The title of the Label is the <see cref="P:NAnt.Contrib.Tasks.StarTeam.LabelTask.Label"/> property concatenated with the version number Major.Minor.Build</para>
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.getVersionStFile(StarTeam.StView)">
- <summary>
- Locate the <c>versionnumber.xml</c> file in the repository. If it
- is not present, the file is created. The file is checked out
- exclusively for editing.
- </summary>
- <param name="snapshot">StarTeam view we are working with.</param>
- <returns>
- StarTeam file handle containing version xml.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.createVersionStFile(StarTeam.StFolder)">
- <summary>
- Creates the versionumber.xml file in the repository.
- </summary>
- <param name="stFolder">StarTeam folder desired to put the versionnumber.xml files into</param>
- <returns>StarTeam File handle to the created file.</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.VersionFile">
- <summary>
- Allows user to specify the filename where the version xml is stored.
- The default is <c>versionnumber.xml</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMajor">
- <summary>
- Increment major version number. The default is <see langword="false"/>.
- If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion"/> is set, this property is ignored.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMinor">
- <summary>
- Increment minor version number. The default is <see langword="false"/>.
- If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion"/> is set, this property is ignored.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild">
- <summary>
- Increment build version number. The default is <see langword="true"/>.
- If <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion"/> is set, this property is ignored.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MajorVersion">
- <summary>
- Major version number used for label. If this value is set,
- <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMajor"/> is ignored.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.MinorVersion">
- <summary>
- Minor version number used for label. If this value is set,
- <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementMinor"/> is ignored.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.BuildVersion">
- <summary>
- Build version number used for label.
- If this value is set. <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamAutoLabel.IncrementBuild"/> is ignored.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin">
- <summary>
- Task to check in files to StarTeam repositories.
- </summary>
- <remarks>
- <para>You add files to the repository that are not controlled by setting <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.adduncontrolled"/>.</para>
- <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stcheckin </para>
- <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
- </remarks>
- <example>
- <para>Recursively checks in all files in the project.</para>
- <code>
- <![CDATA[
- <!--
- constructs a 'url' containing connection information to pass to the task
- alternatively you can set each attribute manually
- -->
- <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
- <stcheckin forced="true" rootstarteamfolder="/" recursive="true" url="${ST.url}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask">
- <summary>
- Base for tree based star team tasks.
- </summary>
- <remarks>
- <para>
- Abstracts tree-walking behavior common to many subtasks.
- </para>
- <para>
- This class provides tree iteration functionality. Derived classes will implement their specific task
- functionally using the visitor pattern, specifically by implementing the method <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)"/>
- </para>
- <para>This class ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html </para>
- <para>You need to have the StarTeam SDK installed for StarTeam tasks to function correctly.</para>
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ExecuteTask">
- <summary>
- Does the work of opening the supplied Starteam view and calling
- the <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)"/> method setting the pattern in motion to perform the task.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.getLabelID(StarTeam.StView)">
- <summary>
- Helper method calls on the StarTeam API to retrieve an ID number for the specified view, corresponding to this.label.
- </summary>
- <returns>The Label identifier or <c>-1</c> if no label was provided.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.visit(StarTeam.StFolder,System.IO.FileInfo)">
- <summary> Derived classes must override this class to define actual processing to be performed on each folder in the tree defined for the task</summary>
- <param name="rootStarteamFolder">the StarTeam folderto be visited</param>
- <param name="rootLocalFolder">the local mapping of rootStarteamFolder</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.testPreconditions">
- <summary>
- Derived classes must override this method to define tests for any preconditons required by the task.
- This method is called at the beginning of the ExecuteTask method.
- </summary>
- <seealso cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ExecuteTask"/>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.listLocalFiles(System.IO.FileInfo)">
- <summary>
- 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.
- </summary>
- <remarks>
- The goal is to keep track of which local files are not controlled by StarTeam.
- </remarks>
- <param name="localFolder">Local folder to scan</param>
- <returns>hashtable whose keys represent a file or directory in localFolder.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.delistLocalFile(System.Collections.Hashtable,System.IO.FileInfo)">
- <summary>
- Removes file being worked with from the <see cref="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.listLocalFiles(System.IO.FileInfo)"/> generated hashtable.
- </summary>
- <remarks>
- The goal is to keep track of which local files are not controlled by StarTeam.
- </remarks>
- <param name="localFiles">Hashtable of the current directory's file|dire</param>
- <param name="thisfile">file to remove from list.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.IsIncluded(System.String)">
- <summary>
- Evaluates defined <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes"/> and <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Excludes"/> patterns against a filename.
- </summary>
- <param name="filePath"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.ToRegexPattern(System.String)">
- <summary>
- Lifted/Modified from <see cref="T:NAnt.Core.DirectoryScanner"/> to convert patterns to match filenames to regularexpressions.
- </summary>
- <param name="nantPattern">Search pattern - meant to be just a filename with no path info</param>
- <remarks>The directory seperation code in here most likely is overkill.</remarks>
- <returns>Regular expresssion for searching matching file names</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.populatePatterns(System.Collections.Specialized.StringCollection,System.Collections.Specialized.StringCollection@)">
- <summary>
- Convert path patterns to regularexpression patterns. Stored in the given string collection.
- </summary>
- <param name="paths">collection of paths to expand into regular expressions</param>
- <param name="patterns">collection to store the given regularexpression patterns</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.rootstarteamfolder">
- <summary>
- Root StarTeam folder to begin operations on. Defaults to the root of the view.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.RootLocalFolder">
- <summary>
- Root Local folder where files are to be checkout/in or manipulated. Defaults to the StarTeam default folder.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes">
- <summary>
- Accepts comma de-limited list of expressions to include in tree operations.
- If nothing is set ALL filespecs are included.
- </summary>
- <example>
- <para>Match all C# files in the directory</para>
- <code>*.cs</code>
- </example>
- <remarks>
- Expressions should be just for filename matching.
- Technically relative directory information is accepted but will never match.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Excludes">
- <summary>
- Accepts comma de-limited list of expressions to exclude from tree operations.
- If nothing is specified. NO filespecs are excluded.
- </summary>
- <example>
- <para>Match <b>No</b> C# files in the directory</para>
- <code>*.cs</code>
- </example>
- <remarks>
- <para>
- If a excludes pattern is set with no <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Includes"/> patterns present includes defaults to "*"
- </para>
- Expressions should be just for filename matching.
- Technically relative directory information is accepted but will never match.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.recursive">
- <summary>
- Default : true - should tasks recurse through tree.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Forced">
- <summary>
- Default : false - force check in/out actions regardless of the status that StarTeam is maintaining for the file.
- </summary>
- <remarks>
- <para>If <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.RootLocalFolder"/> is set then this property should be set <c>true</c>.
- Otherwise the checkout will be based on how the repository compares to local target folder.
- </para>
- <para>Note that if forced is not on. Files with status Modified and Merge will not be processed.</para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label">
- <summary>
- Label used for checkout. If no label is set latest state of repository is checked out.
- </summary>
- <remarks>
- The label must exist in starteam or an exception will be thrown.
- </remarks>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.starTeamLockTypeStatics">
- <summary>classes used to access static values</summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.starteamFolderFactory">
- <summary>Facotry classes used when files and folders are added to the repository. Populated when adduncontrolled is enabled.</summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._createFolders">
- <value> will folders be created for new items found with the checkin.</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._comment">
- <value> The comment which will be stored with the checkin.</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._addUncontrolled">
- <value> holder for the add Uncontrolled attribute. If true, all local files not in StarTeam will be added to the repository.</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin._lockStatus">
- <value> This attribute tells whether unlocked files on checkin (so that other users may access them) checkout or to
- leave the checkout status alone (default).
- </value>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.createSnapshotView(StarTeam.StView)">
- <summary>
- Override of base-class abstract function creates an appropriately configured view. For checkins this is
- always the current or "tip" view.
- </summary>
- <param name="raw">the unconfigured <code>View</code></param>
- <returns>the snapshot <code>View</code> appropriately configured.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.testPreconditions">
- <summary> Implements base-class abstract function to define tests for any preconditons required by the task</summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.visit(StarTeam.StFolder,System.IO.FileInfo)">
- <summary> Implements base-class abstract function to perform the checkin operation on the files in each folder of the tree.</summary>
- <param name="starteamFolder">the StarTeam folder to which files will be checked in</param>
- <param name="targetFolder">local folder from which files will be checked in</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.addUncontrolledItems(System.Collections.Hashtable,StarTeam.StFolder)">
- <summary> Adds to the StarTeam repository everything on the local machine that is not currently in the repository.</summary>
- <param name="localFiles">Hasttable containing files missing in the repository for the current folder</param>
- <param name="folder">StarTeam folder to which these items are to be added.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.add(StarTeam.StFolder,System.IO.FileInfo)">
- <summary> Adds the file or directpry to the repository.</summary>
- <param name="parentFolder">StarTeam folder underwhich items will be added.</param>
- <param name="file">the file or directory to add</param>
- <returns>true if the file was successfully added otherwise false.</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.adduncontrolled">
- <summary>
- if true, any files or folders NOT in StarTeam will be added to the repository. Defaults to "false".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckin.unlocked">
- <summary>
- 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.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout">
- <summary>
- Task to check out files from StarTeam repositories.
- </summary>
- <remarks>
- <para>You can check out by <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label"/> and control the type of lock with <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.locktype"/>.</para>
- <para>You can delete files that are not in source control by setting <see cref="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteuncontrolled"/>.</para>
- <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stcheckout </para>
- <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
- </remarks>
- <example>
- <para>Recursively checks out all files in the project with an exclusive lock.</para>
- <code>
- <![CDATA[
- <!--
- constructs a 'url' containing connection information to pass to the task
- alternatively you can set each attribute manually
- -->
- <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
- <stcheckout locktype="exclusive" rootstarteamfolder="/" recursive="true" url="${ST.url}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._createDirs">
- <value> holder for the createDirs property.</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._deleteUncontrolled">
- <value> holder for the deleteUncontrolled property.</value>
- </member>
- <member name="F:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout._lockStatus">
- <value> holder for the lockstatus property. </value>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.createSnapshotView(StarTeam.StView)">
- <summary>
- 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.
- </summary>
- <param name="raw">the unconfigured <code>StarTeam View</code></param>
- <returns>the snapshot <code>StarTeam View</code> appropriately configured.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.testPreconditions">
- <summary> Implements base-class abstract function to define tests for any preconditons required by the task</summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.visit(StarTeam.StFolder,System.IO.FileInfo)">
- <summary>
- Implements base-class abstract function to perform the checkout operation on the files in each folder of the tree.
- </summary>
- <param name="starteamFolder">the StarTeam folder from which files to be checked out</param>
- <param name="targetFolder">the local mapping of the starteam folder</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteUncontrolledItems(System.Collections.Hashtable)">
- <summary>
- Deletes everything on the local machine that is not in the repository.
- </summary>
- <param name="localFiles">Hashtable containing filenames to be deleted</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.delete(System.IO.FileInfo)">
- <summary> Utility method to delete the file (and it's children) from the local drive.</summary>
- <param name="file">the file or directory to delete.</param>
- <returns>was the file successfully deleted</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.createworkingdirs">
- <summary>
- Default : true - Create directories that are in the Starteam repository even if they are empty.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.deleteuncontrolled">
- <summary>
- <b>Not fully tested CAREFUL</b> Default : false - Should all local files <b>NOT</b> in StarTeam be deleted?
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.StarTeam.StarTeamCheckout.locktype">
- <summary>
- What type of lock to apply to files checked out.
- <list type="bullet">
- <listheader>
- <term>LockType</term>
- </listheader>
- <item>
- <term>unchanged</term>
- <description>default: do not make any changes to the lock state of items.</description>
- </item>
- <item>
- <term>exclusive</term>
- <description>Exclusively lock items. No other users can update the object while it is exclusively locked.</description>
- </item>
- <item>
- <term>nonexclusive</term>
- <description>Put a non-exclusive lock on the item.</description>
- </item>
- <item>
- <term>unlocked</term>
- <description>Remove locks from all items checked out. This accompanied by force would effectively override a lock and replace local contents with the current version.</description>
- </item>
- </list>
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamLabel">
- <summary>
- Allows creation of view labels in StarTeam repositories.
- </summary>
- <remarks>
- <para>Often when building projects you wish to label the source control repository.</para>
- <para>By default this task creates view labels with the build option turned on.</para>
- <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlabel </para>
- <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
- </remarks>
- <example>
- <para>Creates a label in a StarTeam repository.</para>
- <code>
- <![CDATA[
- <!--
- constructs a 'url' containing connection information to pass to the task
- alternatively you can set each attribute manually
- -->
- <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
- <stlabel label="3.1 (label title goes here)" description="This is a label description" url="${ST.url}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamLabel.ExecuteTask">
- <summary>
- This method does the work of creating the new view and checking it
- into Starteam.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.StarTeam.StarTeamList">
- <summary>
- List items in StarTeam repositories.
- </summary>
- <remarks>
- <para>This task was ported from the Ant task http://jakarta.apache.org/ant/manual/OptionalTasks/starteam.html#stlist </para>
- <para>You need to have the StarTeam SDK installed for this task to function correctly.</para>
- </remarks>
- <example>
- <para>Lists all files in a StarTeam repository.</para>
- <code>
- <![CDATA[
- <!--
- constructs a 'url' containing connection information to pass to the task
- alternatively you can set each attribute manually
- -->
- <property name="ST.url" value="user:pass@serverhost:49201/projectname/viewname" />
- <stlist rootstarteamfolder="/" recursive="true" url="${ST.url}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.createSnapshotView(StarTeam.StView)">
- <summary>
- Override of base-class abstract function creates an appropriately configured view for checkoutlists.
- The current view or a view of the label specified <see cref="P:NAnt.Contrib.Tasks.StarTeam.TreeBasedTask.Label"/>.
- </summary>
- <param name="raw">the unconfigured <c>View</c></param>
- <returns>the snapshot <c>View</c> appropriately configured.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.testPreconditions">
- <summary>Required base-class abstract function implementation is a no-op here.</summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.StarTeam.StarTeamList.visit(StarTeam.StFolder,System.IO.FileInfo)">
- <summary> Implements base-class abstract function to perform the checkout
- operation on the files in each folder of the tree.</summary>
- <param name="starteamFolder">the StarTeam folder from which files to be checked out</param>
- <param name="targetFolder">the local mapping of rootStarteamFolder</param>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch">
- <summary>
- Processes <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see> batch files.
- </summary>
- <remarks>
- 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.
- </remarks>
- <example>
- <para>
- Run the batch file <c>${src}/sscm.batch</c> on the server at localhost,
- port 4900 with username 'administrator' and a blank password. All script
- output is directed to the console.
- </para>
- <code>
- <sscmbatch
- serverconnect="localhost:4900"
- serverlogin="administrator:"
- input="${src}/sscm.batch"
- />
- </code>
- </example>
- <example>
- <para>
- Run the batch file <c>${src}/sscm.batch</c> on the server at localhost,
- port 4900 with username 'administrator' and a blank password. All script
- output is redirected to <c>${dist}/sscm.batch.out</c>.
- </para>
- <code>
- <sscmbatch
- serverconnect="localhost:4900"
- serverconnect="administrator:"
- input="${src}/sscm.batch"
- output="${dist}/sscm.batch.out"
- />
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask">
- <summary>
- <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
- abstract task base.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ServerConnect">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ServerLogin">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ExeName">
- <summary>
- Override ExeName paramater to sscm.exe for Surround SCM.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMTask.ProgramArguments">
- <summary>
- Gets the command line arguments for the external program.
- </summary>
- <value>
- The command line arguments for the external program.
- </value>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.InputFile">
- <summary>
- File to read commands from.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBatch.OutputFile">
- <summary>
- 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.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch">
- <summary>
- Creates new branches for <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>.
- </summary>
- <example>
- <para>
- 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.
- </para>
- <code>
- <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"
- />
- </code>
- </example>
- <example>
- <para>
- Create a new Workspace branch 'MyWidgetDevelopment' from branch
- 'Widget 1.0', repository 'Mainline/Widget'. All files are branched
- at the tip version.
- </para>
- <code>
- <sscmbranch
- serverconnect="localhost:4900"
- serverlogin="administrator:"
- branch="MyWidgetDevelopment"
- repository="Mainline/Widget"
- parent="Widget 1.0"
- />
- </code>
- </example>
- <example>
- <para>
- 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.
- </para>
- <code>
- <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"
- />
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Branch">
- <summary>
- The name of the branch you want to create.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Repository">
- <summary>
- The full repository path.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ParentBranch">
- <summary>
- The parent branch you want to create the new, child branch from.
- If not specified, the mainline branch is used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Comment">
- <summary>
- Specifies a comment for the branch operation.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel">
- <summary>
- Specifies which parent branch file versions are copied into the
- child branch.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByTimestamp">
- <summary>
- Specifies which parent branch file versions are copied into the
- child branch. Format is yyyymmddhh:mm:ss. If <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel"/>
- attribute is specified, this parameter is ignored.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.IncludeRemoved">
- <summary>
- Include removed files when creating a branch with the
- <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByLabel"/> or <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.ByTimestamp"/> option.
- The default is <see langword="true"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMBranch.Type">
- <summary>
- Specifies the type of branch you want to create. Possible values are
- <c>workspace</c>, <c>baseline</c>, or <c>snapshot</c>. The default is
- <c>workspace</c>.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin">
- <summary>
- Checks in files in <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
- repository.
- </summary>
- <remarks>
- Check in updated Surround SCM files with changes, removes the lock on
- the files, and makes changes available to other users.
- </remarks>
- <example>
- <para>
- 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.
- </para>
- <code>
- <sscmcheckin
- serverconnect="localhost:4900"
- serverlogin="administrator:"
- file="/"
- branch="Widget 1.0"
- repository="Mainline/Widget"
- recursive="true"
- comment="I made some changes"
- />
- </code>
- </example>
- <example>
- <para>
- 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.
- </para>
- <code>
- <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"
- />
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Branch">
- <summary>
- Surround SCM branch name. The default is pulled from the local
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Repository">
- <summary>
- Surround SCM repository path. The default is pulled from the local
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.File">
- <summary>
- File or repository name. Can be / or empty, which means the
- repository specified by the repository option or the default
- repository.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Comment">
- <summary>
- Comment for the check-in.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.SkipAutomerge">
- <summary>
- Force check in without merge. Ignores code changes checked in after
- the user's last checkout or merge. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.GetLocal">
- <summary>
- Get file after check in. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.KeepLocked">
- <summary>
- Keep the lock after check in. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Label">
- <summary>
- A label for the check in code.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.OverwriteLabel">
- <summary>
- Overwrite previous label on file. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Quiet">
- <summary>
- Do not list repository and local full path of the Surround
- SCM server. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Recursive">
- <summary>
- Recursively check in all files and sub-repositories.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpDatabase">
- <summary>
- The TestTrack Pro database configuration name.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpLogin">
- <summary>
- The TestTrack Pro username and password.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.TtpDefects">
- <summary>
- The TestTrack Pro defect number(s) for attachment. Format is "#:#:#:#".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.Writable">
- <summary>
- Make file writable after check in. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.ForceUpdate">
- <summary>
- Update version even if no changes. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckin.DeleteLocal">
- <summary>
- Remove local file after check in. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout">
- <summary>
- Checks out files from a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
- repository.
- </summary>
- <remarks>
- 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.
- </remarks>
- <example>
- <para>
- 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.
- </para>
- <code>
- <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"
- />
- </code>
- </example>
- <example>
- <para>
- 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.
- </para>
- <code>
- <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"
- />
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Branch">
- <summary>
- Surround SCM branch name. The default is pulled from the local
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Repository">
- <summary>
- Surround SCM repository path. The default is pulled from the local
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.File">
- <summary>
- File or repository name. Can be / or empty, which means the
- repository specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Repository"/> attribute
- or the default repository.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Comment">
- <summary>
- Comment for the check-out.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Force">
- <summary>
- Force file retrieval from server regardless of the local copy status.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Quiet">
- <summary>
- Do not list repository and local full path of the Surround SCM server.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Recursive">
- <summary>
- Recursively get files and sub-repositories. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Overwrite">
- <summary>
- Specifies whether to overwrite local writable files. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Timestamp">
- <summary>
- Specifies how to set the local file's date/time. Possible values are
- <c>current</c>, <c>modify</c> or <c>checkin</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Exclusive">
- <summary>
- Exclusively lock the files. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.Version">
- <summary>
- Specifies the file version to check out. Ignored if no specific
- filename is set using the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMCheckout.File"/> attribute.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze">
- <summary>
- Freezes branches in a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
- repository.
- </summary>
- <remarks>
- 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.
- </remarks>
- <example>
- <para>
- 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.
- </para>
- <code>
- <sscmfreeze
- serverconnect="localhost:4900"
- serverlogin="administrator:"
- mainline="Mainline"
- branch="Widget 1.0"
- />
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.Branch">
- <summary>
- Surround SCM branch name.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMFreeze.Mainline">
- <summary>
- Surround SCM mainline branch name. The default is pulled from the
- local working directory.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet">
- <summary>
- Gets files from a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
- repository.
- </summary>
- <remarks>
- You can get a single file, multiple files, or a repository. A read-only
- copy of the file is created in the specified directory.
- </remarks>
- <example>
- <para>
- 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.
- </para>
- <code>
- <sscmget
- serverconnect="localhost:4900"
- serverlogin="administrator:"
- file="/"
- branch="Widget 1.0"
- repository="Mainline/Widget"
- recursive="true"
- force="true"
- overwrite="true"
- />
- </code>
- </example>
- <example>
- <para>
- 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.
- </para>
- <code>
- <sscmget
- serverconnect="localhost:4900"
- serverlogin="administrator:"
- quiet="true"
- file="Widget.java"
- branch="Widget 1.0"
- repository="Mainline/Widget"
- overwrite="false"
- writable="true"
- version="1"
- />
- </code>
- </example>
- <example>
- <para>
- 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.
- </para>
- <code>
- <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"
- />
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Branch">
- <summary>
- Surround SCM branch name. The default is pulled from the local
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Repository">
- <summary>
- Surround SCM repository path. The default is pulled from the local
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File">
- <summary>
- File or repository name. Can be / or empty, which means the repository
- specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Repository"/> attribute or the default
- repository.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.DestinationDirectory">
- <summary>
- The local directory you want to get the files to. If
- <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> is a repository, a subrepository with the same
- name as the repository is created and files are copied to it. If
- <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> is specified as / or not set, files are copied to
- the local directory. If not specified, files are copied to the
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Writable">
- <summary>
- Make local file editable or writable. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Force">
- <summary>
- Force file retrieval from server regardless of the local copy status.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByLabel">
- <summary>
- Label to search for when getting a file. If a file version is
- specified, this parameter is ignored.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByTimestamp">
- <summary>
- Timestamp to use when getting files. Format is yyyymmddhh:mm:ss.
- If <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.ByLabel"/> is specified, this parameter is ignored.
- Requires Surround SCM 3.0 or later.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.IncludeRemoved">
- <summary>
- Include removed files when getting files by label or timestamp.
- The default is <see langword="true" />. Ignored if a label or
- timestamp is not specified.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Quiet">
- <summary>
- Do not list repository and local full path of files. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Recursive">
- <summary>
- Recursively get files and sub-repositories. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Overwrite">
- <summary>
- Specifies whether to overwrite local writable files. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Timestamp">
- <summary>
- Specifies how to set the local file's date/time. Possible values are
- <c>current</c>, <c>modify</c> or <c>checkin</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.Version">
- <summary>
- The file version to get. Ignored if a filename is not specified in
- the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMGet.File"/> attribute.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel">
- <summary>
- Creates file or repository labels for a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
- repository.
- </summary>
- <remarks>
- 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.
- </remarks>
- <example>
- <para>
- Label all files under the 'Mainline/Widget' repository recursively in
- the 'Widget 1.0' branch with 'Release 1.0.1' and the given comment.
- </para>
- <code>
- <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."
- />
- </code>
- </example>
- <example>
- <para>
- Label all files under the 'Mainline/Widget' repository recursively in
- the 'Widget 1.0' branch with 'Release 1.0.1' and no comments.
- </para>
- <code>
- <sscmlabel
- serverconnect="localhost:4900"
- serverlogin="administrator:"
- branch="Widget 1.0"
- repository="Mainline/Widget"
- file="readme.txt"
- recursive="true"
- label="Release 1.0.1"
- />
- </code>
- </example>
- <example>
- <para>
- 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.
- </para>
- <code>
- <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"
- />
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Branch">
- <summary>
- Surround SCM branch name. The default is pulled from the local
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Repository">
- <summary>
- Surround SCM repository path. The default is pulled from the local
- working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.File">
- <summary>
- File or repository name. Can be / or empty, which means the
- repository specified by the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Repository"/> attribute
- or the default repository.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Label">
- <summary>
- The new label to create.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Recursive">
- <summary>
- Recursively label all files. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Overwrite">
- <summary>
- Overwrite the existing label. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Comment">
- <summary>
- Comment for the label.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.Version">
- <summary>
- The file version to label. Ignored if a filename is not specified in
- the <see cref="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMLabel.File"/> attribute.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze">
- <summary>
- Unlocks frozen branches for a <see href="http://www.seapine.com/surroundscm.html">Surround SCM</see>
- repository.
- </summary>
- <example>
- <para>
- 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.
- </para>
- <code>
- <sscmunfreeze
- serverconnect="localhost:4900"
- serverlogin="administrator:"
- mainline="Mainline"
- branch="Widget 1.0"
- />
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.WriteCommandLineArguments(System.Text.StringBuilder)">
- <summary>
- Writes the task-specific arguments to the specified
- <see cref="T:System.Text.StringBuilder"/>.
- </summary>
- <param name="argBuilder">The <see cref="T:System.Text.StringBuilder"/> to write the task-specific arguments to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.Branch">
- <summary>
- Surround SCM branch name.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SurroundSCM.SSCMUnFreeze.Mainline">
- <summary>
- Surround SCM mainline branch name. The default is pulled from the local working directory.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Svn.AbstractSvnTask">
- <summary>
- A base class for creating tasks for executing CVS client commands on a
- CVS repository.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_HOME">
- <summary>
- An environment variable that holds path information about where
- svn is located.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.ARG_PREFIX">
- <summary>
- The prefix used for command arguments.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_EXE">
- <summary>
- The name of the svn executable.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_RSH">
- <summary>
- Environment variable that holds the executable name that is used for
- ssh communication.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SVN_PASSFILE">
- <summary>
- Name of the password file that is used to cash password settings.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.Svn.AbstractSvnTask"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Build up the command line arguments, determine which executable is being
- used and find the path to that executable and set the working
- directory.
- </summary>
- <param name="process">The process to prepare.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.AppendCommandOptions">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.GetSvnExePath">
- <summary>
- Gets the full path of the svn executable.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- Exception is thrown when Subversion client
- executable cannot be found.
- </exception>
- <returns>
- The full path of the svn executable.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SetPropertiesDefaults">
- <summary>
- Set default values for non-requiered parameters.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.VcsExeName">
- <summary>
- The name of the executable.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.PassFileName">
- <summary>
- The name of the password file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.VcsHomeEnv">
- <summary>
- Name of the home environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.SshEnv">
- <summary>
- The name of the ssh/ rsh environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.ExeName">
- <summary>
- The full path of the svn executable.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Root">
- <summary>
- <para>
- 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
- </para>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.UserName">
- <summary>
- The user performing the checkout.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Password">
- <summary>
- The pasword to use to login to svn.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Interactive">
- <summary>
- Indicates whether the task should be interactive or not. This is
- set to <see langword="false" /> by default, and I don't see a reason
- to expose this to the NAnt task.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Ssh">
- <summary>
- The executable to use for ssh communication.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.CommandName">
- <summary>
- The command to execute.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.Quiet">
- <summary>
- Specifies whether to print as little information as possible.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.AbstractSvnTask.IsRootUsed">
- <summary>
- Determines if the root is used for the command based on
- the command name. Returns <code>true</code> if the root
- is used, otherwise returns <code>false</code>.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask">
- <summary>
- Executes the svn checkout command.
- </summary>
- <example>
- <para>Checkout Gentle.NET.</para>
- <code>
- <![CDATA[
- <svn-update
- destination="c:/dev/src/gentle.net"
- uri="http://www.mertner.com/svn/repos/projects/gentle"
- recursive="true"
- verbose="false"
- username="anonymoose"
- password="Canada"
- revision="HEAD"
- cache-auth="false"
- config-dir="c:\home"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.#ctor">
- <summary>
- Initialize the task, and set the default parameters.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.CommandName">
- <summary>
- Gets the svn command to execute.
- </summary>
- <value>
- The svn command to execute. The default value is "checkout".
- </value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.Recursive">
- <summary>
- <see langword="true" /> if the command should be executed recursively.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.Revision">
- <summary>
- The revision to checkout. If no revision is specified then subversion
- will return the <code>HEAD</code>.
- </summary>
- <remarks>
- 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
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.CacheAuth">
- <summary>
- <see langword="true" /> if the authentiction token should be cached
- locally.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.SvnCheckoutTask.ConfigDir">
- <summary>
- The location of the configuration directory.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Svn.SvnTask">
- <summary>
- Executes the svn command specified by the command attribute.
- </summary>
- <example>
- <para>Checkout Gentle.NET.</para>
- <code>
- <![CDATA[
- <svn command="checkout"
- destination="c:\dev\src\gentle.net"
- svnroot="http://www.mertner.com/svn/repos/projects/gentle"
- password="" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.SvnTask.CommandName">
- <summary>
- The svn command to execute.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Svn.SvnUpdateTask">
- <summary>
- Executes the svn update specified by the command attribute.
- </summary>
- <example>
- <para>Update Gentle.NET.</para>
- <code>
- <![CDATA[
- <svn-update
- destination="c:\dev\src\gentle.net"
- uri="http://www.mertner.com/svn/repos/projects/gentle"
- recursive="true"
- quiet="true"
- username="anonymoose"
- password="Canada"
- revision="HEAD"
- cach-auth="false"
- config-dir="c:\home"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Svn.SvnUpdateTask.CommandName">
- <summary>
- Gets the svn command to execute.
- </summary>
- <value>
- The svn command to execute. The default value is "update".
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Web.ApplicationPool">
- <summary>
- Allows an IIS application pool to be controlled.
- </summary>
- <example>
- <para>
- Starts the "StsAdminAppPool" application pool on server
- "SV-ARD-WEB".
- </para>
- <code>
- <![CDATA[
- <iisapppool action="Start" pool="StsAdminPool" server="SV-ARD-WEB" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Stops and restarts the "DefaultAppPool" application pool
- on server "SV-ARD-WEB".
- </para>
- <code>
- <![CDATA[
- <iisapppool action="Restart" pool="DefaultAppPool" server="SV-ARD-WEB" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.ApplicationPool.Server">
- <summary>
- The name of the server on which to perform the action. The default
- is the local computer.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.ApplicationPool.PoolName">
- <summary>
- The name of the application pool on which to perform the action.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.ApplicationPool.Action">
- <summary>
- The action that should be performed on the application pool.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction">
- <summary>
- Defines the actions that can be performed on an application pool.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction.Start">
- <summary>
- Starts the application pool.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction.Stop">
- <summary>
- Stops the application pool.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction.Restart">
- <summary>
- Stops and restarts the application pool.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Web.ApplicationPool.ApplicationPoolAction.Recycle">
- <summary>
- Recycles an application pool.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory">
- <summary>
- Creates or modifies a virtual directory of a web site hosted on Internet
- Information Server.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- <para>
- For a list of optional parameters see <see href="ms-help://MS.VSCC/MS.MSDNVS/iisref/html/psdk/asp/aore8v5e.htm">IIsWebVirtualDir</see>.
- </para>
- <para>
- More information on metabase parameters is available <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/iissdk/iis/alphabeticmetabasepropertylist.asp">here</see>.
- </para>
- </remarks>
- <example>
- <para>
- Create a virtual directory named <c>Temp</c> pointing to <c>c:\temp</c>
- on the local machine.
- </para>
- <code>
- <![CDATA[
- <mkiisdir dirpath="c:\temp" vdirname="Temp" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Create a virtual directory named <c>Temp</c> pointing to <c>c:\temp</c>
- on machine <c>Staging</c>.
- </para>
- <code>
- <![CDATA[
- <mkiisdir iisserver="Staging" dirpath="c:\temp" vdirname="Temp" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Configure the home directory of for http://svc.here.dev/ to point to
- D:\Develop\Here and require authentication
- </para>
- <code>
- <![CDATA[
- <mkiisdir iisserver="svc.here.dev" dirpath="D:\Develop\Here" vdirname="/" authanonymous="false"/>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Create a virtual directory named <c>WebServices/Dev</c> pointing to
- <c>c:\MyProject\dev</c> on the web site running on port <c>81</c> of
- machine <c>MyHost</c>.
- </para>
- <code>
- <![CDATA[
- <mkiisdir iisserver="MyHost:81" dirpath="c:\MyProject\dev" vdirname="WebServices/Dev" />
- ]]>
- </code>
- Note that if <c>WebServices</c> is neither an existing virtual directory nor an
- existing physical subdirectory of the web root, your IIS Management Console
- will get confused. Even though <c>http://MyHost:81/WebServices/Dev/theService.asmx</c>
- may be a perfectly working webservice, the Management Console will not show it.
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Web.WebBase">
- <summary>
- Base class for all IIS-related task.
- </summary>
- <remarks>
- Basically this class hold the logic to determine the IIS version as well
- as the IIS server/port determination/checking logic.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.WebBase.VirtualDirectory">
- <summary>
- Name of the IIS virtual directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Server">
- <summary>
- The IIS server, which can be specified using the format <c>[host]:[port]</c>.
- The default is <c>localhost:80</c>.
- </summary>
- <remarks>
- <para>
- This allows for targeting a specific virtual site on a physical box.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Website">
- <summary>
- The website on the IIS server.
- </summary>
- <remarks>
- <para>
- This allows for targeting a specific virtual site on a physical box.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.WebBase.Version">
- <summary>
- Gets the version of IIS corresponding with the current OS.
- </summary>
- <value>
- The version of IIS corresponding with the current OS.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Web.WebBase.IISVersion">
- <summary>
- Defines the IIS versions supported by the IIS tasks.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppFriendlyName">
- <summary>
- The user-friendly name of the package or application.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirPath">
- <summary>
- The file system path.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute">
- <summary>
- Indicates whether the file or the contents of the folder may be
- executed, regardless of file type. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteExecute">
- <summary>
- Indicates whether remote requests to execute applications are denied;
- only requests from the same computer as the IIS server succeed if
- <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> is set to <see langword="true"/>. You
- cannot set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteExecute"/> to <see langword="false"/>
- to enable remote requests, and set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> to
- <see langword="false"/> to disable local requests. The default is
- <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteRead">
- <summary>
- Indicates whether remote requests to view files are denied;
- only requests from the same computer as the IIS server succeed if
- <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessExecute"/> is set to <see langword="true"/>. You
- cannot set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteRead"/> to <see langword="false"/>
- to enable remote requests, and set <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessRead"/> to
- <see langword="false"/> to disable local requests. The default is
- <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteScript">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessNoRemoteWrite">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessRead">
- <summary>
- Indicates whether the file or the contents of the folder may be
- read. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSource">
- <summary>
- Indicates whether users are allowed to access source code if either
- Read or Write permissions are set. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessScript">
- <summary>
- Indicates whether the file or the contents of the folder may be
- executed if they are script files or static content. The default
- is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSsl">
- <summary>
- Indicates whether file access requires SSL file permission processing,
- with or without a client certificate. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccesssSl128">
- <summary>
- 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 <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslMapCert">
- <summary>
- Indicates whether SSL file permission processing maps a client
- certificate to a Microsoft Windows ® operating system user-account.
- <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert"/> must also be set to
- <see langword="true"/> for the mapping to occur. The default is
- <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert">
- <summary>
- Indicates whether SSL file access processing requests a certificate
- from the client. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslRequireCert">
- <summary>
- Indicates whether SSL file access processing requests a certificate
- from the client. If the client provides no certificate, the connection
- is closed. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslNegotiateCert"/> must also be set to
- <see langword="true"/> when using <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessSslRequireCert"/>.
- The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AccessWrite">
- <summary>
- 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
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AnonymousPasswordSync">
- <summary>
- Indicates whether IIS should handle the user password for anonymous
- users attempting to access resources. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppCreate">
- <summary>
- Specifies what type of application to create for this virtual directory.
- The default is <see cref="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.Pooled"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppAllowClientDebug">
- <summary>
- Specifies whether ASP client-side debugging is enabled. The default
- is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppAllowDebugging">
- <summary>
- Specifies whether ASP debugging is enabled on the server. The default
- is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppPoolId">
- <summary>
- Specifies the application pool where the application is routed
- (IIS 6.0 or higher).
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspAllowSessionState">
- <summary>
- Enables session state persistence for the ASP application. The
- default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspBufferingOn">
- <summary>
- Specifies whether output from an ASP application will be buffered.
- If <see langword="true" />, 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
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableApplicationRestart">
- <summary>
- Determines whether an ASP application can be automatically restarted.
- When changes are made to Global.asa or metabase properties that affect
- an application, the application will not restart unless the
- <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableApplicationRestart"/> property is set to
- <see langword="false"/>. The default is <see langword="true"/>.
- </summary>
- <remarks>
- When this property is changed from <see langword="false"/> to
- <see langword="true"/>, the application immediately restarts.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableAspHtmlFallback">
- <summary>
- Controls the behavior of ASP when a new request is to be rejected
- due to a full request queue. If <see langword="true" />, 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
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableChunkedEncoding">
- <summary>
- Specifies whether HTTP 1.1 chunked transfer encoding is enabled for
- the World Wide Web Publishing Service (WWW service). The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog">
- <summary>
- Specifies which ASP errors are written to the Windows event log.
- </summary>
- <remarks>
- <para>
- ASP errors are written to the client browser and to the IIS log files
- by default. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
- by default, and is modified by <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> in
- the following way:
- </para>
- <para>
- If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="false"/>,
- then ASP errors are not written to the Windows event log, regardless
- of the value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.
- </para>
- <para>
- If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>,
- and if IIS fails to write an item to the IIS log file, the item is
- written to the Windows event log as a warning, regardless of the
- value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.
- </para>
- <para>
- If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
- and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="false"/>,
- then only the most serious ASP errors are sent to the Windows event log.
- Serious ASP error numbers are: 100, 101, 102, 103, 104, 105, 106, 107,
- 115, 190, 191, 192, 193, 194, 240, 241, and 242.
- </para>
- <para>
- If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
- and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="true"/>,
- then all ASP errors are written to the Windows event log.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableParentPaths">
- <summary>
- Specifies whether an ASP page allows paths relative to the current
- directory. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspEnableTypelibCache">
- <summary>
- Specifies whether type libraries are cached on the server. The
- default is <see langword="true" />.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspExceptionCatchEnable">
- <summary>
- Specifies whether ASP pages trap exceptions thrown by components.
- If set to <see langword="false" />, the Microsoft Script Debugger tool
- does not catch exceptions sent by the component that you are debugging.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests">
- <summary>
- Controls whether the Web server writes ASP errors to the application
- section of the Windows event log. The default is <see langword="true"/>.
- </summary>
- <remarks>
- <para>
- ASP errors are written to the client browser and to the IIS log files
- by default. <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
- by default, and is modified by <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> in
- the following way:
- </para>
- <para>
- If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="false"/>,
- then ASP errors are not written to the Windows event log, regardless
- of the value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.
- </para>
- <para>
- If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>,
- and if IIS fails to write an item to the IIS log file, the item is
- written to the Windows event log as a warning, regardless of the
- value of <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/>.
- </para>
- <para>
- If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
- and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="false"/>,
- then only the most serious ASP errors are sent to the Windows event log.
- Serious ASP error numbers are: 100, 101, 102, 103, 104, 105, 106, 107,
- 115, 190, 191, 192, 193, 194, 240, 241, and 242.
- </para>
- <para>
- If <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspLogErrorRequests"/> is set to <see langword="true"/>
- and <see cref="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspErrorsToNTLog"/> is set to <see langword="true"/>,
- then all ASP errors are written to the Windows event log.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspScriptErrorSentToBrowser">
- <summary>
- 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 <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspThreadGateEnabled">
- <summary>
- Indicates whether IIS thread gating is enabled (only applies to IIS 4 and 5).
- The default is <see langword="false" />.
- </summary>
- <remarks>
- IIS performs thread gating to dynamically control the number of
- concurrently executing threads, in response to varying load conditions.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspTrackThreadingModel">
- <summary>
- Specifies whether IIS checks the threading model of any components
- that your application creates. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthAnonymous">
- <summary>
- Specifies Anonymous authentication as one of the possible authentication
- schemes returned to clients as being available. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthBasic">
- <summary>
- Specifies Basic authentication as one of the possible authentication
- schemes returned to clients as being available. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthNtlm">
- <summary>
- Specifies Integrated Windows authentication as one of the possible
- authentication schemes returned to clients as being available. The
- default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequest">
- <summary>
- 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.
- </summary>
- <remarks>
- [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.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequestIfProxy">
- <summary>
- 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 <see langword="false" />
- </summary>
- <remarks>
- 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
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AuthPersistSingleRequestAlwaysIfProxy">
- <summary>
- 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 <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CacheControlNoCache">
- <summary>
- Specifies whether the HTTP 1.1 directive to prevent caching of content
- should be sent to clients. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CacheIsapi">
- <summary>
- Indicates whether ISAPI extensions are cached in memory after first
- use. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.ContentIndexed">
- <summary>
- Specifies whether the installed content indexer should index content
- under this directory tree. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CpuAppEnabled">
- <summary>
- Specifies whether process accounting and throttling should be performed
- for ISAPI extensions and ASP applications. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CpuCgiEnabled">
- <summary>
- Indicates whether IIS should perform process accounting for CGI
- applications. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CreateCgiWithNewConsole">
- <summary>
- Indicates whether a CGI application runs in its own console. The
- default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.CreateProcessAsUser">
- <summary>
- Specifies whether a CGI process is created in the system context
- or in the context of the requesting user. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowDate">
- <summary>
- Specifies whether date information is displayed when browsing
- directories. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowExtension">
- <summary>
- Specifies whether file extensions are displayed when browsing
- directories. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowLongDate">
- <summary>
- Specifies whether date information is displayed in extended format
- when displaying directories. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowSize">
- <summary>
- Specifies whether file size information is displayed when displaying
- directories. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DirBrowseShowTime">
- <summary>
- Specifies whether file creation time is displayed when browsing
- directories. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DontLog">
- <summary>
- Specifies whether client requests are written to the IIS log files.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDefaultDoc">
- <summary>
- When set to true, the default document (specified by the DefaultDoc property) for a directory is loaded when the directory is browsed.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDirBrowsing">
- <summary>
- Specifies whether directory browsing is enabled. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableDocFooter">
- <summary>
- Enables or disables custom footers. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.EnableReverseDns">
- <summary>
- Enables or disables reverse Domain Name Server (DNS) lookups for
- the World Wide Web Publishing Service (WWW service). The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.SsiExecDisable">
- <summary>
- Specifies whether server-side include (SSI) #exec directives are
- disabled under this path. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncAuthenticationPassthrough">
- <summary>
-
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AspScriptErrorMessage">
- <summary>
-
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.DefaultDoc">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncUserName">
- <summary>
- Specifies the user name for Universal Naming Convention (UNC) virtual
- roots.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.UncPassword">
- <summary>
- Specifies the encrypted password used to gain access to UNC
- (Universal Naming Convention) virtual roots.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType">
- <summary>
- The different ways a (virtual) directory in IIS can be configured
- as an application.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.None">
- <summary>
- Virtual directory is not configured as an application.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.InProcess">
- <summary>
- Virtual directory is configured as an in-process application.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.Pooled">
- <summary>
- Virtual directory is configured as a pooled out-of-process
- application. For IIS4 this is the same as <see cref="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.OutOfProcess"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Web.CreateVirtualDirectory.AppType.OutOfProcess">
- <summary>
- Virtual directory is configured as an out-of-process application.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Web.DeleteVirtualDirectory">
- <summary>
- Deletes a virtual directory from a given web site hosted on Internet
- Information Server.
- </summary>
- <example>
- <para>
- Delete a virtual directory named <c>Temp</c> from the web site running
- on port <c>80</c> of the local machine. If more than one web site is
- running on port <c>80</c>, take the web site bound to the hostname
- <c>localhost</c> if existent or bound to no hostname otherwise.
- </para>
- <code>
- <![CDATA[
- <deliisdir vdirname="Temp" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Delete a virtual directory named <c>Temp</c> from the website running
- on port <c>81</c> of machine <c>MyHost</c>.
- </para>
- <code>
- <![CDATA[
- <deliisdir iisserver="MyHost:81" vdirname="Temp" />
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Web.VirtualDirectoryInfo">
- <summary>
- Lists the configuration settings of a specified virtual directory in a
- web site hosted on Internet Information Server.
- </summary>
- <example>
- <para>
- List the settings of a virtual directory named <c>Temp</c>.
- </para>
- <code>
- <![CDATA[
- <iisdirinfo vdirname="Temp" />
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ADSIBaseTask">
- <summary>
- Base NAnt task for working with ADSI. This task contains only the path of the ADSI
- object that you want to work with.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ADSIBaseTask.Path">
- <summary>
- The ADSI path of the location where we want to work with.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ADSIGetPropertyTask">
- <summary>
- Used to get the value of a property from an ADSI object.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ADSIGetPropertyTask.ExecuteTask">
- <summary>
- Sets the specified property
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ADSIGetPropertyTask.PropName">
- <summary>
- The name of the property to get.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ADSIGetPropertyTask.StoreIn">
- <summary>
- The name of the property to store the value in.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ADSISetPropertyTask">
- <summary>
- Sets a property on an ADSI object.
- </summary>
- <remarks>
- This task uses a heuristic to determine the type of the property in ADSI. The following cases are notable:
- <list type="bulleted">
- <item>If the property does not exist on the item, it is inserted as a string.</item>
- <item>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.</item>
- <item>If the property exists and is an array, the value is added to
- the array, but only if it is not already present.</item>
- </list>
- </remarks>
- <example>
- <code>
- <![CDATA[
- <adsisetprop path="${iis.path}/Root" propname="AuthAnonymous" propvalue="true" />
- ]]>
- </code>
- </example>
- <example>
- <code>
- <![CDATA[
- <adsisetprop path="${iis.path}/Root/GWSSample">
- <properties>
- <option name="AuthBasic" value="false" />
- <option name="AuthNTLM" value="true" />
- </properties>
- </adsisetprop>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ADSISetPropertyTask.ExecuteTask">
- <summary>
- Sets the specified property
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ADSISetPropertyTask.SetProperty(System.DirectoryServices.DirectoryEntry,System.String,System.String)">
- <summary>
- Sets the named property on the specified <see cref="T:System.DirectoryServices.DirectoryEntry"/>
- to the given value.
- </summary>
- <param name="entry">The <see cref="T:System.DirectoryServices.DirectoryEntry"/> we're modifying.</param>
- <param name="propertyName">The name of the property to set.</param>
- <param name="propertyValue">The value to set the property to.</param>
- <remarks>
- The following cases are notable:
- <list type="bulleted">
- <item>
- If the property does not exist on the item, it is inserted as a
- string.
- </item>
- <item>
- If the property already exists, this method will attempt to preserve
- the type of the property. The types this method knows about are
- <see cref="T:System.String"/>, <see creef="bool"/>, and <see cref="T:System.Int32"/>.
- </item>
- <item>
- If the property exists and is an array, the value is added to the
- array, but only if it's not already present.
- </item>
- </list>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ADSISetPropertyTask.PropertyName">
- <summary>
- The name of the property to set.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ADSISetPropertyTask.PropertyValue">
- <summary>
- The new value of the property.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Astyle">
- <summary>
- Formats source code in a given directory to a specified code format.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- NOTE: This task relies on the astyle.exe file being in your path variable.
- Please download the astyle.exe from http://astyle.sourceforge.net.
- </remarks>
- <example>
- <code>
- <![CDATA[
- <astyle style="NAnt" cleanup="true">
- <sources>
- <include name="**/**.cs" />
- </sources>
- </astyle>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.Astyle.DEFAULT_STYLE">
- <summary>
- The default style seems to be the closest to C# standards.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Astyle.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Build up the command line arguments, determine which executable is
- being used and find the path to that executable and set the working
- directory.
- </summary>
- <param name="process">The process to prepare.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Astyle.SetCommandOption(System.String,System.String,System.Boolean)">
- <summary>
- Adds a new command option if none exists. If one does exist then
- the use switch is toggled on or of.
- </summary>
- <param name="name">The common name of the option.</param>
- <param name="value">The option value or command line switch of the option.</param>
- <param name="on"><see langword="true" /> if the option should be appended to the commandline, otherwise <see langword="false" />.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Astyle.AppendCommandOptions">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Astyle.AppendFiles">
- <summary>
- Append the files specified in the fileset to the command line argument.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.CommandOptions">
- <summary>
- A collection of command line option switches.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.Sources">
- <summary>
- Used to select the files to copy.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.CommandLineArguments">
- <summary>
- The command-line arguments for the program.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.Style">
- <summary>
- Indicate the preset style to use.
- <list type="table">
- <item>ansi
- <code>
- namespace foospace
- {
- int Foo()
- {
- if (isBar)
- {
- bar();
- return 1;
- }
- else
- return 0;
- }
- }
- </code>
- </item>
- <item>kr ( Kernighan&Ritchie )
- <code>
- namespace foospace {
- int Foo() {
- if (isBar) {
- bar();
- return 1;
- } else
- return 0;
- }
- }
- </code>
- </item>
- <item>linux
- <code>
- namespace foospace
- {
- int Foo()
- {
- if (isBar) {
- bar();
- return 1;
- } else
- return 0;
- }
- }
- </code>
- </item>
- <item>gnu
- <code>
- namespace foospace
- {
- int Foo()
- {
- if (isBar)
- {
- bar();
- return 1;
- }
- else
- return 0;
- }
- }
- </code>
- </item>
- <item>java
- <code>
- class foospace {
- int Foo() {
- if (isBar) {
- bar();
- return 1;
- } else
- return 0;
- }
- }
- </code>
- </item>
- <item>NAnt
- <code>
- namespace foospace {
- class foo() {
- #region Protected Static Fields
- private int Foo() {
- if (isBar) {
- bar();
- return 1;
- } else {
- return 0;
- }
- }
- #endregion
- }
- </code>
- </item>
- </list>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.CleanUp">
- <summary>
- Astyle leaves the original files around, renamed with a different
- suffix. Setting this to <code>true</code>
- will remove these files.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.Suffix">
- <summary>
- The suffix to append to original files, defaults to <c>.orig</c>
- if not specified.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumSpaces">
- <summary>
- Indicate the maximum number of spaces to indent relative to a
- previous line.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumTabs">
- <summary>
- Indicate that tabs should be used to indent sources. The number
- specified indicates the maximum number of spaces the tab character
- will represent.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNumTabsForce">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.ConvertTabs">
- <summary>
- <see langword="true" /> to convert tabs to spaces.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentClass">
- <summary>
- <see langword="true" /> if class statements should be indented.
- <code>
-
- The default:
-
- class Foo
- {
- public:
- Foo();
- virtual ~Foo();
- };
-
- becomes:
-
- class Foo
- {
- public:
- Foo();
- virtual ~Foo();
- };
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentSwitch">
- <summary>
- <see langword="true" /> if switch statements should be indented.
- <code>
-
- 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;
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentCase">
- <summary>
- <see langword="true" /> if case statements should be indented.
- <code>
-
- 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;
- }
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentBracket">
- <summary>
- <code>true</code> if bracket statements should be indented.
- <code>
-
- The default:
-
- if (isFoo)
- {
- bar();
- }
- else
- {
- anotherBar();
- }
-
- becomes:
-
- if (isFoo)
- {
- bar();
- }
- else
- {
- anotherBar();
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentBlock">
- <summary>
- <see langword="true" /> if block statements should be indented.
- The default:
-
- if (isFoo)
- {
- bar();
- }
- else
- anotherBar();
-
- becomes:
-
- if (isFoo)
- {
- bar();
- }
- else
- anotherBar();
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentNamespaces">
- <summary>
- <see langword="true" /> if namespace statements should be indented.
- <code>
-
- The default:
-
- namespace foospace
- {
- class Foo
- {
- public:
- Foo();
- virtual ~Foo();
- };
- }
-
- becomes:
-
- namespace foospace
- {
- class Foo
- {
- public:
- Foo();
- virtual ~Foo();
- };
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentLabels">
- <summary>
- <see langword="true" /> if label statements should be indented.
- <code>
-
- The default:
-
- int foospace()
- {
- while (isFoo)
- {
- ...
- goto error;
-
- error:
- ...
- }
- }
-
- becomes:
-
- int foospace()
- {
- while (isFoo)
- {
- ...
- goto error;
-
- error:
- ...
- }
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentMax">
- <summary>
- Indicate the maximum number of spaces to indent relative to a
- previous line.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.IndentMin">
- <summary>
- Indicate the maximum number of spaces to indent relative to a
- previous line.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.FillEmptyLines">
- <summary>
- <see langword="true" /> if empty lines should be filled with the
- whitespace of the previous line.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsNewLine">
- <summary>
- <see langword="true" /> if brackets should be put on a new line.
- <code>
-
- if (isFoo)
- {
- bar();
- }
- else
- {
- anotherBar();
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsAttach">
- <summary>
- <see langword="true" /> if brackets should be attached.
- <code>
-
- if (isFoo){
- bar();
- } else {
- anotherBar();
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.BracketsLinux">
- <summary>
- <see langword="true" /> if brackets should be put on a new line and
- indented.
- <code>
-
- namespace foospace
- {
- int Foo()
- {
- if (isBar) {
- bar();
- return 1;
- } else
- return 0;
- }
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.BreakClosing">
- <summary>
- <see langword="true" /> if the line after a bracket (i.e. an else
- statement after the closing if) should be placed on the next line.
- <code>
-
- if (isFoo){
- bar();
- }else {
- anotherBar();
- }
-
- becomes:
-
- if (isFoo) {
- bar();
- }
- else {
- anotherBar();
- }
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.BreakBlocks">
- <summary>
- <see langword="true" /> to break block statements with an empty line.
- <code>
-
- isFoo = true;
- if (isFoo) {
- bar();
- } else {
- anotherBar();
- }
- isBar = false;
-
- becomes:
-
- isFoo = true;
-
- if (isFoo) {
- bar();
- } else {
- anotherBar();
- }
-
- isBar = false;
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.BreakBlocksAll">
- <summary>
- <see langword="true" /> to break all block statements, even on
- nested ifs with an empty line.
- <code>
-
- isFoo = true;
- if (isFoo) {
- bar();
- } else {
- anotherBar();
- }
- isBar = false;
-
- becomes:
-
- isFoo = true;
-
- if (isFoo) {
- bar();
-
- } else {
- anotherBar();
- }
-
- isBar = false;
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.BreakElseif">
- <summary>
- <see langword="true" /> to put the if component of an else if on a
- new line.
- <code>
-
- if (isFoo) {
- bar();
- } else if (isBar()){
- anotherBar();
- }
-
- becomes:
-
- if (isFoo) {
- bar();
- } else
- if (isBar()){
- anotherBar();
- }
-
- </code>
-
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.PadOperators">
- <summary>
- <see langword="true" /> to pad operators with a space.
- <code>
-
- if (isFoo)
- a = bar((b-c)*a,*d--);
-
- becomes:
-
- if (isFoo)
- a = bar((b - c) * a, *d--);
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.PadParenthesis">
- <summary>
- <see langword="true" /> to pad parenthesis with a space.
- <code>
-
- if (isFoo)
- a = bar((b-c)*a,*d--);
-
- becomes:
-
- if ( isFoo )
- a = bar( ( b-c )*a, *d-- );
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.PadAll">
- <summary>
- <see langword="true" /> to pad operators and parenthesis.
- <code>
-
- if (isFoo)
- a = bar((b-c)*a,*d--);
-
- becomes:
-
- if ( isFoo )
- a = bar( ( b - c ) * a, *d-- );
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.NoBreakComplex">
- <summary>
- <see langword="true" /> to keep complex statements on the same line.
- <code>
-
- if (isFoo)
- {
- isFoo = false; cout << isFoo << endl;
- }
-
- remains as is.
-
- if (isFoo) DoBar();
-
- remains as is.
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.NoBreakSingleLineBlocks">
- <summary>
- <see langword="true" /> to keep single line statements on the same line.
- <code>
-
- if (isFoo)
- { isFoo = false; cout << isFoo << endl; }
-
- remains as is.
-
- </code>
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Astyle.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.COMRegisterTask">
- <summary>
- Register COM servers or type libraries.
- </summary>
- <remarks>
- <para>
- COM register task will try and register any type of COM related file
- that needs registering.
- </para>
- <para>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.
- </para>
- </remarks>
- <example>
- <para>Register a single dll server.</para>
- <code>
- <![CDATA[
- <comregister file="myComServer.dll" />
- ]]>
- </code>
- </example>
- <example>
- <para>Register a single exe server </para>
- <code>
- <![CDATA[
- <comregister file="myComServer.exe" />
- ]]>
- </code>
- </example>
- <example>
- <para>Register a set of COM files at once.</para>
- <code>
- <![CDATA[
- <comregister unregister="false">
- <fileset>
- <include name="an_ExeServer.exe" />
- <include name="a_TypeLibrary.tlb" />
- <include name="a_DllServer.dll" />
- <include name="an_OcxServer.ocx" />
- </fileset>
- </comregister>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterDllServer(System.String)">
- <summary>
- Register an inproc COM server, usually a .dll or .ocx
- </summary>
- <param name="path"></param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterTypelib(System.String)">
- <summary>
- Register a COM type library
- </summary>
- <param name="path"></param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.RegisterExeServer(System.String)">
- <summary>
- Register exe servers.
- </summary>
- <param name="path"></param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.File">
- <summary>
- The name of the file to register. This is provided as an alternate
- to using the task's fileset.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.Unregister">
- <summary>Unregistering this time. ( /u paramater )Default is "false".</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.COMRegisterTask.COMRegisterFileSet">
- <summary>
- The set of files to register.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.COMRegisterTask.DynamicPInvoke">
- <summary>
- Helper class to synamically build an assembly with the correct
- P/Invoke signature
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.COMRegisterTask.DynamicPInvoke.DynamicDllFuncInvoke(System.String,System.String)">
- <summary>
- Register a given dll.
- </summary>
- <param name="dll"></param>
- <param name="entrypoint"></param>
- <returns></returns>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ChangeDirectory">
- <summary>
- Changes the current working directory.
- </summary>
- <example>
- <para>
- Changes the current working directory to the "subdir"
- directory, relative to the project base directory.
- </para>
- <code>
- <![CDATA[
- <cd dir="subdir" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ChangeDirectory.ExecuteTask">
- <summary>
- Changes the current directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ChangeDirectory.Directory">
- <summary>
- The path to which the current working directory should be set.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ChecksumTask">
- <summary>
- Calculates checksums for a set of files.
- Loosely based on Ant's Checksum task.
- </summary>
- <remarks>
- 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.
- </remarks>
- <example>
- <code>
- <![CDATA[
- <checksum algorithm="MD5" fileext="MD5">
- <fileset>
- <include name="${outputdir}\*.dll"/>
- </fileset>
- </checksum>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ChecksumTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ChecksumTask.ExecuteTask">
- <summary>
- This is where the work is done
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ChecksumTask.WriteChecksum(System.String,System.String)">
- <summary>
- Writes a checksum to a destination file
- </summary>
- <param name="filename"></param>
- <param name="checksum"></param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ChecksumTask.Algorithm">
- <summary>
- Name of Algorithm to use when calculating
- the checksum. Can be MD5 or SHA1.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ChecksumTask.FileExtension">
- <summary>
- The generated checksum file's name will be the
- original filename with "." and fileext
- added to it. Defaults to the
- algorithm name being used
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ChecksumTask.FileSet">
- <summary>
- Set of files to use as input
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ChooseTask">
- <summary>
- <para>
- Executes an alternate set of tasks depending on conditions that are
- individually set on each group of tasks.
- </para>
- </summary>
- <remarks>
- <para>
- The <see cref="T:NAnt.Contrib.Tasks.ChooseTask"/> selects one among a number of possible
- alternatives. It consists of a sequence of <c><when></c> elements
- followed by an optional <c><otherwise></c> element.
- </para>
- <para>
- Each <c><when></c> element has a single attribute, test, which
- specifies an expression. The content of the <c><when></c> and
- <c><otherwise></c> elements is a set of nested tasks.
- </para>
- <para>
- The content of the first, and only the first, <c><when></c>
- element whose test is <see langword="true"/> is executed. If no
- <c><when></c> element is <see langword="true"/>, the
- content of the <c><otherwise></c> element is executed.
- If no <c><when></c> element is <see langword="true"/>, and no
- <c><otherwise></c> element is present, nothing is done.
- </para>
- </remarks>
- <example>
- <para>
- Execute alternate set of tasks depending on the configuration being
- built.
- </para>
- <code>
- <![CDATA[
- <choose>
- <when test="${build.config == 'Debug'}">
- <!-- compile app in debug configuration -->
- ...
- </when>
- <when test="${build.config == 'Release'}">
- <!-- compile app in release configuration -->
- ...
- </when>
- <otherwise>
- <fail>Build configuration '${build.config}' is not supported!</fail>
- </otherwise>
- </choose>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ChooseTask.AddCondition(NAnt.Contrib.Tasks.When)">
- <summary>
- One or more alternative sets of tasks to execute.
- </summary>
- <param name="when">The set of tasks to add.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ChooseTask.AddFallback(NAnt.Contrib.Tasks.NestedTaskContainer)">
- <summary>
- The set of tasks to execute if none of the <see cref="T:NAnt.Contrib.Tasks.When"/>
- elements are <see langword="true"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ChooseTask.IsFallbackDefined">
- <summary>
- Gets a value indicating whether a fallback element is defined.
- </summary>
- <value>
- <see langword="true" /> if a fallback element is defined; otherwise,
- <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.When">
- <summary>
- Groups a set of tasks to execute when a condition is met.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.NestedTaskContainer">
- <summary>
- Executes embedded tasks in the order in which they are defined.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NestedTaskContainer.ExecuteChildTasks">
- <summary>
- Creates and executes the embedded (child XML nodes) elements.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NestedTaskContainer.CustomXmlProcessing">
- <summary>
- Gets a value indicating whether the element is performing additional
- processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
- initialize the element.
- </summary>
- <value>
- <see langword="true"/>, as a <see cref="T:NAnt.Contrib.Tasks.NestedTaskContainer"/> is
- responsable for creating tasks from the nested build elements.
- </value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.When.Test">
- <summary>
- Used to test arbitrary boolean expression.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.CodeStatsTask">
- <summary>
- Generates statistics from source code.
- </summary>
- <remarks>
- Scans files in a fileset counting lines.
- </remarks>
- <example>
- <para>
- Generate statistics for a set of C# and VB.NET sources, applying
- different labels for both.
- </para>
- <code>
- <![CDATA[
- <codestats output="test.xml" append="true" buildname="MyBuildName">
- <counts>
- <count label="C#">
- <fileset>
- <include name="**/*.cs" />
- </fileset>
- </count>
- <count label="VB">
- <fileset>
- <include name="**\*.vb" />
- </fileset>
- </count>
- </counts>
- </codestats>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Generate statistics for all C# sources and only output a summary to
- the log.
- </para>
- <code>
- <![CDATA[
- <codestats output="test.xml" verbose="true" summarize="true">
- <counts>
- <count label="C#">
- <fileset>
- <include name="**\*.cs" />
- </fileset>
- </count>
- </counts>
- </codestats>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.CodeStats">
- <summary>
- Set of line counters to enable.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.BuildName">
- <summary>
- An identifier to be able to track which build last updated the
- code stats file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.AppendFile">
- <summary>
- Specifies whether the results should be appended to the output file.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.Summarize">
- <summary>
- If you only want to show summary stats for the whole fileset
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.CodeStatsTask.OutputFile">
- <summary>
- The name of the file to save the output to (in XML).
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ConcatTask">
- <summary>
- A task that concatenates a set of files.
- Loosely based on Ant's Concat task.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- <para>
- The order the files are concatenated in is not
- especified.
- </para>
- </remarks>
- <example>
- <code>
- <![CDATA[
- <concat destfile="${outputdir}\Full.txt" append="true">
- <fileset>
- <include name="${outputdir}\Test-*.txt" />
- </fileset>
- </concat>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ConcatTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ConcatTask.ExecuteTask">
- <summary>
- This is where the work is done
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ConcatTask.OpenDestinationFile">
- <summary>
- Opens the destination file according
- to the specified flags
- </summary>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ConcatTask.AppendFiles(System.IO.FileStream)">
- <summary>
- Appends all specified files
- </summary>
- <param name="output">File to write to</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ConcatTask.DestinationFile">
- <summary>
- Name of the destination file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ConcatTask.Append">
- <summary>
- Specifies whether to append to the destination file.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ConcatTask.FileSet">
- <summary>
- Set of files to use as input.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.DependsTask">
- <summary>
- On execution guarantees the listed dependencies are resolved before continuing. It is
- particularly useful for handling dynamic dependencies that change based on some input
- conditions/parameters, or when the dependencies are not known until runtime.
- </summary>
- <remarks>The depends task never forces the execution of any target that has already been executed. It works just like the depends attribute of a <see cref="T:NAnt.Core.Target"/>.</remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.DependsTask.ExecuteTask">
- <summary>
- Executes the specified task.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DependsTask.DependsCollection">
- <summary>
- A space or comma separated dependency list of targets.
- </summary>
- <remarks>
- Expressions get evaluated when the task is executed.
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.DicsoTask">
- <summary>
- Discovers the URLs of XML web services on a web server and saves documents
- related to them to the local disk. The resulting .discomap, .wsdl, and .xsd files
- can be used with the <see cref="T:NAnt.Contrib.Tasks.WsdlTask"/> to produce web service clients and
- and abstract web service servers using ASP.NET.
- </summary>
- <example>
- <para>Generate a proxy class for a web service.</para>
- <code>
- <![CDATA[
- <disco
- path="http://www.somewhere.com/myservice.wsdl"
- language="CS"
- namespace="MyCompany.MyService"
- outfile="MyService.cs"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.DicsoTask.ExecuteTask">
- <summary>
- Discover the details for the specified web service.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.Path">
- <summary>The URL or Path to discover.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.NoLogo">
- <summary>Suppresses the banner.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.NoSave">
- <summary>Do not save the discovered documents to the local disk.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.OutputDir">
- <summary>The output directory to save discovered documents in.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.Username">
- <summary>Username of an account with credentials to access a
- server that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.Password">
- <summary>Password of an account with credentials to access a
- server that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.Domain">
- <summary>Domain of an account with credentials to access a
- server that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.Proxy">
- <summary>URL of a proxy server to use for HTTP requests.
- The default is to use the system proxy setting.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyUsername">
- <summary>Username of an account with credentials to access a
- proxy that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyPassword">
- <summary>Password of an account with credentials to access a
- proxy that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProxyDomain">
- <summary>Domain of an account with credentials to access a
- proxy that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.DicsoTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.FxCopTask">
- <summary>
- Analyzes managed code assemblies and reports information about the
- assemblies, such as possible design, localization, performance, and
- security improvements.
- </summary>
- <remarks>
- <note>
- this task relies on fxcopcmd.exe being in your PATH environment variable.
- You can download the latest FxCop from <see href="http://www.gotdotnet.com/team/fxcop/" />.
- </note>
- </remarks>
- <example>
- <code>
- <![CDATA[
- <fxcop directOutputToConsole="true" projectFile="${build.dir}\Sample.fxcop">
- <targets>
- <include name="${build.dir}\bin\*.dll" />
- </targets>
- <rules>
- <include name="${build.dir}\rules\*.dll" />
- </rules>
- </fxcop>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.FxCopTask.#ctor">
- <summary>
- Creates a new <see cref="T:NAnt.Contrib.Tasks.FxCopTask"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.FxCopTask.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Performs logic before the external process is started
- </summary>
- <param name="process">Process.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.FxCopTask.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.FxCopTask.BuildArguments">
- <summary>
- Builds the arguments to pass to the exe.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.ApplyOutXsl">
- <summary>
- Applies the XSL transformation specified in /outXsl to the analysis report before saving the file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.DirectOutputToConsole">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.ConsoleXslFilename">
- <summary>
- Specifies the XSL or XSLT file that contains a transformation to be applied to the analysis output before it is displayed in the console.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.DependencyDirectories">
- <summary>
- Specifies additional directories to search for assembly dependencies. FxCopCmd always searches the target assembly directory and the current working directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.TargetAssemblies">
- <summary>
- Specifies the target assembly to analyze.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.ImportFiles">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.AnalysisReportFilename">
- <summary>
- Specifies the file name for the analysis report.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.OutputXslFilename">
- <summary>
- Specifies the XSL or XSLT file that is referenced by the xml-stylesheet processing instruction in the analysis report.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.PlatformDirectory">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.ProjectFile">
- <summary>
- Specifies the filename of FxCop project file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.RuleLibraries">
- <summary>
- Specifies the filename(s) of FxCop project file(s).
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.IncludeSummaryReport">
- <summary>
- Includes a summary report with the informational messages returned by FxCopCmd.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.TypeList">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.SaveResults">
- <summary>
- Saves the results of the analysis in the project file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.FailOnAnalysisError">
- <summary>
- Determines if the task should fail when analysis errors occur
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.BaseDirectory">
- <summary>
- The directory in which the command will be executed.
- </summary>
- <value>
- The directory in which the command will be executed. The default
- is the project's base directory.
- </value>
- <remarks>
- <para>
- It will be evaluated relative to the project's
- base directory if it is relative.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.FxCopTask.ProgramArguments">
- <summary>
- Gets the program arguments.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.GacInstallTask">
- <summary>
- Installs assemblies into the Global Assembly Cache (GAC) by using the
- <c>gacutil</c> SDK tool.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- </remarks>
- <example>
- <para>Installs <c>Shared.dll</c> into the GAC.</para>
- <code>
- <![CDATA[
- <gac-install>
- <assemblies>
- <include name="Shared.dll" />
- </assemblies>
- </gac-install>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Installs <c>Shared.dll</c> and <c>MyWeb.dll</c> into the GAC.
- </para>
- <code>
- <![CDATA[
- <gac-install>
- <assemblies>
- <include name="Shared.dll" />
- <include name="MyWeb.dll" />
- </assemblies>
- </gac-install>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Installs <c>Shared.dll</c> and <c>MyWeb.dll</c> into the GAC and
- specifies reference information.
- </para>
- <code>
- <![CDATA[
- <gac-install>
- <reference scheme-type="Opaque" scheme-id="MyID" scheme-description="My description" />
- <assemblies>
- <include name="Shared.dll" />
- <include name="MyWeb.dll" />
- </assemblies>
- </gacinstall>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Contrib.Tasks.GacTaskBase">
- <summary>
- Base class functionality for the GAC tasks.
- </summary>
- <remarks>
- Concrete GAC tasks extend this class in order to obtain common functionality.
- </remarks>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacTaskBase._currentAssembly">
- <summary>
- Stores the details of the assembly currently being operated against. This could be a name or
- path, depending on the concrete task.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacTaskBase._force">
- <summary>
- See <see cref="P:NAnt.Contrib.Tasks.GacTaskBase.Force"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacTaskBase._reference">
- <summary>
- See <see cref="P:NAnt.Contrib.Tasks.GacTaskBase.Reference"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacTaskBase.#ctor">
- <summary>
- Constructs and initialises an instance of <c>GacTask</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacTaskBase.StartProcess">
- <summary>
- Starts the process that is wrapped by this GAC task.
- </summary>
- <remarks>
- Provided only to seal the implementation of <c>StartProcess()</c>.
- </remarks>
- <returns>The process that was started.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacTaskBase.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Validates the task's configuration.
- </summary>
- <param name="taskNode">The task node.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacTaskBase.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- <remarks>
- Provided only to seal the implementation of <c>ExecuteTask()</c>.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacTaskBase.AppendProgramArguments(System.Text.StringBuilder)">
- <summary>
- Appends any task-specific program arguments.
- </summary>
- <param name="sb">The <c>StringBuilder</c> on which to append program arguments.</param>
- <remarks>
- Subclasses must override this method to return the arguments with which to run the GAC task.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacTaskBase.BeforeExecuteTask">
- <summary>
- Invoked prior to invoking <c>ExecuteTask()</c> on the base class.
- </summary>
- <remarks>
- Allows, for example, subclasses to output useful information to the log.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTaskBase.Force">
- <summary>
- Gets or sets a value indicating whether the GAC operation will be forced.
- </summary>
- <remarks>
- The exact meaning of this property is dependent on the subclass. As such, subclasses should override this
- property to provide a valid description.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTaskBase.Reference">
- <summary>
- Specifies reference details to use when working with the GAC.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTaskBase.AssemblyList">
- <summary>
- Concrete GAC tasks must override this property to return an array of assembly names or paths
- upon which to operate.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ExeName">
- <summary>
- Gets the executable name for the <c>gacutil</c> command-line tool.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ReferenceSpecified">
- <summary>
- Specifies whether a reference was specified for the GAC task.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTaskBase.CurrentAssembly">
- <summary>
- Gets the current assembly being operated against.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTaskBase.ProgramArguments">
- <summary>
- Gets the program arguments with which to run the <c>gacutil</c> process.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacInstallTask._assemblies">
- <summary>
- See <see cref="P:NAnt.Contrib.Tasks.GacInstallTask.Assemblies"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacInstallTask.#ctor">
- <summary>
- Constructs and initialises an instance of the <c>GacInstallTask</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacInstallTask.AppendProgramArguments(System.Text.StringBuilder)">
- <summary>
- Appends any install-specific arguments.
- </summary>
- <param name="sb">The <c>StringBuilder</c> to append arguments to.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacInstallTask.BeforeExecuteTask">
- <summary>
- Outputs log information.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacInstallTask.Assemblies">
- <summary>
- Specifies the assemblies to install.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacInstallTask.AssemblyList">
- <summary>
- Gets the assembly list to install.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacInstallTask.Force">
- <summary>
- If <see langword="true" />, the specified assemblies will be forcibly
- installed. Any existing duplicate assemblies in the GAC will be
- overwritten. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.GacTask">
- <summary>
- Manipulates the contents of the global assembly cache.
- </summary>
- <remarks>
- <para>
- This tasks provides some of the same functionality as the gacutil tool
- provided in the .NET Framework SDK.
- </para>
- <para>
- Specifically, the <see cref="T:NAnt.Contrib.Tasks.GacTask"/> allows you to install assemblies
- into the cache and remove them from the cache.
- </para>
- <para>
- Refer to the <see href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrfglobalassemblycacheutilitygacutilexe.htm">
- Global Assembly Cache Tool (Gacutil.exe)</see> for more information.
- </para>
- </remarks>
- <example>
- <para>
- Inserts assembly <c>mydll.dll</c> into the global assembly cache.
- </para>
- <code>
- <![CDATA[
- <gac assembly="mydll.dll" action="install" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Removes the assembly <c>hello</c> from the global assembly cache and
- the native image cache.
- </para>
- <code>
- <![CDATA[
- <gac assembly="hello" action="uninstall" />
- ]]>
- </code>
- <para>
- Note that the previous command might remove more than one assembly
- from the assembly cache because the assembly name is not fully
- specified. For example, if both version 1.0.0.0 and 3.2.2.1 of
- <c>hello</c> are installed in the cache, both of the assemblies will
- be removed from the global assembly cache.
- </para>
- </example>
- <example>
- <para>
- Use the following example to avoid removing more than one assembly.
- This command removes only the hello assembly that matches the fully
- specified version number, culture, and public key.
- </para>
- <code>
- <![CDATA[
- <gac assembly="hello,Version=1.0.0.1,Culture=de,PublicKeyToken=45e343aae32233ca" action="uninstall" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTask.AssemblyName">
- <summary>
- The name of a file that contains an assembly manifest.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTask.ActionType">
- <summary>
- Defines the action to take with the assembly. The default is
- <see cref="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.install"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacTask.AssemblyFileSet">
- <summary>
- Fileset are used to define multiple assemblies.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.GacTask.ActionTypes">
- <summary>
- Defines the actions that can be performed on an assembly using the
- <see cref="T:NAnt.Contrib.Tasks.GacTask"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.install">
- <summary>
- Installs an assembly into the global assembly cache.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.overwrite">
- <summary>
- 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.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacTask.ActionTypes.uninstall">
- <summary>
- Uninstalls an assembly from the global assembly cache.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.GacUninstallTask">
- <summary>
- Uninstalls assemblies from the Global Assembly Cache (GAC) by using the
- <c>gacutil</c> SDK tool.
- </summary>
- <remarks>
- <para>
- Assemblies are specified via an <see cref="T:NAnt.Contrib.Types.AssemblySet"/>. Individual
- assemblies are specified by their identity information. Only a name is
- required but, optionally, the assembly version, culture and public key
- token may be specified.
- </para>
- <para>
- Assemblies can be uninstalled from the GAC with or without reference
- counting. The full details of reference counting can be found in the
- SDK documentation.
- </para>
- </remarks>
- <example>
- <para>Uninstalls <c>Shared</c> assembly from the GAC.</para>
- <code>
- <![CDATA[
- <gac-uninstall>
- <assemblies>
- <assembly name="Shared" />
- </assemblies>
- </gac-uninstall>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Uninstalls <c>Shared</c> and <c>MyWeb</c> from the GAC.
- </para>
- <code>
- <![CDATA[
- <gac-uninstall>
- <assemblies>
- <assembly name="Shared" />
- <assembly name="MyWeb" />
- </assemblies>
- </gac-uninstall>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Decrements references to <c>Shared</c> in the GAC and uninstalls if
- the reference count reaches zero.
- </para>
- <code>
- <![CDATA[
- <gac-uninstall>
- <reference scheme-type="Opaque" scheme-id="MyID" scheme-description="My description" />
- <assemblies>
- <assembly name="Shared" />
- </assemblies>
- </gac-uninstall>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Uninstalls version <c>2.1.7.9201</c> of <c>Shared</c> plus the
- Australian-cultured <c>MyWeb</c> from the GAC.
- </para>
- <code>
- <![CDATA[
- <gac-uninstall>
- <assemblies>
- <assembly name="Shared" version="2.1.7.9201" />
- <assembly name="MyWeb" culture="en-AU" />
- </assemblies>
- </gac-uninstall>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Uninstalls the neutrally-cultured, version <c>1.0.5000.0</c> of
- <c>System.Xml</c> from the native image cache. The assembly must
- also have a public key token of <c>b77a5c561934e08a</c> to be
- uninstalled.
- </para>
- <code>
- <![CDATA[
- <gac-uninstall native="true">
- <assemblies>
- <assembly name="System.Xml" version="1.0.5000.0" public-key-token="b77a5c561934e08a" culture="Neutral" />
- </assemblies>
- </gac-uninstall>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacUninstallTask._native">
- <summary>
- See <see cref="P:NAnt.Contrib.Tasks.GacUninstallTask.Native"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.GacUninstallTask._assemblies">
- <summary>
- See <see cref="P:NAnt.Contrib.Tasks.GacUninstallTask.Assemblies"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.#ctor">
- <summary>
- Constructs an instance of the <c>GacUninstallTask</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.AppendProgramArguments(System.Text.StringBuilder)">
- <summary>
- Appends any install-specific arguments.
- </summary>
- <param name="sb"></param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.GacUninstallTask.BeforeExecuteTask">
- <summary>
- Outputs log information.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Native">
- <summary>
- If <see langword="true" />, specifies that the assemblies should be
- uninstalled from the native image cache. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Assemblies">
- <summary>
- Specifies the assemblies to uninstall.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.AssemblyList">
- <summary>
- Gets the assembly list to uninstall.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.GacUninstallTask.Force">
- <summary>
- If <see langword="true" />, 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 <see langword="false" />.
- </summary>
- <remarks>
- You cannot use this option to remove an assembly that was installed using Microsoft Windows Installer.
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.HxCompTask">
- <summary>
- Compiles a Microsoft HTML Help 2.0 Project.
- </summary>
- <example>
- <para>Compile a help file.</para>
- <code>
- <![CDATA[
- <hxcomp contents="MyContents.HxC" output="MyHelpFile.HxS" projectroot="HelpSourceFolder" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.Contents">
- <summary>
- The name of the contents (.HxC) file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.LogFile">
- <summary>
- ANSI/DBCS log filename.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.UnicodeLogFile">
- <summary>
- Unicode log filename.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.ProjectRoot">
- <summary>
- Root directory containing Help 2.0 project files.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.OutputFile">
- <summary>
- Output (.HxS) filename.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoInformation">
- <summary>
- Generate no informational messages.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoErrors">
- <summary>
- Generate no error messages.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.NoWarnings">
- <summary>
- Generate no warning messages.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.UncompileFile">
- <summary>
- File to be decompiled.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.UncompileOutputDir">
- <summary>
- Directory to place decompiled files into.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxCompTask.ProgramArguments">
- <summary>
- Arguments of program to execute
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.HxRegTask">
- <summary>
- Registers a Microsoft HTML Help 2.0 Collection.
- </summary>
- <example>
- <para>Register a help namespace.</para>
- <code>
- <![CDATA[
- <hxreg namespace="MyProduct.MyHelp" title="MyProductHelp" collection="MyHelp.HxC" helpfile="MyHelp.HxS" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.Namespace">
- <summary>Help collection namespace.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.Title">
- <summary>Title identifier.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.Collection">
- <summary>Collection (.HxC) filename. </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.Description">
- <summary>Description of the namespace.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.HelpFile">
- <summary>Help (.HxS) filename.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.Index">
- <summary>Index (.HxI) filename.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.SearchFile">
- <summary>Combined full-text search (.HxQ) filename.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.AttrIndex">
- <summary>Combined attribute index (.HxR) filename.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.Language">
- <summary>Language ID.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.Alias">
- <summary>Alias.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.CommandFile">
- <summary>Filename of a file containing HxReg commands.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.UnRegister">
- <summary>Unregister a namespace, title, or alias.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.HxRegTask.ProgramArguments">
- <summary>
- Arguments of program to execute
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.IniReadTask">
- <summary>
- Reads String values in INI files.
- </summary>
- <para>Reads the value for <c>AutoRefresh</c> in the <c>MS Transaction Server</c> section
- of the <c>VendorMISMO2.ini</c> ini file. Stores the value in the "myvar" property.</para>
- <example>
- <code>
- <![CDATA[
- <iniread property="myvar" filename="VendorMISMO2.ini" section="MS Transaction Server" key="AutoRefresh" default="1"/>
- ]]>
- </code>
- <para>The file contents look like this:</para>
- <code>
- [MS Transaction Server]
- Executable="VendorMISMO2.dll"
- AutoRefresh=1
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniReadTask.FileName">
- <summary>
- INI File to Write To.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniReadTask.Key">
- <summary>
- Key to set the value for.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniReadTask.Default">
- <summary>
- value to set.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniReadTask.Section">
- <summary>
- Section in the INI file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniReadTask.Property">
- <summary>
- property where we store the return value.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.IniWriteTask">
- <summary>
- Sets String values in INI files.
- </summary>
- <example>
- <para>Set the value for <c>Executable</c> in the <c>VendorMISMO2.ini</c> ini file</para>
- <code>
- <![CDATA[
- <iniwrite filename="VendorMISMO2.ini" section="MS Transaction Server" key="Executable" value="VendorMISMO2.dll"/>
- ]]>
- </code>
- <para>The file contents look like this:</para>
- <code>
- [MS Transaction Server]
- Executable="VendorMISMO2.dll"
- AutoRefresh=1
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniWriteTask.FileName">
- <summary>
- INI File to Write To.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniWriteTask.Key">
- <summary>
- Key to set the value for.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniWriteTask.Value">
- <summary>
- value to set.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.IniWriteTask.Section">
- <summary>
- Section in the INI file.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.MsbuildTask">
- <summary>
- Builds the specified targets in the project file using <c>MSBuild</c>.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.MsbuildTask.ExecuteTask">
- <summary>
- Starts the external process and captures its output.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MsbuildTask.ProjectFile">
- <summary>
- The project to build.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MsbuildTask.Properties">
- <summary>
- Set or override these project-level properties.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MsbuildTask.Target">
- <summary>
- Build these targets in this project. Use a semicolon or a comma
- comma to separate multiple targets.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MsbuildTask.NoAutoResponse">
- <summary>
- Do not auto-include the MSBuild.rsp file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MsbuildTask.Verbosity">
- <summary>
- Specifies the amount of information to display in the MSBuild log.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MsbuildTask.ProgramArguments">
- <summary>
- Gets the command line arguments for the external program.
- </summary>
- <value>
- The command line arguments for the external program.
- </value>
- </member>
- <member name="M:NAnt.Contrib.Tasks.MsbuildTask.VerbosityLevelConverter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.MsbuildTask.VerbosityLevelConverter"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.MsbuildTask.VerbosityLevelConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <summary>
- Converts the given object to the type of this converter, using the
- specified context and culture information.
- </summary>
- <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
- <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
- <param name="value">The <see cref="T:System.Object"/> to convert.</param>
- <returns>
- An <see cref="T:System.Object"/> that represents the converted value.
- </returns>
- </member>
- <member name="T:NAnt.Contrib.Tasks.MgmtClassGenTask">
- <summary>
- A task that generates strongly typed WMI classes using
- <c>mgmtclassgen.exe</c>.
- </summary>
- <remarks>
- 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.
- </remarks>
- <example>
- <code>
- <![CDATA[
- <mgmtclassgen
- wmiclass="Win32_LogicalDisk"
- language="CS"
- machine="SomeMachine"
- path="Root\cimv2"
- namespace="Winterdom.WMI"
- out="${outputdir}\LogicalDisk.cs"
- username="Administrator"
- password="password"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.MgmtClassGenTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.MgmtClassGenTask.ExecuteTask">
- <summary>
- This is where the work is done
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.WmiClass">
- <summary>
- Specifies the name of the WMI class
- to generate the strongly typed class
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Language">
- <summary>
- Specifies the language in which to generate
- the class. Possible values are: CS, VB, JS
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Machine">
- <summary>
- Specifies the machine to connect to.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Path">
- <summary>
- Specifies the path to the WMI namespace
- that contains the class.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Namespace">
- <summary>
- Namespace of the generated .NET class
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.OutFile">
- <summary>
- Path of the file to generate
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Username">
- <summary>
- User name to use when connecting to
- the specified machine
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.Password">
- <summary>
- Password to use when connecting to the
- specified machine
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.ProgramFileName">
- <summary>
- Filename of program to execute
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.MgmtClassGenTask.ProgramArguments">
- <summary>
- Arguments of program to execute
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.NGenTask">
- <summary>
- Pre-translates native code for an assembly containing IL (Intermediary
- Language bytecode) on the Windows platform.
- </summary>
- <example>
- <code>
- <![CDATA[
- <ngen assembly="MyAssembly.dll" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NGenTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NGenTask.Assembly">
- <summary>Assembly path or display name.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NGenTask.Show">
- <summary>If existing images should be shown.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NGenTask.Delete">
- <summary>If existing images should be deleted.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NGenTask.Debug">
- <summary>If an image should be generated which
- can be used under a debugger.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NGenTask.DebugOptimized">
- <summary>If an image should be generated which
- can be used under a debugger in optimized
- debugging mode.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NGenTask.Profiled">
- <summary>If an image should be generated which
- can be used under a profiler.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NGenTask.ProgramArguments">
- <summary>
- Arguments of program to execute
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.NUnitReportTask">
- <summary>
- A task that generates a summary HTML
- from a set of NUnit xml report files.
- Loosely based on Erik Hatcher JUnitReport for Ant.
- </summary>
- <remarks>
- 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 <code>xslfile</code>
- 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.
- </remarks>
- <example>
- <code><![CDATA[
- <nunitreport
- out="${outputdir}\TestSummary.html"
- >
- <fileset>
- <include name="${outputdir}\Test-*.xml" />
- </fileset>
- </nunitreport>
-
- ]]></code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">Xml node used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.ExecuteTask">
- <summary>
- This is where the work is done
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.CreateSummaryXmlDoc">
- <summary>
- Initializes the XmlDocument instance
- used to summarize the test results
- </summary>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.GetPropertyList">
- <summary>
- Builds an XsltArgumentList with all
- the properties defined in the
- current project as XSLT parameters.
- </summary>
- <returns>Property List</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.LoadTransform">
- <summary>
- Loads the XSLT Transform
- </summary>
- <remarks>
- This method will load the file specified
- through the the xslfile attribute, or
- the default transformation included
- as a managed resource.
- </remarks>
- <returns>The Transformation to use</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.OutFilename">
- <summary>
- Name of Output HTML file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.XslFile">
- <summary>
- XSLT file used to generate the report.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.NUnitReportTask.XmlFileSet">
- <summary>
- Set of XML files to use as input
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.NUnitReportTask.LocalResXmlResolver">
- <summary>
- Custom XmlResolver used to load the
- XSLT files out of this assembly resources.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.NUnitReportTask.LocalResXmlResolver.GetEntity(System.Uri,System.String,System.Type)">
- <summary>
- Loads the XSLT file
- </summary>
- <param name="absoluteUri"></param>
- <param name="role"></param>
- <param name="objToReturn"></param>
- <returns></returns>
- </member>
- <member name="T:NAnt.Contrib.Tasks.RecordTask">
- <summary>
- A task that records the build's output to a file. Loosely based on Ant's
- <a href="http://ant.apache.org/manual/CoreTasks/recorder.html">Record</a>
- task.
- </summary>
- <remarks>
- 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.
- </remarks>
- <example>
- <code>
- <![CDATA[
- <record name="${outputdir}\Buildlog.txt" level="Info" action="Start"/>
- <record name="${outputdir}\Buildlog.txt" action="Close"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.RecordTask.ExecuteTask">
- <summary>
- This is where the work is done.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RecordTask.LogName">
- <summary>
- Name of destination file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RecordTask.Action">
- <summary>
- Action to apply to this log instance - either <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/>,
- <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Stop"/>, <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Close"/> or
- <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Flush"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RecordTask.AutoFlush">
- <summary>
- Determines whether the recorder will flush it's buffer after every
- write to it. The default is <see langword="false"/>.
- </summary>
- <remarks>
- Effective only with the <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/> action.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RecordTask.ThresholdLevel">
- <summary>
- Determine the level of logging - either <see cref="F:NAnt.Core.Level.Debug"/>,
- <see cref="F:NAnt.Core.Level.Verbose"/>, <see cref="F:NAnt.Core.Level.Info"/>,
- <see cref="F:NAnt.Core.Level.Warning"/> or <see cref="F:NAnt.Core.Level.Error"/>.
- The default is <see cref="F:NAnt.Core.Level.Info"/>.
- </summary>
- <remarks>
- Effective only with the <see cref="F:NAnt.Contrib.Tasks.RecordTask.ActionType.Start"/> action.
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.RegasmTask">
- <summary>
- Registers an assembly for use from COM clients.
- </summary>
- <remarks>
- <para>
- Refer to the <see href="ms-help://MS.VSCC/MS.MSDNVS/cptools/html/cpgrfassemblyregistrationtoolregasmexe.htm">Regasm</see>
- documentation for more information on the regasm tool.
- </para>
- </remarks>
- <example>
- <para>
- Register a single assembly.
- </para>
- <code>
- <![CDATA[
- <regasm assembly="myAssembly.dll" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Register an assembly while exporting a typelibrary.
- </para>
- <code>
- <![CDATA[
- <regasm assembly="myAssembly.dll" typelib="myAssembly.tlb" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Register a set of assemblies at once.
- </para>
- <code>
- <![CDATA[
- <regasm unregister="false" codebase="true">
- <fileset>
- <include name="**/*.dll" />
- <exclude name="notanassembly.dll" />
- </fileset>
- </regasm>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RegasmTask.AssemblyFile">
- <summary>
- The name of the file to register. This is provided as an alternate
- to using the task's fileset.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RegasmTask.RegistryFile">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RegasmTask.CodeBase">
- <summary>
- Set the code base registry setting.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RegasmTask.ExportTypelib">
- <summary>
- Export a typelib and register it. The typelib will have the same
- name as the source assembly unless the <see cref="P:NAnt.Contrib.Tasks.RegasmTask.TypeLib"/>
- attribute is used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RegasmTask.Registered">
- <summary>
- Only refer to already registered type libraries.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RegasmTask.TypeLib">
- <summary>
- Export the assembly to the specified type library and register it.
- This attribute is ignored when a fileset is specified.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RegasmTask.Unregister">
- <summary>
- Unregister the assembly. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.RegasmTask.RegasmFileSet">
- <summary>
- The set of files to register.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute">
- <summary>
- Indicates that class should be validated by an XML Schema.
- </summary>
- <remarks>None.</remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SchemaValidatorAttribute.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute"/>
- class.
- </summary>
- <param name="schemaType">The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SchemaValidatorAttribute.#ctor(System.Type,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Tasks.SchemaValidatorAttribute"/>
- class.
- </summary>
- <param name="schemaType">The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.</param>
- <param name="xmlNamespace"></param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SchemaValidatorAttribute.ValidatorType">
- <summary>
- Gets or sets the <see cref="T:System.Type"/> of the object created by
- <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> to represent the root node of your task.
- </summary>
- <value>
- The <see cref="T:System.Type"/> of the object created by <see cref="T:NAnt.Contrib.Tasks.XsdTask"/>
- to represent the root node of your task.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SchemeType">
- <summary>
- Defines possible reference counting scheme types for the <see cref="T:NAnt.Contrib.Tasks.GacTask">GAC</see> tasks.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.SchemeType.None">
- <summary>
- Specifies that no reference counting scheme will be used when performing the GAC task.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.SchemeType.UninstallKey">
- <summary>
- Specifies that registry-related reference counting will be used when performing the GAC task.
- </summary>
- <remarks>
- When the scheme type is set to <c>UninstallKey</c>, the related scheme ID should be set to the name of the application
- set in the <c>HKLM\Software\Microsoft\Windows\CurrentVersion</c> registry key.
- </remarks>
-
- </member>
- <member name="F:NAnt.Contrib.Tasks.SchemeType.FilePath">
- <summary>
- Specifies that file-based reference counting will be used when performing the GAC task.
- </summary>
- <remarks>
- When the scheme type is set to <c>FilePath</c>, the related scheme ID should be set to the full path to the executable
- file that installs the assembly.
- </remarks>
-
- </member>
- <member name="F:NAnt.Contrib.Tasks.SchemeType.Opaque">
- <summary>
- Specifies that custom information will be supplied to accommodate reference counting.
- </summary>
- <remarks>
- When the scheme type is set to <c>Opaque</c>, the related scheme ID can be set to any custom piece of information.
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ScpTask">
- <summary>
- Copies a file to a remote server using scp.
- </summary>
- <remarks>
- <para>Copies a file using scp to a remote server.</para>
- <para>The Username Environment variable is used.</para>
- </remarks>
- <example>
- <para>Copy a single file to a remote server and path.</para>
- <code>
- <![CDATA[
- <scp file="myfile.zip" server="myServer" path="~" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramName">
- <summary>
- The program to execute. The default is "scp".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.Options">
- <summary>
- The command line arguments.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.FileName">
- <summary>
- The file to transfer.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.ServerName">
- <summary>
- The server to send the file to.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.RemotePath">
- <summary>
- The path on the remote server. The default is "~".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.UserName">
- <summary>
- The username to connect as. The default is the value of the
- <c>USERNAME</c> environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramPathSep">
- <summary>
- The path separator used by the program. The default is "/".
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ScpTask.BaseDirectory">
- <summary>
- The directory in which the command will be executed.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SlingshotTask">
- <summary>
- Converts a Visual Studio.NET Solution to a NAnt build file or nmake file.
- </summary>
- <example>
- <para>
- Convert the solution <c>MySolution.sln</c> to the NAnt build file
- <c>MySolution.build</c> and call the new build file.
- </para>
- <code>
- <![CDATA[
- <slingshot solution="MySolution.sln" format="nant" output="MySolution.build">
- <parameters>
- <option name="build.basedir" value="..\bin"/>
- </parameters>
- </slingshot>
- <nant buildfile="MySolution.build"/>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Convert the solution <c>MySolution.sln</c> to the NAnt build file
- <c>MySolution.build</c>. As the solution contains one or more web
- projects, one or more maps needs to be specified.
- </para>
- <code>
- <![CDATA[
- <slingshot solution="MySolution.sln" format="nant" output="MySolution.build">
- <parameters>
- <option name="build.basedir" value="..\bin"/>
- </parameters>
- <maps>
- <option name="http://localhost" value="C:\Inetpub\wwwroot"/>
- </maps>
- </slingshot>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SlingshotTask.CreateSolutionWriter(System.String)">
- <summary>
- Creates the <see cref="T:SLiNgshoT.Core.SolutionWriter"/> for the specified format.
- </summary>
- <returns>
- The <see cref="T:SLiNgshoT.Core.SolutionWriter"/> for the specified format, or
- <see langword="null"/> if an unknown format was specified.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SlingshotTask.OptionCollectionToHashtable(NAnt.Core.Types.OptionCollection,System.String)">
- <summary>
- Converts an <see cref="T:NAnt.Core.Types.OptionCollection"/> to a <see cref="T:System.Collections.Hashtable"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Solution">
- <summary>
- The Visual Studio.NET solution file to convert.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Format">
- <summary>
- The output file format - either <c>nant</c> or <c>nmake</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Output">
- <summary>
- The output file name.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Maps">
- <summary>
- Mappings from URI to directories. These are required for web projects.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SlingshotTask.Parameters">
- <summary>
- Parameters to pass to SLiNgshoT. The parameter <c>build.basedir</c> is required.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.SqlTask">
- <summary>
- A task to execute arbitrary SQL statements against a OLEDB data source.
- </summary>
- <remarks>
- 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).
- </remarks>
- <example>
- <para>
- Execute a set of statements inside a transaction.
- </para>
- <code>
- <![CDATA[
- <sql
- connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"
- transaction="true"
- delimiter=";"
- delimstyle="Normal"
- >
- 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;
- </sql>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Execute a set of statements from a file and write all query results
- to a file.
- </para>
- <code>
- <![CDATA[
- <sql
- connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"
- transaction="true"
- delimiter=";"
- delimstyle="Normal"
- print="true"
- source="sql.txt"
- output="${outputdir}/results.txt"
- />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Execute a SQL script generated by SQL Server Enterprise Manager.
- </para>
- <code>
- <![CDATA[
- <sql
- connstring="Provider=SQLOLEDB;Data Source=localhost; Initial Catalog=Pruebas; Integrated Security=SSPI"
- transaction="true"
- delimiter="GO"
- delimstyle="Line"
- print="true"
- source="pubs.xml"
- batch="false"
- output="${outputdir}/results.txt"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SqlTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- <param name="taskNode">XML node used to define this task instance.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteTask">
- <summary>
- This is where the work is done.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteStatements(NAnt.Contrib.Util.SqlHelper)">
- <summary>
- Executes the SQL Statements one by one.
- </summary>
- <param name="sqlHelper"></param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SqlTask.ExecuteStatementsInBatch(NAnt.Contrib.Util.SqlHelper)">
- <summary>
- Executes the SQL statements in a single batch.
- </summary>
- <param name="sqlHelper"></param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.SqlTask.ProcessResults(System.Data.IDataReader,System.IO.TextWriter)">
- <summary>
- Process a result set.
- </summary>
- <param name="results">Result set.</param>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> to write output to.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.ConnectionString">
- <summary>
- Connection string used to access database.
- This should be an OleDB connection string.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.Encoding">
- <summary>
- The encoding of the files containing SQL statements. The default is
- the system's current ANSI code page.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.Source">
- <summary>
- File where the sql statements are defined.
- </summary>
- <remarks>
- You cannot specify both a source and an inline set of statements.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.Delimiter">
- <summary>
- String that separates statements from one another.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.Batch">
- <summary>
- If true, the statements will be executed as a single batch.
- If false, they will be executed one by one. Default is true.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.ExpandProperties">
- <summary>
- If true, the any nant-style properties on the sql will be
- expanded before execution. Default is true.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.CommandTimeout">
- <summary>
- Command timeout to use when creating commands.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.DelimiterStyle">
- <summary>
- Kind of delimiter used. Allowed values are Normal or Line.
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.Print">
- <summary>
- If set to true, results from the statements will be
- output to the build log.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.Output">
- <summary>
- If set, the results from the statements will be output to the
- specified file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.UseTransaction">
- <summary>
- If set to <see langword="true" />, all statements will be executed
- within a single transaction. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.Append">
- <summary>
- Whether output should be appended to or overwrite
- an existing file. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.ShowHeaders">
- <summary>
- If set to <see langword="true" />, prints headers for result sets.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.QuoteChar">
- <summary>
- The character(s) to surround result columns with when printing, the
- default is an empty string.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.SqlTask.OutputWriter">
- <summary>
- Gets the underlying <see cref="T:System.IO.TextWriter"/> to which output will
- be written if <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/> is set.
- </summary>
- <value>
- A <see cref="T:System.IO.TextWriter"/> for the file specified in <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/>,
- or <see langword="null"/> if <see cref="P:NAnt.Contrib.Tasks.SqlTask.Output"/> is not set.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.TryCatchTask">
- <summary>
- 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.
- </summary>
- <remarks>
- <para>
- The tasks defined in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c> block
- will be executed in turn, as they normally would in a target.
- </para>
- <para>
- If a <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c> block is defined, the
- tasks in that block will be executed in turn only if one of the tasks
- in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c> block fails. This
- failure will then be suppressed by the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>
- block.
- </para>
- <para>
- The message associated with the failure can also be caught in a
- property for use within the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>
- block. The original contents of the property will be restored upon
- exiting the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c> block.
- </para>
- <para>
- If a <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>></c> block is defined, the
- tasks in that block will be executed after the tasks in both the
- <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c> and <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>
- blocks have been executed, regardless of whether any task fails in
- either block.
- </para>
- </remarks>
- <example>
- <code>
- <![CDATA[
- <trycatch>
- <try>
- <echo message="In try" />
- <fail message="Failing!" />
- </try>
- <catch>
- <echo message="In catch" />
- </catch>
- <finally>
- <echo message="Finally done" />
- </finally>
- </trycatch>
- ]]>
- </code>
- <para>
- The output of this example will be:
- </para>
- <code>
- In try
- In catch
- Finally done
- </code>
- <para>
- The failure in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c> block will
- not cause the build to fail.
- </para>
- </example>
- <example>
- <code>
- <![CDATA[
- <trycatch>
- <try>
- <echo message="In try" />
- <fail message="Just because..." />
- </try>
- <catch property="failure">
- <echo message="Caught failure: ${failure}" />
- <fail message="Bad catch" />
- </catch>
- <finally>
- <echo message="Finally done" />
- </finally>
- </trycatch>
- ]]>
- </code>
- <para>
- The output of this example will be:
- </para>
- <code>
- In try
- Caught failure: Just because...
- Finally done
- Build failed: Bad catch
- </code>
- <para>
- Like the above, the failure in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock"/>></c>
- block does not cause the build to fail. The failure in the
- <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c> block does, however.
- Note that the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>></c> block is
- executed even though the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>
- block failed.
- </para>
- </example>
- <example>
- <code>
- <![CDATA[
- <trycatch>
- <try>
- <echo message="In try" />
- <fail message="yet again" />
- </try>
- <catch property="failure">
- <echo message="Caught failure ${failure}" />
- <fail message="Bad catch" />
- </catch>
- <finally>
- <echo message="Finally done ${failure}" />
- </finally>
- </trycatch>
- ]]>
- </code>
- <para>
- The output of this example will be:
- </para>
- <code>
- In try
- Caught failure yet again
- Build failed: Property 'failure' has not been set.
- </code>
- <para>
- The <see cref="T:NAnt.Core.Tasks.EchoTask"/> in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>></c>
- block failed because the "failure" property was not defined
- after exiting the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c> block.
- Note that the failure in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock"/>></c>
- block has eclipsed the failure in the <c><<see cref="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock"/>></c>
- block.
- </para>
- </example>
- <example>
- <code>
- <![CDATA[
- <trycatch>
- <try>
- <property name="temp.file" value="${path::get-temp-file-name()}" />
- <do-stuff to="${temp.file}" />
- <fail message="Oops..." />
- </try>
- <finally>
- <echo message="Cleaning up..." />
- <if test="${property::exists('temp.file')}">
- <delete file="${temp.file}" />
- </if>
- </finally>
- </trycatch>
- ]]>
- </code>
- <para>
- A more concrete example, that will always clean up the generated
- temporary file after it has been created.
- </para>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.TryCatchTask.TryBlock">
- <summary>
- The tasks in this block will be executed as a normal part of
- the build script.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.TryCatchTask.CatchBlock">
- <summary>
- The tasks in this block will be executed if any task in the try
- block fails.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.TryCatchTask.FinallyBlock">
- <summary>
- The tasks in this block will always be executed, regardless of
- what happens in the try and catch blocks.
- </summary>
- <remarks>
- Note that any failure in any of the tasks in this block will
- prevent any subsequent tasks from executing.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.TryCatchTask.CatchElement.Property">
- <summary>
- Defines the name of the property to save the message describing
- the failure that has been caught.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- <para>
- Readonly properties cannot be overridden by this mechanism.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Contrib.Tasks.TypedCollectionTask">
- <summary>Generates collection classes based on a given XML specification file. Code generation is in the specified language.</summary>
- <remarks>
- <para>See the <a href="http://www.sellsbrothers.com/tools/">CollectionGen tool page</a> for more information.</para>
- </remarks>
- <example>
- <code>
- <![CDATA[
- <typedcollection language="CSharp">
- <fileset>
- <include name="collections.xml" />
- </fileset>
- </typedcollection>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.TypedCollectionTask.GenerateCollectionClasses(System.String,System.String)">
- <summary>
- The actual generation work is done here.
- </summary>
- <param name="path"></param>
- <param name="language"></param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.Language">
- <summary>The language to generate collection classes for. Valid values are "CSharp" or "VB".</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.FileName">
- <summary>The name of the template file for collection generation. This is provided as an alternate to using the task's fileset.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.TypedCollectionTask.TypedCollFileSet">
- <summary>
- All files in this fileset will be run thru the collection generator.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.ValidateXmlTask">
- <summary>
- Validates a set of XML files based on a set of XML Schemas (XSD).
- </summary>
- <example>
- <code>
- <![CDATA[
- <validatexml>
- <schemas>
- <schema source="rcf-schema.xsd" />
- <schema namespace="urn:schemas-company-com:base" source="base-schema.xsd" />
- </schemas>
- <files>
- <include name="*.xml" />
- </files>
- </validatexml>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.ValidateXmlTask.ExecuteTask">
- <summary>
- This is where the work is done.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ValidateXmlTask.XmlFiles">
- <summary>
- The XML files that must be validated.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.ValidateXmlTask.Schemas">
- <summary>
- The XML Schemas (XSD) to use for validation.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.Vb6Task">
- <summary>
- Compiles Microsoft Visual Basic 6 programs.
- </summary>
- <remarks>
- <para>
- Uses the VB6.EXE executable included with the Visual Basic 6
- environment.
- </para>
- <para>
- The compiler uses the settings and source files specified in the
- project or group file.
- </para>
- </remarks>
- <example>
- <para>
- Build the project <c>HelloWorld.vbp</c> in the <c>build</c> directory.
- </para>
- <code>
- <![CDATA[
- <vb6 project="HelloWorld.vbp" outdir="build" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Vb6Task.ExecuteTask">
- <summary>
- Compiles the Visual Basic project or project group.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Vb6Task.ParseGroupFile(System.IO.FileInfo)">
- <summary>
- Parses a VB group file and extract the file names of the sub-projects
- in the group.
- </summary>
- <param name="groupFile">The file name of the group file.</param>
- <returns>
- A string collection containing the list of sub-projects in the group.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Vb6Task.ProjectNeedsCompiling(System.String)">
- <summary>
- 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.
- </summary>
- <param name="projectFile">The file name of the project file.</param>
- <returns>
- <see langword="true" /> if the project should be compiled; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Vb6Task.VB6GetTypeLibFile(System.Guid,System.UInt16,System.UInt16,System.UInt32)">
- <summary>
- 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
- </summary>
- <param name="guid">The guid of the tlb to look for</param>
- <param name="major">The major version number of the tlb</param>
- <param name="minor16">The minor version number of the tlb. If you parse minor from a string, treat the string as hex value.</param>
- <param name="lcid">The culture id</param>
- <returns>null if couldn't find a match, otherwise it returns the file.</returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.Vb6Task.ParseProjectFile(System.String,NAnt.Core.Types.FileSet,NAnt.Core.Types.FileSet)">
- <summary>
- Parses a VB project file and extracts the source files, reference files, and
- the name of the compiled file for the project.
- </summary>
- <param name="projectFile">The filename of the project file.</param>
- <param name="sources">
- A fileset representing the source files of the project, which will
- populated by the method.
- </param>
- <param name="references">
- A fileset representing the references of the project, which will
- populated by the method.
- </param>
- <returns>A string containing the output file name for the project.</returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Vb6Task.OutDir">
- <summary>
- Output directory for the compilation target.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProjectFile">
- <summary>
- Visual Basic project or group file.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Vb6Task.CheckReferences">
- <summary>
- Determines whether project references are checked when deciding
- whether the project needs to be recompiled. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Vb6Task.ErrorFile">
- <summary>
- The file to which the Visual Basic compiler should log errors.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Vb6Task.Conditionals">
- <summary>
- Tells Visual Basic which values to use for conditional compilation
- constants.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- </member>
- <member name="P:NAnt.Contrib.Tasks.Vb6Task.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.VersionTask">
- <summary>
- Increments a four-part version number stored in a text file. The resulting
- version number is written back to the file and exposed using NAnt properties.
- </summary>
- <remarks>
- <para>
- The version number format in the text file is
- Major.Minor.Build.Revision, e.g. 1.0.5.25.
- </para>
- <list type="table">
- <item>
- <term>Major</term>
- <description>Set in file.</description>
- </item>
- <item>
- <term>Minor</term>
- <description>Set in file.</description>
- </item>
- <item>
- <term>Build</term>
- <description>Can be incremented by setting the <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/> parameter.</description>
- </item>
- <item>
- <term>Revision</term>
- <description>Can be incremented by setting the <see cref="P:NAnt.Contrib.Tasks.VersionTask.RevisionType"/> parameter.</description>
- </item>
- </list>
- <para>The following NAnt properties are created:</para>
- <list type="table">
- <item>
- <term><c>prefix</c>.version</term>
- <description>The complete version number, i.e. Major.Minor.Build.Revision</description>
- </item>
- <item>
- <term><c>prefix</c>.major</term>
- <description>The major component of the version number.</description>
- </item>
- <item>
- <term><c>prefix</c>.minor</term>
- <description>The minor component of the version number.</description>
- </item>
- <item>
- <term><c>prefix</c>.build</term>
- <description>The build component of the version number.</description>
- </item>
- <item>
- <term><c>prefix</c>.revision</term>
- <description>The revision component of the version number.</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Tasks.VersionTask.ReadVersionFromFile">
- <summary>
- Reads a version string from <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/> and returns it as a
- <see cref="T:System.Version"/> instance.
- </summary>
- <returns>
- A <see cref="T:System.Version"/> instance representing the version string in
- <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.VersionTask.WriteVersionToFile(System.Version)">
- <summary>
- Writes the specified version to <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.
- </summary>
- <param name="version">The version to write to <see cref="P:NAnt.Contrib.Tasks.VersionTask.Path"/>.</param>
- </member>
- <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateMonthDayBuildNumber">
- <summary>
- Calculates the build number based on the number of months since the
- start date.
- </summary>
- <returns>
- The build number based on the number of months since the start date.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateSecondsSinceMidnight">
- <summary>
- Calculates the number of seconds since midnight.
- start date.
- </summary>
- <returns>
- The number of seconds since midnight.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateBuildNumber(System.Int32)">
- <summary>
- Calculates the build number of the version number based on
- <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/>.
- </summary>
- <returns>
- The build number.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateVersion">
- <summary>
- Calculates the complete version.
- </summary>
- <returns>
- The version.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Tasks.VersionTask.CalculateRevisionNumber(System.Version,System.Int32)">
- <summary>
- Calculates the revision number of the version number based on RevisionType specified
- </summary>
- <returns>
- The revision number.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Tasks.VersionTask.Prefix">
- <summary>
- The string to prefix the properties with. The default is
- <c>'buildnumber.'</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.VersionTask.StartDate">
- <summary>
- Start of project. Date from which to calculate build number.
- Required if <see cref="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay"/> is used as
- <see cref="P:NAnt.Contrib.Tasks.VersionTask.BuildType"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.VersionTask.Path">
- <summary>
- Path to the file containing the current version number. The default
- file is <c>'build.number'</c> in the project base directory.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.VersionTask.BuildType">
- <summary>
- The algorithm for generating build number. The default is
- <see cref="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.VersionTask.RevisionType">
- <summary>
- The algorithm for generating revision number. The default is
- <see cref="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Automatic"/>.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm">
- <summary>
- Defines possible algorithms to generate the build number.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.MonthDay">
- <summary>
- Use the number of months since start of project * 100 + current
- day in month as build number.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.Increment">
- <summary>
- Increment an existing build number.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.VersionTask.BuildNumberAlgorithm.NoIncrement">
- <summary>
- Use an existing build number (and do not increment it).
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm">
- <summary>
- Defines possible algorithms to generate the revision number.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Automatic">
- <summary>
- Use the number of seconds since the start of today / 10.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Tasks.VersionTask.RevisionNumberAlgorithm.Increment">
- <summary>
- Increment an existing revision number.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Tasks.WsdlTask">
- <summary>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.</summary>
- <example>
- <para>Generate a proxy class for a web service.</para>
- <code><![CDATA[<wsdl path="http://www.somewhere.com/myservice.wsdl"
- language="CS" namespace="MyCompany.MyService" outfile="MyService.cs" />]]></code>
- </example>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.Path">
- <summary>URL or Path to a WSDL, XSD, or .discomap document.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.NoLogo">
- <summary>Suppresses the banner.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.Language">
- <summary>Language of generated code. 'CS', 'VB', 'JS',
- or the fully-qualified name of a class implementing
- System.CodeDom.Compiler.CodeDomCompiler. </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.ForServer">
- <summary>Compiles server-side ASP.NET abstract classes
- based on the web service contract. The default is to
- create client side proxy classes. </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.Namespace">
- <summary>Microsoft.NET namespace of generated classes.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.OutFile">
- <summary>Output filename of the created proxy. Default name is derived from the service name.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.Protocol">
- <summary>Override default protocol to implement. Choose from 'SOAP',
- 'HttpGet', 'HttpPost', or a custom protocol as specified in the
- configuration file.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.Username">
- <summary>Username of an account with credentials to access a
- server that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.Password">
- <summary>Password of an account with credentials to access a
- server that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.Domain">
- <summary>Domain of an account with credentials to access a
- server that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.Proxy">
- <summary>URL of a proxy server to use for HTTP requests.
- The default is to use the system proxy setting.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyUsername">
- <summary>Username of an account with credentials to access a
- proxy that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyPassword">
- <summary>Password of an account with credentials to access a
- proxy that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProxyDomain">
- <summary>Domain of an account with credentials to access a
- proxy that requires authentication.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.UrlKey">
- <summary>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.</summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.BaseUrl">
- <summary>Base Url to use when calculating the Url fragment.
- The UrlKey attribute must also be specified. </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.WsdlTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Tasks.XsdTask">
- <summary>
- The <see cref="T:NAnt.Contrib.Tasks.XsdTask"/> generates XML schema or common language runtime
- classes from XDR, XML, and XSD files, or from classes in a runtime assembly.
- </summary>
- <remarks>
- <para>
- The following operations can be performed :
- </para>
- <list type="table">
- <listheader>
- <term>Operation</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>XDR to XSD</term>
- <description>
- Generates an XML schema from an XML-Data-Reduced schema file.
- XDR is an early XML-based schema format.
- </description>
- </item>
- <item>
- <term>XML to XSD</term>
- <description>
- Generates an XML schema from an XML file.
- </description>
- </item>
- <item>
- <term>XSD to DataSet</term>
- <description>
- Generates common language runtime <see cref="T:System.Data.DataSet"/>
- classes from an XSD schema file. The generated classes
- provide a rich object model for regular XML data.
- </description>
- </item>
- <item>
- <term>XSD to Classes</term>
- <description>
- Generates runtime classes from an XSD schema file. The
- generated classes can be used in conjunction with
- <see cref="T:System.Xml.Serialization.XmlSerializer"/> to
- read and write XML code that follows the schema.
- </description>
- </item>
- <item>
- <term>Classes to XSD</term>
- <description>
- Generates an XML schema from a type or types in a runtime
- assembly file. The generated schema defines the XML format
- used by <see cref="T:System.Xml.Serialization.XmlSerializer"/>.
- </description>
- </item>
- </list>
- </remarks>
- <example>
- <para>Compile a XML Schema.</para>
- <code>
- <![CDATA[
- <xsd
- schema="MySchema.xsd"
- element="MyRootElement"
- language="CS"
- namespace="MyCompany.MySchema"
- outputdir="build\bin"
- uri="http://MySchema'sTargetNamespace" />
- ]]>
- </code>
- </example>
- <example>
- <para>Generate an XML Schema from an assembly.</para>
- <code>
- <![CDATA[
- <xsd assembly="MyAssembly.dll" outputdir="build\Schemas" />
- ]]>
- </code>
- </example>
- <example>
- <para>Generate an XML Schema from an XML document.</para>
- <code>
- <![CDATA[
- <xsd xmldoc="MyDoc.xml" outputdir="build\Schemas" />
- ]]>
- </code>
- </example>
- <example>
- <para>Generate an XML Schema from an XDR Schema.</para>
- <code>
- <![CDATA[
- <xsd xdr="MyOldSchema.xdr" outputdir="build\Schemas" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Contrib.Tasks.XsdTask.InitializeTask(System.Xml.XmlNode)">
- <summary>
- Validates the <see cref="T:NAnt.Core.Task"/>.
- </summary>
- <param name="taskNode">The <see cref="T:System.Xml.XmlNode"/> used to initialize the <see cref="T:NAnt.Core.Task"/>.</param>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Schema">
- <summary>
- XML Schema (.xsd) filename.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Target">
- <summary>
- Target of XML Schema compilation - either <c>classes</c> or
- <c>dataset</c>. The default is <c>classes</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Element">
- <summary>
- XML element in the Schema to process.
- </summary>
- <remarks>
- TO-DO : turn this into collection of elements !
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Language">
- <summary>
- The language to use for the generated code - either <c>CS</c>,
- <c>VB</c>, <c>JS</c>, <c>VJC</c> or the fully-qualified name of a
- class implementing <see cref="T:System.CodeDom.Compiler.CodeDomProvider"/>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Namespace">
- <summary>
- Specifies the runtime namespace for the generated types. The default
- namespace is <c>Schemas</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.OutputDir">
- <summary>
- The output directory in which to place generated files.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Assembly">
- <summary>
- Assembly (.dll or .exe) to generate an XML Schema for.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Types">
- <summary>
- Types in the assembly for which an XML schema is being created.
- By default all types in the assembly will be included.
- </summary>
- <remarks>
- TO-DO : turn this into collection of types !
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Uri">
- <summary>
- Specifies the URI for the elements in the <see cref="P:NAnt.Contrib.Tasks.XsdTask.Schema"/> to
- generate code for.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.XmlDoc">
- <summary>
- XML document to generate an XML Schema for.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.Xdr">
- <summary>
- XDR Schema to generate an XML Schema for.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Tasks.XsdTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.Contrib.Types.BizTalk.ServiceStatus">
- <summary>
- Indicates the status of a service.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Unbound">
- <summary>
- The service is unbound.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Bound">
- <summary>
- The service is bound.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Stopped">
- <summary>
- The service is enlisted, but not started.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.BizTalk.ServiceStatus.Started">
- <summary>
- The service is started.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.ClearCase.TypeKindConverter">
- <summary>
- Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that supports converting
- a <see cref="T:NAnt.Contrib.Types.ClearCase.TypeKind"/> to a string value that can be used in
- ClearCase commandline tools.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.ClearCase.TypeKindConverter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.ClearCase.TypeKindConverter"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.ClearCase.TypeKindConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)">
- <summary>
- Introduces specialized behavior for converting a <see cref="T:NAnt.Contrib.Types.ClearCase.TypeKind"/>
- value to a string that can be used in ClearCase commandline tools.
- </summary>
- <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
- <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
- <param name="value">The <see cref="T:System.Object"/> to convert.</param>
- <param name="destinationType">The <see cref="T:System.Type"/> which <paramref name="value"/> should be converted to.</param>
- <returns>
- An <see cref="T:System.Object"/> that represents the converted value.
- </returns>
- </member>
- <member name="T:NAnt.Contrib.Types.NUnit2Report.ReportFormat">
- <summary>
- Defines the report types supported by <see cref="T:NAnt.Contrib.Tasks.NUnit2Report.NUnit2ReportTask"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.Frames">
- <summary>
- Report with separate HTML frames.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.NUnit2Report.ReportFormat.NoFrames">
- <summary>
- Frameless report.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.PVCS.Entity">
- <summary>
- Represents an entity in an <see cref="T:NAnt.Contrib.Types.PVCS.EntitySet"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.PVCS.Entity._name">
- <see cref="P:NAnt.Contrib.Types.PVCS.Entity.Name"/>
- </member>
- <member name="F:NAnt.Contrib.Types.PVCS.Entity._if">
- <see cref="P:NAnt.Contrib.Types.PVCS.Entity.If"/>
- </member>
- <member name="F:NAnt.Contrib.Types.PVCS.Entity._unless">
- <see cref="P:NAnt.Contrib.Types.PVCS.Entity.Unless"/>
- </member>
- <member name="M:NAnt.Contrib.Types.PVCS.Entity.#ctor">
- <summary>
- Constructs and initializes an instance of <c>Entity</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.PVCS.Entity.Name">
- <summary>
- The path for the entity.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.PVCS.Entity.If">
- <summary>
- If <c>true</c> then the entity will be included. The default is <c>true</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.PVCS.Entity.Unless">
- <summary>
- Opposite of <see cref="P:NAnt.Contrib.Types.PVCS.Entity.If"/>. If <c>false</c> then the entity will be included. The default is
- <c>false</c>.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.PVCS.EntitySet">
- <summary>
- Represents a set of entities to include in a PVCS project database task.
- </summary>
- <seealso cref="T:NAnt.Contrib.Tasks.PVCS.PVCSMultipleEntityTask"/>
- </member>
- <member name="F:NAnt.Contrib.Types.PVCS.EntitySet._entityPaths">
- <see cref="P:NAnt.Contrib.Types.PVCS.EntitySet.EntityPaths"/>
- </member>
- <member name="M:NAnt.Contrib.Types.PVCS.EntitySet.#ctor">
- <summary>
- Constructs and initializes an instance of <c>EntitySet</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.PVCS.EntitySet.EntityPaths">
- <summary>
- Gets the collection of entity paths assigned to this entity set.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.PVCS.EntitySet.Entities">
- <summary>
- The entities to include in the project task.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.Assembly">
- <summary>
- Represents a single assembly in an <see cref="T:NAnt.Contrib.Types.AssemblySet"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.Assembly._culture">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.Assembly.Culture"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.Assembly._if">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.Assembly.If"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.Assembly._name">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.Assembly.Name"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.Assembly._publicKeyToken">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.Assembly.PublicKeyToken"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.Assembly._unless">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.Assembly.Unless"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.Assembly._version">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.Assembly.Version"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.Assembly.#ctor">
- <summary>
- Constructs and initializes an instance of <c>Assembly</c>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.Assembly.ToString">
- <summary>
- Converts this <c>Assembly</c> object into it's <c>string</c> representation.
- </summary>
- <returns></returns>
- </member>
- <member name="P:NAnt.Contrib.Types.Assembly.Culture">
- <summary>
- The culture for the assembly.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.Assembly.If">
- <summary>
- If <c>true</c> then the assembly will be included. The default is <c>true</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.Assembly.Name">
- <summary>
- The name of the assembly.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.Assembly.PublicKeyToken">
- <summary>
- The public key token of the assembly.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.Assembly.Unless">
- <summary>
- Opposite of <see cref="P:NAnt.Contrib.Types.Assembly.If"/>. If <c>false</c> then the assembly will be included. The default is
- <c>false</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.Assembly.Version">
- <summary>
- The version of the assembly.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.AssemblySet">
- <summary>
- Represents a set of assemblies via their identity information.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.AssemblySet._assemblyCollection">
- <see cref="P:NAnt.Contrib.Types.AssemblySet.AssemblyCollection"/>
- </member>
- <member name="M:NAnt.Contrib.Types.AssemblySet.#ctor">
- <summary>
- Constructs and initializes an instance of <c>AssemblySet</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.AssemblySet.AssemblyCollection">
- <summary>
- Gets the collection of assemblies added to this assembly set.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.AssemblySet.Assemblies">
- <summary>
- The assemblies to include.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.CodeStatsCount.FileSet">
- <summary>
- The set of files to work on.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.CodeStatsCount.Label">
- <summary>
- The label to apply to the results.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.CodeStatsCountCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor(NAnt.Contrib.Types.CodeStatsCountCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class
- with the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.#ctor(NAnt.Contrib.Types.CodeStatsCount[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> class
- with the specified array of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Add(NAnt.Contrib.Types.CodeStatsCount)">
- <summary>
- Adds a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.AddRange(NAnt.Contrib.Types.CodeStatsCount[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.AddRange(NAnt.Contrib.Types.CodeStatsCountCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Contains(NAnt.Contrib.Types.CodeStatsCount)">
- <summary>
- Determines whether a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with
- value <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.CopyTo(NAnt.Contrib.Types.CodeStatsCount[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.IndexOf(NAnt.Contrib.Types.CodeStatsCount)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/>. If the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Insert(System.Int32,NAnt.Contrib.Types.CodeStatsCount)">
- <summary>
- Inserts a <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to insert.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Contrib.Types.CodeStatsCountEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountCollection.Remove(NAnt.Contrib.Types.CodeStatsCount)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Contrib.Types.CodeStatsCountCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Contrib.Types.CodeStatsCountCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> with the specified name.
- </summary>
- <param name="value">The name of the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> to get.</param>
- </member>
- <member name="T:NAnt.Contrib.Types.CodeStatsCountEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Contrib.Types.CodeStatsCount"/> elements of a <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.#ctor(NAnt.Contrib.Types.CodeStatsCountCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.CodeStatsCountEnumerator"/> class
- with the specified <see cref="T:NAnt.Contrib.Types.CodeStatsCountCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.CodeStatsCountEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.CodeStatsCountEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Contrib.Types.Filter">
- <summary>
- Individual filter component of <see cref="T:NAnt.Contrib.Types.FilterSet"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.Filter._token">
- <summary>
- Holds the token which will be replaced in the filter operation.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.Filter._value">
- <summary>
- Holsd the value which will replace the token in the filtering operation.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.Filter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.Filter"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.Filter.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.Filter"/> class with
- the given token and value.
- </summary>
- <param name="token">The token which will be replaced when filtering.</param>
- <param name="value">The value which will replace the token when filtering.</param>
- </member>
- <member name="P:NAnt.Contrib.Types.Filter.Token">
- <summary>
- The token which will be replaced when filtering.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.Filter.Value">
- <summary>
- The value which will replace the token when filtering.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.FilterCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Contrib.Types.Filter"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor(NAnt.Contrib.Types.FilterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class
- with the specified <see cref="T:NAnt.Contrib.Types.FilterCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.#ctor(NAnt.Contrib.Types.Filter[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterCollection"/> class
- with the specified array of <see cref="T:NAnt.Contrib.Types.Filter"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.Add(NAnt.Contrib.Types.Filter)">
- <summary>
- Adds a <see cref="T:NAnt.Contrib.Types.Filter"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.AddRange(NAnt.Contrib.Types.Filter[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Contrib.Types.Filter"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Contrib.Types.Filter"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.AddRange(NAnt.Contrib.Types.FilterCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Contrib.Types.FilterCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.Contains(NAnt.Contrib.Types.Filter)">
- <summary>
- Determines whether a <see cref="T:NAnt.Contrib.Types.Filter"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Contrib.Types.Filter"/> with the specified
- token is in the collection.
- </summary>
- <param name="token">The token to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.Filter"/> with the given
- token is found in the collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.CopyTo(NAnt.Contrib.Types.Filter[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.IndexOf(NAnt.Contrib.Types.Filter)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.Filter"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Contrib.Types.Filter"/>. If the <see cref="T:NAnt.Contrib.Types.Filter"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.Insert(System.Int32,NAnt.Contrib.Types.Filter)">
- <summary>
- Inserts a <see cref="T:NAnt.Contrib.Types.Filter"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to insert.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Contrib.Types.FilterEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterCollection.Remove(NAnt.Contrib.Types.Filter)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.Filter"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Contrib.Types.FilterCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Contrib.Types.FilterCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Contrib.Types.Filter"/> with the specified token.
- </summary>
- <param name="token">The token to get.</param>
- </member>
- <member name="T:NAnt.Contrib.Types.FilterEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Contrib.Types.Filter"/> elements of a <see cref="T:NAnt.Contrib.Types.FilterCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterEnumerator.#ctor(NAnt.Contrib.Types.FilterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterEnumerator"/> class
- with the specified <see cref="T:NAnt.Contrib.Types.FilterCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.FilterEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Contrib.Types.FilterSet">
- <summary>
- A set of filters to be applied to something.
- </summary>
- <remarks>
- <para>
- A filter set may have begintoken and endtokens defined.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Contrib.Types.FilterSet.DefaultTokenStart">
- <summary>
- The default token start string.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.FilterSet.DefaultTokenEnd">
- <summary>
- The default token end string.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSet.ReplaceTokens(System.String)">
- <summary>
- Does replacement on the given string with token matching.
- </summary>
- <param name="line">The line to process the tokens in.</param>
- <returns>
- The line with the tokens replaced.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Types.FilterSet.BeginToken">
- <summary>
- The string used to identity the beginning of a token. The default is
- <c>@</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.FilterSet.EndToken">
- <summary>
- The string used to identify the end of a token. The default is
- <c>@</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.FilterSet.Filters">
- <summary>
- The filters to apply.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.FilterSetCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor(NAnt.Contrib.Types.FilterSetCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class
- with the specified <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.#ctor(NAnt.Contrib.Types.FilterSet[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> class
- with the specified array of <see cref="T:NAnt.Contrib.Types.FilterSet"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.Add(NAnt.Contrib.Types.FilterSet)">
- <summary>
- Adds a <see cref="T:NAnt.Contrib.Types.FilterSet"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.AddRange(NAnt.Contrib.Types.FilterSet[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterSet"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.AddRange(NAnt.Contrib.Types.FilterSetCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.Contains(NAnt.Contrib.Types.FilterSet)">
- <summary>
- Determines whether a <see cref="T:NAnt.Contrib.Types.FilterSet"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.CopyTo(NAnt.Contrib.Types.FilterSet[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.IndexOf(NAnt.Contrib.Types.FilterSet)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.FilterSet"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Contrib.Types.FilterSet"/>. If the <see cref="T:NAnt.Contrib.Types.FilterSet"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.Insert(System.Int32,NAnt.Contrib.Types.FilterSet)">
- <summary>
- Inserts a <see cref="T:NAnt.Contrib.Types.FilterSet"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to insert.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Contrib.Types.FilterSetEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.Remove(NAnt.Contrib.Types.FilterSet)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.FilterSet"/> to remove from the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.ReplaceTokens(System.String)">
- <summary>
- Does replacement on the given string with token matching.
- </summary>
- <param name="line">The line to process the tokens in.</param>
- <returns>
- The line with the tokens replaced.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetCollection.HasFilters">
- <summary>
- Checks to see if there are filters in the collection of filtersets.
- </summary>
- <returns>
- <see langword="true" /> if there are filters in this collection of
- filtersets; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.Contrib.Types.FilterSetCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.Contrib.Types.FilterSetEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Contrib.Types.FilterSet"/> elements of a <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.#ctor(NAnt.Contrib.Types.FilterSetCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.FilterSetEnumerator"/> class
- with the specified <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.FilterSetEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.FilterSetEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Contrib.Types.GacReference">
- <summary>
- Used to specify reference information when working with the GAC.
- </summary>
- <remarks>
- <para>
- The full details of GAC references can be found in the SDK documentation.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Contrib.Types.GacReference._if">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.GacReference.If"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.GacReference._unless">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.GacReference.Unless"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.GacReference._schemeType">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeType"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.GacReference._schemeId">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeId"/>.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Types.GacReference._schemeDescription">
- <summary>
- See <see cref="P:NAnt.Contrib.Types.GacReference.SchemeDescription"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.GacReference.#ctor">
- <summary>
- Constructs and initializes an instance of <c>GacReference</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.GacReference.If">
- <summary>
- If <c>true</c> then the entity will be included. The default is <c>true</c>.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.GacReference.SchemeType">
- <summary>
- The scheme type to use when working with GAC references. The default
- is <see cref="F:SchemeType.None" />, which means that references will
- not be used by the GAC task.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.GacReference.SchemeId">
- <summary>
- The scheme ID to use when working with GAC references. This is only
- relevant if a scheme type other than <see cref="F:SchemeType.None" />
- is specified.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.GacReference.SchemeDescription">
- <summary>
- The scheme description to use when working with GAC references. This
- is only relevant if a scheme type other than <see cref="F:SchemeType.None" />
- is specified.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.GacReference.Unless">
- <summary>
- Opposite of <see cref="P:NAnt.Contrib.Types.GacReference.If"/>. If <c>false</c> then the entity will be included. The default is
- <c>false</c>.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.SchemaElement">
- <summary>
- Represents the an element based on a schema definition.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.XmlSchemaReference">
- <summary>
- Represents the schema collection element.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.XmlSchemaReference.Namespace">
- <summary>
- Namespace URI associated with this schema.
- If not present, it is assumed that the
- schema's targetNamespace value is to be used.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.XmlSchemaReference.Source">
- <summary>
- Location of this schema. Could be a
- local file path or an HTTP URL.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class
- with the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.#ctor(NAnt.Contrib.Types.XmlSchemaReference[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> class
- with the specified array of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Add(NAnt.Contrib.Types.XmlSchemaReference)">
- <summary>
- Adds a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.AddRange(NAnt.Contrib.Types.XmlSchemaReference[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.AddRange(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Contains(NAnt.Contrib.Types.XmlSchemaReference)">
- <summary>
- Determines whether a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with
- value <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.CopyTo(NAnt.Contrib.Types.XmlSchemaReference[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.IndexOf(NAnt.Contrib.Types.XmlSchemaReference)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/>. If the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Insert(System.Int32,NAnt.Contrib.Types.XmlSchemaReference)">
- <summary>
- Inserts a <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to insert.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Remove(NAnt.Contrib.Types.XmlSchemaReference)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> with the specified name.
- </summary>
- <param name="value">The name of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> to get.</param>
- </member>
- <member name="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Contrib.Types.XmlSchemaReference"/> elements of a <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.#ctor(NAnt.Contrib.Types.XmlSchemaReferenceCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator"/> class
- with the specified <see cref="T:NAnt.Contrib.Types.XmlSchemaReferenceCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Types.XmlSchemaReferenceEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Contrib.Util.ChecksumHelper">
- <summary>
- Helper class to calculate checksums
- of files.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.ChecksumHelper.#ctor(System.String)">
- <summary>
- Create a new instance
- </summary>
- <param name="providerName">Name of hash algorithm to use</param>
- </member>
- <member name="M:NAnt.Contrib.Util.ChecksumHelper.CalculateChecksum(System.String)">
- <summary>
- Calculates a checksum for a given file
- and returns it in a hex string
- </summary>
- <param name="filename">name of the input file</param>
- <returns>hex checksum string</returns>
- </member>
- <member name="M:NAnt.Contrib.Util.ChecksumHelper.ChecksumToString(System.Byte[])">
- <summary>
- Converts a checksum value (a byte array)
- into a Hex-formatted string.
- </summary>
- <param name="checksum">Checksum value to convert</param>
- <returns>Hexified string value</returns>
- </member>
- <member name="T:NAnt.Contrib.Util.IRecorder">
- <summary>
- Recorder interface user with the Record task
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.IRecorder.Start">
- <summary>
- Starts recording.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.IRecorder.Stop">
- <summary>
- Stops recording.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.IRecorder.Close">
- <summary>
- Closes the recorder.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.IRecorder.Flush">
- <summary>
- Flushes the recorder.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Util.IRecorder.Name">
- <summary>
- Gets the name of this recorder (possibly a file name).
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Util.IRecorder.Logger">
- <summary>
- Gets The underlying <see cref="T:NAnt.Core.IBuildLogger"/> instance.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Util.IRecorder.AutoFlush">
- <summary>
- Defines whether the underlying writer is automatically flushes or
- not.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Util.RecorderCollection">
- <summary>
- Keeps track of used recorders
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Util.FileLogListener"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.Flush">
- <summary>
- Flushes buffered build events or messages to the underlying storage.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a message has been logged.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- Only messages with a priority higher or equal to the threshold of
- the logger will actually be output in the build log.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.Log(System.String)">
- <summary>
- Empty implementation which allows derived classes to receive the
- output that is generated in this logger.
- </summary>
- <param name="message">The message being logged.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.Level,System.String,System.Int32)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the
- logger.
- </summary>
- <param name="messageLevel">The priority of the message to output.</param>
- <param name="message">The message to output.</param>
- <param name="indentationLength">The number of characters that the message should be indented.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.BuildEventArgs)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the
- logger.
- </summary>
- <param name="e">The event to output.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.FileLogListener.OutputMessage(NAnt.Core.BuildEventArgs,System.Int32)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Contrib.Util.FileLogListener.Threshold"/> of the
- logger.
- </summary>
- <param name="e">The event to output.</param>
- <param name="indentationLength">TODO</param>
- </member>
- <member name="P:NAnt.Contrib.Util.FileLogListener.Threshold">
- <summary>
- Gets or sets the highest level of message this logger should respond
- to.
- </summary>
- <value>
- The highest level of message this logger should respond to.
- </value>
- <remarks>
- Only messages with a message level higher than or equal to the given
- level should be written to the log.
- </remarks>
- </member>
- <member name="P:NAnt.Contrib.Util.FileLogListener.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="true" /> if output is to be unadorned so that emacs
- and other editors can parse files names, etc. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Contrib.Util.FileLogListener.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
- to send its output.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Util.FileUtils">
- <summary>
- Groups a set of useful file manipulation methods.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.FileUtils.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Contrib.Util.FileUtils"/> class.
- </summary>
- <remarks>
- Prevents instantiation of the <see cref="T:NAnt.Contrib.Util.FileUtils"/> class.
- </remarks>
- </member>
- <member name="M:NAnt.Contrib.Util.FileUtils.CopyFile(System.String,System.String,System.Text.Encoding,NAnt.Contrib.Types.FilterSetCollection)">
- <summary>
- Copies a file while replacing the tokens identified by the given
- <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.
- </summary>
- <param name="sourceFileName">The file to copy.</param>
- <param name="destinationFileName">The name of the destination file.</param>
- <param name="encoding">The <see cref="T:System.Text.Encoding"/> used when filter-copying the file.</param>
- <param name="filtersets">The collection of filtersets that should be applied to the file.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.FileUtils.MoveFile(System.String,System.String,System.Text.Encoding,NAnt.Contrib.Types.FilterSetCollection)">
- <summary>
- Moves a file while replacing the tokens identified by the given
- <see cref="T:NAnt.Contrib.Types.FilterSetCollection"/>.
- </summary>
- <param name="sourceFileName">The file to move.</param>
- <param name="destinationFileName">The name of the destination file.</param>
- <param name="encoding">The <see cref="T:System.Text.Encoding"/> used when filter-copying the file.</param>
- <param name="filtersets">The collection of filtersets that should be applied to the file.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.FileUtils.GetRelativePath(System.String,System.String)">
- <summary>
- Given an absolute directory and an absolute file name, returns a
- relative file name.
- </summary>
- <param name="basePath">An absolute directory.</param>
- <param name="absolutePath">An absolute file name.</param>
- <returns>
- A relative file name for the given absolute file name.
- </returns>
- </member>
- <member name="M:NAnt.Contrib.Util.IniFile.GetString(System.String,System.String,System.String)">
- <summary>
- Returns a string from your INI file
- </summary>
- <param name="Section"></param>
- <param name="Key"></param>
- <param name="Default"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Util.IniFile.WriteString(System.String,System.String,System.String)">
- <summary>
- ' Writes a string to your INI file
- </summary>
- <param name="Section"></param>
- <param name="Key"></param>
- <param name="String"></param>
- </member>
- <member name="M:NAnt.Contrib.Util.IniFile.Flush">
- <summary>
- ' Stores all the cached changes to your INI file
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Util.SqlHelper">
- <summary>
- Helper class used to execute Sql Statements.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlHelper.#ctor(System.String,System.Boolean)">
- <summary>
- Initializes a new instance.
- </summary>
- <param name="connectionString">OleDB Connection string</param>
- <param name="useTransaction">True if you want to use a transaction</param>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlHelper.Close(System.Boolean)">
- <summary>
- Close the connection and terminate
- </summary>
- <param name="commit">true if the transaction should be commited</param>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlHelper.Execute(System.String,System.Int32)">
- <summary>
- Executes a SQL statement.
- </summary>
- <param name="sql">SQL statement to execute</param>
- <param name="cmdTimeout">Command timeout to use</param>
- <returns>Data reader used to check the result</returns>
- </member>
- <member name="P:NAnt.Contrib.Util.SqlHelper.Connection">
- <summary>
- OleDB Connection object
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Util.SqlStatementAdapter">
- <summary>
- Helper class to adapt SQL statements from some
- input into something OLEDB can consume directly
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.#ctor(NAnt.Contrib.Util.SqlStatementList)">
- <summary>
- Creates a new instance
- </summary>
-
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.AdaptSql(System.String)">
- <summary>
- Adapts a set of Sql statements from a string.
- </summary>
- <param name="sql">A string containing the original sql statements</param>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementAdapter.AdaptSqlFile(System.String,System.Text.Encoding)">
- <summary>
- Adapts a set of Sql statements from a string.
- </summary>
- <param name="file">Path of file containing all sql statements</param>
- <param name="encoding">The encoding of the file containing the SQL statements.</param>
- <returns>The new instance</returns>
- </member>
- <member name="T:NAnt.Contrib.Util.DelimiterStyle">
- <summary>
- Determines how the delimiter is interpreted in a SQL string.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Util.DelimiterStyle.Normal">
- <summary>
- Delimiter can appear anywhere on a line.
- </summary>
- </member>
- <member name="F:NAnt.Contrib.Util.DelimiterStyle.Line">
- <summary>
- Delimiter always appears by itself on a line.
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Util.SqlStatementList">
- <summary>
- Helper class to maintain a list of SQL Statements.
- </summary>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementList.#ctor(System.String,NAnt.Contrib.Util.DelimiterStyle)">
- <summary>
- Initializes a new instance.
- </summary>
- <param name="delimiter">String that separates statements from each other</param>
- <param name="style">Style of the delimiter</param>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementList.ParseSql(System.String)">
- <summary>
- Parses the SQL into the internal list using the specified delimiter
- and delimiter style
- </summary>
- <param name="sql">The SQL string to parse.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementList.ParseSqlFromFile(System.String,System.Text.Encoding)">
- <summary>
- Parses the contents of the file into the
- internal list using the specified delimiter
- and delimiter style
- </summary>
- <param name="file">File name</param>
- <param name="encoding">The encoding of the file containing the SQL statements.</param>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementList.GetEnumerator">
- <summary>
- Allows foreach().
- </summary>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementList.StripComments(System.String)">
- <summary>
- Strips all single line comments
- in the specified sql
- </summary>
- <param name="sql"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Contrib.Util.SqlStatementList.ExpandProps(System.String)">
- <summary>
- Expands project properties in the
- sql string
- </summary>
- <param name="sql"></param>
- <returns></returns>
- </member>
- <member name="P:NAnt.Contrib.Util.SqlStatementList.Count">
- <summary>
- Gets the number of statements in the list.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Util.SqlStatementList.Item(System.Int32)">
- <summary>
- Gets the statement specified by the index.
- </summary>
- </member>
- <member name="P:NAnt.Contrib.Util.SqlStatementList.Properties">
- <summary>
- Project's properties for property expansion
- </summary>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.msi">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIBase">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.summaryinformation">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.properties">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.search">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.tables">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.directories">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.environment">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.components">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.dialogs">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controls">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controlconditions">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.controlevents">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.registry">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.icons">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.shortcuts">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.binaries">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.customactions">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.sequences">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.actiontext">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.appmappings">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.urlproperties">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.vdirproperties">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.approots">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.iisproperties">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.failonerror">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.output">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.sourcedir">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.template">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.errortemplate">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.verbose">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.debug">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBase.deterministicguids">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msi.launchconditions">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msi.features">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msi.mergemodules">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msi.license">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msi.banner">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msi.background">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSILaunchCondition">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.description">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILaunchCondition.condition">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.module">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIConfigurationItem.value">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIMerge">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.modules">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.configurationitems">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIMerge.feature">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSet">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.include">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.exclude">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.includesfile">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.excludesfile">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.includes">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.excludes">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.basedir">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.defaultexcludes">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.failonempty">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSet.refid">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.frompath">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.asIs">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.asIsSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.if">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetPattern.unless">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.if">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.NAntFileSetExcludesfile.unless">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition.expression">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeatureCondition.level">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIFeature">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.description">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.conditions">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.feature">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.attr">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.title">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.display">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.typical">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFeature.directory">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIIISProperty">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.directory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.attr">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIIISProperty.defaultdoc">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIAppRoot">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.component">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.urlproperty">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppRoot.inprocflag">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIVDirProperty">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.portproperty">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIVDirProperty.urlproperty">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIURLProperty">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIURLProperty.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIURLProperty.property">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIAppMapping">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.directory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.extension">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.exepath">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIAppMapping.verbs">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIActionTextAction">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.description">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIActionTextAction.template">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSISequence">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.action">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.value">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequence.condition">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSISequenceTable">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.installexecute">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.installui">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.adminexecute">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.adminui">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSISequenceTable.advtexecute">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSICustomAction">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.action">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.source">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSICustomAction.target">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIBinary">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBinary.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIBinary.value">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIShortcut">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.description">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.directory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.filename">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.component">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.target">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.arguments">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.hotkey">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.icon">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.iconindex">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.iconindexSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.showcmd">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.showcmdSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIShortcut.wkdir">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIIcon">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIIcon.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIIcon.value">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.value">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.dword">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.id">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyValue.Value">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKey">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.value">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.path">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.root">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKey.component">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.dependent">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.machine">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.classes">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.users">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRegistryKeyRoot.user">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIControlEvent">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.dialog">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.control">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.argument">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.condition">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.order">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.orderSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlEvent.remove">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIControlCondition">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.dialog">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.control">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.action">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.condition">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControlCondition.remove">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIControl">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.dialog">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.x">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.y">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.width">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.height">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.attr">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.property">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.text">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.nextcontrol">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.help">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIControl.remove">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIDialog">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.hcenter">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.vcenter">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.width">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.height">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.attr">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.title">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.firstcontrol">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.defaultcontrol">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDialog.cancelcontrol">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIFileOverride">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.file">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.id">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.attr">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.version">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.language">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.checkinterop">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIFileOverride.installtogac">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIKeyFile">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIKeyFile.file">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIComponent">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.key">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.fileset">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.forceid">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.id">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.attr">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.directory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.feature">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.condition">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.fileattr">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.checkinterop">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.installassembliestogac">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIComponent.keepsubdirs">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIVariable">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.append">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIVariable.component">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIDirectory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.directory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIDirectory.foldername">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSIRootDirectory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSIRootDirectory.root">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRowColumnData.value">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSITableRow">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableRow.columns">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSITableColumn">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.nullable">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.category">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.categorySpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.key">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.minvalue">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.minvalueSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.maxvalue">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.maxvalueSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keytable">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keycolumn">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.keycolumnSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.set">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumn.description">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Text">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.UpperCase">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.LowerCase">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Integer">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.DoubleInteger">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.TimeDate">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Identifier">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Property">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Filename">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.WildCardFilename">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Path">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Paths">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.AnyPath">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.DefaultDir">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.RegPath">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Formatted">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Template">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Condition">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.GUID">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Version">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Language">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Binary">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Cabinet">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITableColumnCategoryType.Shortcut">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSITable">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.columns">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.rows">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSITable.name">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.searchKeyValue">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchKeyValue.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchKeyValue.setproperty">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.searchKey">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.value">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.path">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchKey.root">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.registry">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.file">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.directory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileReg64.Item64bit">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.searchDirfileFile">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minversion">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxversion">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minsize">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.minsizeSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxsize">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxsizeSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.mindate">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.mindateSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxdate">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.maxdateSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfileFile.languages">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.searchDirfile">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.file">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.parent">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.path">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.depth">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchDirfile.setproperty">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.searchIni">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.filename">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.section">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.key">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.field">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchIni.setproperty">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.directory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.file">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFileRaw.raw">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.searchRegistryValue">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistryValue.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistryValue.setproperty">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.searchRegistry">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.value">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.path">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchRegistry.root">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.searchApp">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.componentid">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.searchApp.setproperty">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile.directory">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSILocatorTypeDirFile.file">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.search">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.search.app">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.search.registry">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.search.ini">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.search.dirfile">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.search.key">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.property">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.property.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.property.value">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.summaryinformation">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.title">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.subject">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.author">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.keywords">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.comments">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.template">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.revisionnumber">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.summaryinformation.creatingapplication">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.msm">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduledependencies">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleexclusions">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.modulesequences">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleignoretables">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.modulesubstitutions">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.moduleconfigurations">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.id">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.language">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.msm.version">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleDependency">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.id">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.language">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleDependency.version">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.id">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.language">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.minversion">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleExclusion.maxversion">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleSequence">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.action">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.sequence">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.sequenceSpecified">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.baseaction">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.after">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSequence.condition">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleIgnoreTable">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleIgnoreTable.name">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.table">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.row">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.column">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleSubstitution.value">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.name">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.format">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.type">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.contextdata">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.defaultvalue">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.attr">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.displayname">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.description">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.helplocation">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfiguration.helpkeyword">
- <remarks/>
- </member>
- <member name="T:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.text">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.key">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.integer">
- <remarks/>
- </member>
- <member name="F:NAnt.Contrib.Schemas.Msi.MSMModuleConfigurationFormat.bitfield">
- <remarks/>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.Core.dll
Binary file
slips/build/tools/nant/bin/NAnt.Core.xml
@@ -1,15577 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.Core</name>
- </assembly>
- <members>
- <member name="T:NAnt.Core.Attributes.BooleanValidatorAttribute">
- <summary>
- Used to indicate that a property should be able to be converted into a
- <see cref="T:System.Boolean"/>.
- </summary>
- </member>
- <member name="T:NAnt.Core.Attributes.ValidatorAttribute">
- <summary>
- Base class for all validator attributes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.ValidatorAttribute.Validate(System.Object)">
- <summary>
- Validates the specified value.
- </summary>
- <param name="value">The value to be validated.</param>
- <exception cref="T:NAnt.Core.ValidationException">The validation fails.</exception>
- </member>
- <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BooleanValidatorAttribute"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.BooleanValidatorAttribute.Validate(System.Object)">
- <summary>
- Checks if the specified value can be converted to a <see cref="T:System.Boolean"/>.
- </summary>
- <param name="value">The value to be checked.</param>
- <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.Boolean"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.BuildAttributeAttribute">
- <summary>
- Indicates that property should be treated as a XML attribute for the
- task.
- </summary>
- <example>
- Examples of how to specify task attributes
- <code>
- #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
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Attributes.BuildAttributeAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildAttributeAttribute"/> with the
- specified name.
- </summary>
- <param name="name">The name of the attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Name">
- <summary>
- Gets or sets the name of the XML attribute.
- </summary>
- <value>
- The name of the XML attribute.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.Required">
- <summary>
- Gets or sets a value indicating whether the attribute is required.
- </summary>
- <value>
- <see langword="true" /> if the attribute is required; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ExpandProperties">
- <summary>
- Gets or sets a value indicating whether property references should
- be expanded.
- </summary>
- <value>
- <see langword="true" /> if properties should be expanded; otherwise
- <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildAttributeAttribute.ProcessXml">
- <summary>
- Used to specify how this attribute will be handled as the XML is
- parsed and given to the element.
- </summary>
- <value>
- <see langword="true" /> if XML should be processed; otherwise
- <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.BuildElementArrayAttribute">
- <summary>
- Indicates that property should be treated as a XML arrayList
- </summary>
- <remarks>
- <para>
- Should only be applied to properties exposing strongly typed arrays or
- strongly typed collections.
- </para>
- <para>
- The XML format is like this:
- <code>
- <![CDATA[
- <task>
- <elementName ... />
- <elementName ... />
- <elementName ... />
- <elementName ... />
- </task>
- ]]>
- </code>
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Core.Attributes.BuildElementAttribute">
- <summary>
- Indicates that the property should be treated as an XML element and
- further processing should be done.
- </summary>
- <remarks>
- <para>
- The XML format is like this:
- <code>
- <![CDATA[
- <task>
- <elementName ...>
- <morestuff />
- </elementName>
- </task>
- ]]>
- </code>
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.BuildElementAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> with the
- specified name.
- </summary>
- <param name="name">The name of the attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Name">
- <summary>
- Gets or sets the name of the attribute.
- </summary>
- <value>
- The name of the attribute.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementAttribute.Required">
- <summary>
- Gets or sets a value indicating whether the attribute is required.
- </summary>
- <value>
- <see langword="true" /> if the attribute is required; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementAttribute.ProcessXml">
- <summary>
- Used to specify how this element will be handled as the XML is parsed
- and given to the element.
- </summary>
- <value>
- <see langword="true" /> if XML should be processed; otherwise
- <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="M:NAnt.Core.Attributes.BuildElementArrayAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementArrayAttribute"/>
- with the specified name.
- </summary>
- <param name="name">The name of the attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementArrayAttribute.ElementType">
- <summary>
- Gets or sets the type of objects that this container holds.
- </summary>
- <value>
- The type of the elements that this container holds.
- </value>
- <remarks>
- <para>
- This can be used for validation and schema generation.
- </para>
- <para>
- If not specified, the type of the elements will be determined using
- reflection.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.BuildElementCollectionAttribute">
- <summary>
- Indicates that the property should be treated as a container for a
- collection of build elements.
- </summary>
- <remarks>
- <para>
- Should only be applied to properties exposing strongly typed arrays or
- strongly typed collections.
- </para>
- <para>
- The XML format is like this:
- <code>
- <![CDATA[
- <task>
- <collectionName>
- <elementName ... />
- <elementName ... />
- <elementName ... />
- <elementName ... />
- </collectionName>
- </task>
- ]]>
- </code>
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.BuildElementCollectionAttribute.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.BuildElementCollectionAttribute"/> with the
- specified name and child element name.
- </summary>
- <param name="collectionName">The name of the collection.</param>
- <param name="childName">The name of the child elements in the collection</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="childName"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="childName"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.BuildElementCollectionAttribute.ChildElementName">
- <summary>
- The name of the child element within the collection.
- </summary>
- <value>
- The name to check for in the XML of the elements in the collection.
- </value>
- <remarks>
- This can be used for validation and schema generation.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Attributes.DateTimeValidatorAttribute">
- <summary>
- Used to indicate that a property should be able to be converted into a
- <see cref="T:System.DateTime"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.DateTimeValidatorAttribute"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.DateTimeValidatorAttribute.Validate(System.Object)">
- <summary>
- Checks if the specified value can be converted to a <see cref="T:System.DateTime"/>.
- </summary>
- <param name="value">The value to be checked.</param>
- <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> cannot be converted to a <see cref="T:System.DateTime"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.ElementNameAttribute">
- <summary>
- Indicates that class should be treated as a NAnt element.
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.ElementNameAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cre="ElementNameAttribute"/>
- with the specified name.
- </summary>
- <param name="name">The name of the element.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.ElementNameAttribute.Name">
- <summary>
- Gets or sets the name of the element.
- </summary>
- <value>
- The name of the element.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.FileSetAttribute">
- <summary>
- Indicates that a property should be treated as a XML file set for the
- task.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.FileSetAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FileSetAttribute"/> with the
- specified name.
- </summary>
- <param name="name">The name of the attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute">
- <summary>
- 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.
- </summary>
- <example>
- <para>
- The following example shows a property of which the value can be
- configured for a specific framework in the NAnt configuration file.
- </para>
- <code lang="C#">
- [FrameworkConfigurable("exename", Required=true)]
- public virtual string ExeName {
- get { return _exeName; }
- set { _exeName = value; }
- }
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Attributes.FrameworkConfigurableAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FrameworkConfigurableAttribute"/>
- with the specified attribute name.
- </summary>
- <param name="name">The name of the framework configuration attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Name">
- <summary>
- Gets or sets the name of the framework configuration attribute.
- </summary>
- <value>The name of the framework configuration attribute.</value>
- </member>
- <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.Required">
- <summary>
- Gets or sets a value indicating whether the configuration attribute
- is required.
- </summary>
- <value>
- <see langword="true" /> if the configuration attribute is required;
- otherwise, <see langword="true" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.FrameworkConfigurableAttribute.ExpandProperties">
- <summary>
- Gets or sets a value indicating whether property references should
- be expanded.
- </summary>
- <value>
- <see langword="true" /> if properties should be expanded; otherwise
- <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.FunctionAttribute">
- <summary>
- Indicates that the method should be exposed as a function in NAnt build
- files.
- </summary>
- <remarks>
- Attach this attribute to a method of a class that derives from
- <see cref="T:NAnt.Core.FunctionSetBase"/> to have NAnt be able to recognize it.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.FunctionAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionAttribute"/>
- class with the specified name.
- </summary>
- <param name="name">The name of the function.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.FunctionAttribute.Name">
- <summary>
- Gets or sets the name of the function.
- </summary>
- <value>
- The name of the function.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.FunctionSetAttribute">
- <summary>
- Indicates that class should be treated as a set of functions.
- </summary>
- <remarks>
- Attach this attribute to a class that derives from <see cref="T:NAnt.Core.FunctionSetBase"/>
- to have NAnt be able to recognize it as containing custom functions.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.FunctionSetAttribute.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.FunctionSetAttribute"/>
- class with the specified name.
- </summary>
- <param name="prefix">The prefix used to distinguish the functions.</param>
- <param name="category">The category of the functions.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="prefix"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="category"/> is <see langword="null"/>.</para>
- </exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para><paramref name="prefix"/> is a zero-length <see cref="T:System.String"/>.</para>
- <para>-or-</para>
- <para><paramref name="category"/> is a zero-length <see cref="T:System.String"/>.</para>
- </exception>
- </member>
- <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Category">
- <summary>
- Gets or sets the category of the function set.
- </summary>
- <value>
- The name of the category of the function set.
- </value>
- <remarks>
- This will be displayed in the user docs.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Attributes.FunctionSetAttribute.Prefix">
- <summary>
- Gets or sets the prefix of all functions in this function set.
- </summary>
- <value>
- The prefix of the functions in this function set.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.Int32ValidatorAttribute">
- <summary>
- Indicates that property should be able to be converted into a <see cref="T:System.Int32"/>
- within the given range.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.Int32ValidatorAttribute"/>
- class with the specied minimum and maximum values.
- </summary>
- <param name="minValue">The minimum value.</param>
- <param name="maxValue">The maximum value.</param>
- </member>
- <member name="M:NAnt.Core.Attributes.Int32ValidatorAttribute.Validate(System.Object)">
- <summary>
- Checks whether the specified value can be converted to an <see cref="T:System.Int32"/>
- and whether the value lies within the range defined by the <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
- and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/> properties.
- </summary>
- <param name="value">The value to be checked.</param>
- <exception cref="T:NAnt.Core.ValidationException">
- <para>
- <paramref name="value"/> cannot be converted to an <see cref="T:System.Int32"/>.
- </para>
- <para>-or-</para>
- <para>
- <paramref name="value"/> is not in the range defined by <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue"/>
- and <see cref="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue"/>.
- </para>
- </exception>
- </member>
- <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MinValue">
- <summary>
- Gets or sets the minimum value.
- </summary>
- <value>
- The minimum value. The default is <see cref="F:System.Int32.MinValue"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.MaxValue">
- <summary>
- Gets or sets the maximum value.
- </summary>
- <value>
- The maximum value. The default is <see cref="F:System.Int32.MaxValue"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.Int32ValidatorAttribute.Base">
- <summary>
- The base of the number to validate, which must be 2, 8, 10, or 16.
- </summary>
- <value>
- The base of the number to validate.
- </value>
- <remarks>
- The default is 10.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Attributes.LocationType">
- <summary>
- Defines possible locations in which a task executable can be located.
- </summary>
- </member>
- <member name="F:NAnt.Core.Attributes.LocationType.FrameworkDir">
- <summary>
- Locates the task executable in the current Framework directory.
- </summary>
- </member>
- <member name="F:NAnt.Core.Attributes.LocationType.FrameworkSdkDir">
- <summary>
- Locates the task executable in the current Framework SDK directory.
- </summary>
- </member>
- <member name="T:NAnt.Core.Attributes.ProgramLocationAttribute">
- <summary>
- Indicates the location that a task executable can be located in.
- </summary>
- <remarks>
- <para>
- When applied to a task deriving from <see cref="T:NAnt.Core.Tasks.ExternalProgramBase"/>,
- the program to execute will first be searched for in the designated
- location.
- </para>
- <para>
- If the program does not exist in that location, and the file name is
- not an absolute path then the list of tool paths of the current
- target framework will be searched (in the order in which they are
- defined in the NAnt configuration file).
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.ProgramLocationAttribute.#ctor(NAnt.Core.Attributes.LocationType)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/>
- with the specified location.
- </summary>
- <param type="type">The <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the attribute.</param>
- </member>
- <member name="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType">
- <summary>
- Gets or sets the <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/> of the task.
- </summary>
- <value>
- The location type of the task to which the attribute is assigned.
- </value>
- </member>
- <member name="T:NAnt.Core.Attributes.StringValidatorAttribute">
- <summary>
- Used to indicate whether a <see cref="T:System.String"/> property should allow
- an empty string value or not.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Attributes.StringValidatorAttribute.Validate(System.Object)">
- <summary>
- Checks if the specified value adheres to the rules defined by the
- properties of the <see cref="T:NAnt.Core.Attributes.StringValidatorAttribute"/>.
- </summary>
- <param name="value">The value to be checked.</param>
- <exception cref="T:NAnt.Core.ValidationException"><paramref name="value"/> is an empty string value and <see cref="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty"/> is set to <see langword="false"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.AllowEmpty">
- <summary>
- Gets or sets a value indicating whether an empty string or
- <see langword="null" /> should be a considered a valid value.
- </summary>
- <value>
- <see langword="true" /> if an empty string or <see langword="null" />
- should be considered a valid value; otherwise, <see langword="false" />.
- The default is <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.Expression">
- <summary>
- Gets or sets a regular expression. The string will be validated to
- determine if it matches the expression.
- </summary>
- <value>
- <see cref="N:System.Text.RegularExpressions"/>
- </value>
- </member>
- <member name="P:NAnt.Core.Attributes.StringValidatorAttribute.ExpressionErrorMessage">
- <summary>
- An optional error message that can be used to better describe the
- regular expression error.
- </summary>
- </member>
- <member name="T:NAnt.Core.Attributes.TaskAttributeAttribute">
- <summary>
- Indicates that property should be treated as a XML attribute for the
- task.
- </summary>
- <example>
- Examples of how to specify task attributes
- <code>
- // 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();
- </code>
- 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.
- </example>
- </member>
- <member name="M:NAnt.Core.Attributes.TaskAttributeAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskAttributeAttribute"/>
- with the specified attribute name.
- </summary>
- <param name="name">The name of the task attribute.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is a <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Attributes.TaskNameAttribute">
- <summary>
- Indicates that class should be treated as a task.
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Attributes.TaskNameAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Attributes.TaskNameAttribute"/>
- with the specified name.
- </summary>
- <param name="name">The name of the task.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="name"/> is a zero-length <see cref="T:System.String"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Configuration.DirList">
- <summary>
- Represents an explicitly named list of directories.
- </summary>
- <remarks>
- A <see cref="T:NAnt.Core.Configuration.DirList"/> is useful when you want to capture a list of
- directories regardless whether they currently exist.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Element">
- <summary>
- Models a NAnt XML element in the build file.
- </summary>
- <remarks>
- <para>
- Automatically validates attributes in the element based on attributes
- applied to members in derived classes.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.#ctor(NAnt.Core.Element)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Element"/> class
- from the specified element.
- </summary>
- <param name="e">The element that should be used to create a new instance of the <see cref="T:NAnt.Core.Element"/> class.</param>
- </member>
- <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode)">
- <summary>
- Performs default initialization.
- </summary>
- <remarks>
- Derived classes that wish to add custom initialization should override
- the <see cref="M:NAnt.Core.Element.Initialize"/> method.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String)">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to be logged.</param>
- <remarks>
- The actual logging is delegated to the project.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- The actual logging is delegated to the project.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.InitializeElement(System.Xml.XmlNode)">
- <summary>
- Derived classes should override to this method to provide extra
- initialization and validation not covered by the base class.
- </summary>
- <param name="elementNode">The XML node of the element to use for initialization.</param>
- </member>
- <member name="M:NAnt.Core.Element.Initialize">
- <summary>
- Derived classes should override to this method to provide extra
- initialization and validation not covered by the base class.
- </summary>
- <remarks>
- Access to the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize
- this <see cref="T:NAnt.Core.Element"/> is available through <see cref="P:NAnt.Core.Element.XmlNode"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.CopyTo(NAnt.Core.Element)">
- <summary>
- Copies all instance data of the <see cref="T:NAnt.Core.Element"/> to a given
- <see cref="T:NAnt.Core.Element"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.Initialize(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Performs initialization using the given set of properties.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Initializes all build attributes and child elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
- <summary>
- Locates the XML node for the specified attribute in the project
- configuration node.
- </summary>
- <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
- <param name="framework">The framework to use to obtain framework specific information, or <see langword="null" /> if no framework specific information should be used.</param>
- <returns>
- The XML configuration node for the specified attribute, or
- <see langword="null" /> if no corresponding XML node could be
- located.
- </returns>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Element.GetElementNameFromType(System.Type)">
- <summary>
- Returns the <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> of the
- <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned to the specified
- <see cref="T:System.Type"/>.
- </summary>
- <param name="type">The <see cref="T:System.Type"/> of which the assigned <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> should be retrieved.</param>
- <returns>
- The <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/> assigned to the specified
- <see cref="T:System.Type"/> or a null reference is no <see cref="P:NAnt.Core.Attributes.ElementNameAttribute.Name"/>
- is assigned to the <paramref name="type"/>.
- </returns>
- </member>
- <member name="P:NAnt.Core.Element.Parent">
- <summary>
- Gets or sets the parent of the element.
- </summary>
- <value>
- The parent of the element.
- </value>
- <remarks>
- This will be the parent <see cref="T:NAnt.Core.Task"/>, <see cref="T:NAnt.Core.Target"/>, or
- <see cref="P:NAnt.Core.Element.Project"/> depending on where the element is defined.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Element.Name">
- <summary>
- Gets the name of the XML element used to initialize this element.
- </summary>
- <value>
- The name of the XML element used to initialize this element.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.Project">
- <summary>
- Gets or sets the <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.Element.Project"/> to which this element belongs.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.Properties">
- <summary>
- Gets the properties local to this <see cref="T:NAnt.Core.Element"/> and the
- <see cref="P:NAnt.Core.Element.Project"/>.
- </summary>
- <value>
- The properties local to this <see cref="T:NAnt.Core.Element"/> and the <see cref="P:NAnt.Core.Element.Project"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.NamespaceManager">
- <summary>
- Gets or sets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.Element.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Element.XmlNode">
- <summary>
- Gets or sets the XML node of the element.
- </summary>
- <value>
- The XML node of the element.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.Location">
- <summary>
- Gets or sets the location in the build file where the element is
- defined.
- </summary>
- <value>
- The location in the build file where the element is defined.
- </value>
- </member>
- <member name="P:NAnt.Core.Element.CustomXmlProcessing">
- <summary>
- Gets a value indicating whether the element is performing additional
- processing using the <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to
- initialize the element.
- </summary>
- <value>
- <see langword="false"/>.
- </value>
- <remarks>
- <para>
- Elements that need to perform additional processing of the
- <see cref="P:NAnt.Core.Element.XmlNode"/> that was used to initialize the element, should
- override this property and return <see langword="true"/>.
- </para>
- <para>
- When <see langword="true"/>, no build errors will be reported for
- unknown nested build elements.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Core.Element.AttributeConfigurator">
- <summary>
- Configures an <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using meta-data provided by
- assigned attributes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Element.AttributeConfigurator.#ctor(NAnt.Core.Element,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Element.AttributeConfigurator"/>
- class for the given <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
- </summary>
- <param name="element">The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> should be created.</param>
- <param name="elementNode">The <see cref="P:NAnt.Core.Element.XmlNode"/> to initialize the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> with.</param>
- <param name="properties">The <see cref="T:NAnt.Core.PropertyDictionary"/> to use for property expansion.</param>
- <param name="targetFramework">The framework that the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> should target.</param>
- <exception cref="T:System.ArgumentNullException">
- <para><paramref name="element"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="elementNode"/> is <see langword="null"/>.</para>
- <para>-or-</para>
- <para><paramref name="properties"/> is <see langword="null"/>.</para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateChildBuildElement(System.Reflection.PropertyInfo,System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Creates a child <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> using property set/get methods.
- </summary>
- <param name="propInf">The <see cref="T:System.Reflection.PropertyInfo"/> instance that represents the property of the current class.</param>
- <param name="xml">The <see cref="P:NAnt.Core.Element.XmlNode"/> used to initialize the new <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> instance.</param>
- <param name="properties">The collection of property values to use for macro expansion.</param>
- <param name="framework">The <see cref="T:NAnt.Core.FrameworkInfo"/> from which to obtain framework-specific information.</param>
- <returns>The <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> child.</returns>
- </member>
- <member name="M:NAnt.Core.Element.AttributeConfigurator.CreateAttributeSetter(System.Type)">
- <summary>
- Creates an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given
- <see cref="T:System.Type"/>.
- </summary>
- <param name="attributeType">The <see cref="T:System.Type"/> for which an <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> should be created.</param>
- <returns>
- An <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> for the given <see cref="T:System.Type"/>.
- </returns>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._element">
- <summary>
- Holds the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that should be initialized.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._elementXml">
- <summary>
- Holds the <see cref="P:NAnt.Core.Element.XmlNode"/> that should be used to initialize
- the <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/>.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._properties">
- <summary>
- Holds the dictionary that should be used for property
- expansion.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._targetFramework">
- <summary>
- Holds the framework that should be targeted by the
- <see cref="P:NAnt.Core.Element.AttributeConfigurator.Element"/> that we're configuring, or
- <see langword="null"/> if there's no current target
- framework.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedAttributes">
- <summary>
- Holds the names of the attributes that still need to be
- processed.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator._unprocessedChildNodes">
- <summary>
- Holds the names of the child nodes that still need to be
- processed.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator.logger">
- <summary>
- Holds the logger for the current class.
- </summary>
- </member>
- <member name="F:NAnt.Core.Element.AttributeConfigurator.AttributeSetters">
- <summary>
- Holds the cache of <see cref="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter"/> instances.
- </summary>
- </member>
- <member name="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.Element.AttributeConfigurator.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Element.AttributeConfigurator.IAttributeSetter">
- <summary>
- Internal interface used for setting element attributes.
- </summary>
- </member>
- <member name="P:NAnt.Core.Configuration.DirList.Directory">
- <summary>
- The base of the directory of this dirlist. The default is the project
- base directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Configuration.ManagedExecutionMode.Environment">
- <summary>
- Gets the collection of environment variables that should be passed
- to external programs that are launched.
- </summary>
- <value>
- <summary>
- The collection of environment variables that should be passed
- to external programs that are launched.
- </summary>
- </value>
- </member>
- <member name="P:NAnt.Core.Configuration.RuntimeEngine.Arguments">
- <summary>
- The command-line arguments for the runtime engine.
- </summary>
- </member>
- <member name="T:NAnt.Core.Extensibility.ExtensionAssembly">
- <summary>
- Represents an <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> in which one or more extensions
- are found.
- </summary>
- </member>
- <member name="M:NAnt.Core.Extensibility.ExtensionAssembly.#ctor(System.Reflection.Assembly)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>
- class for a given <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/>.
- </summary>
- <param name="assembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> for which to construct an <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.</param>
- </member>
- <member name="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly">
- <summary>
- Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionAssembly.Assembly"/> containing extensions.
- </summary>
- </member>
- <member name="M:NAnt.Core.Extensibility.ExtensionBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly)">
- <summary>
- Initializes a instance of the <see cref="T:NAnt.Core.Extensibility.ExtensionBuilder"/>
- class for an extension in a given <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/>.
- </summary>
- <param name="extensionAssembly">The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension is found.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="extensionAssembly"/> is <see langword="null"/>.</exception>
- </member>
- <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly">
- <summary>
- Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.ExtensionAssembly"/> in which the extension
- was found.
- </summary>
- </member>
- <member name="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly">
- <summary>
- Gets the <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> from which the extension will
- be created.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.Extensibility.ExtensionBuilder.Assembly"/> containing the extension.
- </value>
- </member>
- <member name="M:NAnt.Core.Extensibility.PluginConsumerAttribute.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Extensibility.PluginConsumerAttribute"/>
- with the specified type.
- </summary>
- <param name="type">The type of the <see cref="T:NAnt.Core.Extensibility.IPlugin"/> to consume.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="type"/> is <see langword="null"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Extensibility.PluginScanner">
- <summary>
- Responsible for scanning types for plugins, and maintaining a cache of
- <see cref="T:NAnt.Core.Extensibility.PluginBuilder"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Extensibility.PluginScanner.ScanTypeForPlugins(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for plugins.
- </summary>
- <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- <see cref="T:NAnt.Core.Extensibility.IPlugin"/>; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Extensibility.PluginScanner.RegisterPlugins(NAnt.Core.Extensibility.IPluginConsumer)">
- <summary>
- Registers matching plugins for the specified <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/>.
- </summary>
- <param name="consumer">The <see cref="T:NAnt.Core.Extensibility.IPluginConsumer"/> which plugins must be registered for.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="consumer"/> is <see langword="null"/>.</exception>
- </member>
- <member name="T:NAnt.Core.Filters.ChainableReader">
- <summary>
- Functions as a chainable TextReader
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Chain(NAnt.Core.Filters.ChainableReader)">
- <summary>
- Makes it so all calls to Read and Peek are passed the ChainableReader
- passed as a parameter.
- </summary>
- <param name="parentChainedReader">ChainableReader to forward calls to</param>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Chain(System.IO.TextReader)">
- <summary>
- Makes it so all calls to Read and Peek are passed the TextReader
- passed as a parameter.
- </summary>
- <param name="baseReader">TextReader to forward calls to</param>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Peek">
- <summary>
- Forwards Peek calls to the TextReader or ChainableReader passed in the corresponding constructor.
- </summary>
- <returns>Character or -1 if end of stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Read">
- <summary>
- Forwards Read calls to the TextReader or ChainableReader passed in the corresponding constructor.
- </summary>
- <returns>
- Character or -1 if end of stream.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Close">
- <summary>
- Closes the reader.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ChainableReader.Dispose">
- <summary>
- Calls close and supresses the finalizer for the object.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ChainableReader.Base">
- <summary>
- Gets a value indicating if the reader is backed by a stream in the
- chain.
- </summary>
- <value>
- <see langword="true" /> if the reader is backed by a stream;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.Core.Filters.Filter">
- <summary>
- Allows a file's content to be modified while performing an operation.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.Filter.InitializeFilter">
- <summary>
- Called after construction and after properties are set. Allows
- for filter initialization.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.Filter.IfDefined">
- <summary>
- If <see langword="true" /> then the filter will be used; otherwise,
- skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.Filter.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Filters.Filter.IfDefined"/>. If <see langword="false"/>
- then the filter will be executed; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
- <summary>
- Creates a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> class
- for the specified <see cref="T:NAnt.Core.Filters.Filter"/> class in the specified
- <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
- </summary>
- <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
- <param name="className">The class representing the <see cref="T:NAnt.Core.Filters.Filter"/>.</param>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilder.ClassName">
- <summary>
- Gets the name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created
- using this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
- </summary>
- <value>
- The name of the <see cref="T:NAnt.Core.Filters.Filter"/> class that can be created using
- this <see cref="T:NAnt.Core.Filters.FilterBuilder"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilder.FilterName">
- <summary>
- Gets the name of the filter which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/>
- can create.
- </summary>
- <value>
- The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
- create.
- </value>
- </member>
- <member name="T:NAnt.Core.Filters.FilterBuilderCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
- with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.#ctor(NAnt.Core.Filters.FilterBuilder[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Add(NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilder[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.AddRange(NAnt.Core.Filters.FilterBuilderCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified
- task is in the collection.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for
- the specified task is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.CopyTo(NAnt.Core.Filters.FilterBuilder[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.IndexOf(NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Filters.FilterBuilder"/>. If the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Insert(System.Int32,NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Filters.FilterBuilder"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderCollection.Remove(NAnt.Core.Filters.FilterBuilder)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.FilterBuilder"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilderCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> for the specified task.
- </summary>
- <param name="filterName">The name of the filter for which the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> should be located in the collection.</param>
- </member>
- <member name="T:NAnt.Core.Filters.FilterBuilderEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Filters.FilterBuilder"/> elements of a <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.#ctor(NAnt.Core.Filters.FilterBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterBuilderEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Filters.FilterBuilderCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterBuilderEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.FilterBuilderEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Filters.FilterChain">
- <summary>
- Represent a chain of NAnt filters that can be applied to a <see cref="T:NAnt.Core.Task"/>.
- </summary>
- <remarks>
- <para>
- A FilterChain represents a collection of one or more filters that can
- be appled to a <see cref="T:NAnt.Core.Task"/> such as the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
- In the case of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>, the contents of the copied
- files are filtered through each filter specified in the filter chain.
- Filtering occurs in the order the filters are specified with filtered
- output of one filter feeding into another.
- </para>
- <para>
- :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
- :.Source.:--->:.Filter 1.:--->:.Filter 2.: ... :.Filter n.:--->:.target.:<br/>
- :--------:--->:----------:--->:----------: ... :----------:--->:--------:<br/>
- </para>
- <para>
- A list of all filters that come with NAnt is available <see href="../filters/index.html">here</see>.
- </para>
- <para>
- The following tasks support filtering with a FilterChain:
- </para>
- <list type="bullet">
- <item>
- <description><see cref="T:NAnt.Core.Tasks.CopyTask"/></description>
- </item>
- <item>
- <description><see cref="T:NAnt.Core.Tasks.MoveTask"/></description>
- </item>
- </list>
- </remarks>
- <example>
- <para>
- Replace all occurrences of @NOW@ with the current date/time and
- replace tabs with spaces in all copied files.
- </para>
- <code>
- <![CDATA[
- <property name="NOW" value="${datetime::now()}" />
- <copy todir="out">
- <fileset basedir="in">
- <include name="**/*" />
- </fileset>
- <filterchain>
- <replacetokens>
- <token key="NOW" value="${TODAY}" />
- </replacetokens>
- <tabstospaces />
- </filterchain>
- </copy>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.DataTypeBase">
- <summary>
- Provides the abstract base class for types.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBase.Reset">
- <summary>
- Should be overridden by derived classes. clones the referenced types
- data into the current instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBase.CopyTo(NAnt.Core.DataTypeBase)">
- <summary>
- Copies all instance data of the <see cref="T:NAnt.Core.DataTypeBase"/> to a given
- <see cref="T:NAnt.Core.DataTypeBase"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.DataTypeBase.ID">
- <summary>
- The ID used to be referenced later.
- </summary>
- </member>
- <member name="P:NAnt.Core.DataTypeBase.RefID">
- <summary>
- The ID to use as the reference.
- </summary>
- </member>
- <member name="P:NAnt.Core.DataTypeBase.CanBeReferenced">
- <summary>
- Gets a value indicating whether a reference to the type can be
- defined.
- </summary>
- <remarks>
- Only types with an <see cref="T:NAnt.Core.Attributes.ElementNameAttribute"/> assigned
- to it, can be referenced.
- </remarks>
- </member>
- <member name="P:NAnt.Core.DataTypeBase.Name">
- <summary>
- Gets the name of the datatype.
- </summary>
- <value>
- The name of the datatype.
- </value>
- </member>
- <member name="M:NAnt.Core.Filters.FilterChain.InitializeXml(System.Xml.XmlNode,NAnt.Core.PropertyDictionary,NAnt.Core.FrameworkInfo)">
- <summary>
- Initializes all build attributes and child elements.
- </summary>
- <remarks>
- <see cref="T:NAnt.Core.Filters.FilterChain"/> needs to maintain the order in which the
- filters are specified in the build file.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Filters.FilterChain.GetBaseFilter(NAnt.Core.Filters.PhysicalTextReader)">
- <summary>
- Used to to instantiate and return the chain of stream based filters.
- </summary>
- <param name="physicalTextReader">The <see cref="T:NAnt.Core.Filters.PhysicalTextReader"/> that is the source of input to the filter chain.</param>
- <remarks>
- The <paramref name="physicalTextReader"/> is the first <see cref="T:NAnt.Core.Filters.Filter"/>
- in the chain, which is based on a physical stream that feeds the chain.
- </remarks>
- <returns>
- The last <see cref="T:NAnt.Core.Filters.Filter"/> in the chain.
- </returns>
- </member>
- <member name="P:NAnt.Core.Filters.FilterChain.Filters">
- <summary>
- The filters to apply.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.FilterChain.InputEncoding">
- <summary>
- The encoding to assume when filter-copying files. The default is
- system's current ANSI code page.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.FilterChain.FilterChainConfigurator">
- <summary>
- Configurator that initializes filters in the order in which they've
- been specified in the build file.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.FilterCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Filters.Filter"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.FilterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
- with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.#ctor(NAnt.Core.Filters.Filter[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Filters.Filter"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.Add(NAnt.Core.Filters.Filter)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Filters.Filter"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.Filter[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Filters.Filter"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Filters.Filter"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.AddRange(NAnt.Core.Filters.FilterCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Filters.FilterCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.Contains(NAnt.Core.Filters.Filter)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Filters.Filter"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.CopyTo(NAnt.Core.Filters.Filter[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.IndexOf(NAnt.Core.Filters.Filter)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Filters.Filter"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Filters.Filter"/>. If the <see cref="T:NAnt.Core.Filters.Filter"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.Insert(System.Int32,NAnt.Core.Filters.Filter)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Filters.Filter"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterCollection.Remove(NAnt.Core.Filters.Filter)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Filters.Filter"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Filters.FilterCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.Core.Filters.FilterEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Filters.Filter"/> elements of a <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.FilterEnumerator.#ctor(NAnt.Core.Filters.FilterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Filters.FilterEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Filters.FilterCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Filters.FilterEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.FilterEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.FilterEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Filters.PhysicalTextReader">
- <summary>
- Represents a physical <see cref="T:System.IO.TextReader"/>. That is a reader based
- on a stream.
- </summary>
- <remarks>
- Used by <see cref="T:NAnt.Core.Filters.ChainableReader"/> to represent a <see cref="T:NAnt.Core.Filters.Filter"/>
- based on a <see cref="T:System.IO.TextReader"/> in the chain.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Filters.ExpandProperties">
- <summary>
- Parses NAnt properties and expressions
- </summary>
- <remarks>
- <para>
- This filter parses any NAnt properties or expressions found in its input,
- inlining their values in its output.
- </para>
- <para>
- Note: Due to limitations on buffering, expressions longer than 2048
- characters are not guaranteed to be expanded.
- </para>
- Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
- </remarks>
- <example>
- <para>Replace all properties with their corresponding values.</para>
- <code>
- <![CDATA[
- <expandproperties />
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Core.Filters.ExpandProperties._buffer">
- <summary>
- Holds data for expression expansion between input and output.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.InitializeFilter">
- <summary>
- Called after construction and after properties are set. Allows
- for filter initialization.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.Read">
- <summary>
- Reads the next character applying the filter logic.
- </summary>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.Peek">
- <summary>
- Reads the next character applying the filter logic without advancing the current position in the stream.
- </summary>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.Advance">
- <summary>
- Moves to the next character.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ExpandProperties.ReplenishBuffer">
- <summary>
- Refills the buffer, running our input through
- <see cref="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)"/>.)
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ExpandProperties.AtEnd">
- <summary>
- Determines whether we've passed the end of our data.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.ReplaceString">
- <summary>
- Replaces all occurrences of a given string in the original input with
- user-supplied replacement string.
- </summary>
- <remarks>
- <para>
- This filter replaces all occurrences of a given string in the original
- input stream with a user-supplied replacement string. By default string
- comparisons are case sensitive but this can be changed by setting the
- optional <see cref="P:NAnt.Core.Filters.ReplaceString.IgnoreCase"/> attribute to <see langword="true"/>.
- </para>
- <para>
- To use this filter specify the string to be replaced with the
- <see cref="P:NAnt.Core.Filters.ReplaceString.From"/> attribute and the string to replace it with using the
- <see cref="P:NAnt.Core.Filters.ReplaceString.To"/> attribute.
- </para>
- <para>
- Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
- </para>
- </remarks>
- <example>
- <para>
- Replace all occurrences of "3.14" with "PI".
- </para>
- <code>
- <![CDATA[
- <replacestring from="3.14" to="PI" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Replace all occurrences of "string", "String", etc. with "System.String".
- </para>
- <code>
- <![CDATA[
- <replacestring from="String" to="System.String" ignorecase="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.Chain(NAnt.Core.Filters.ChainableReader)">
- <summary>
- Construct that allows this filter to be chained to the one
- in the parameter chainedReader.
- </summary>
- <param name="chainedReader">Filter that the filter will be chained to</param>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.Read">
- <summary>
- Reads the next character applying the filter logic.
- </summary>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.Peek">
- <summary>
- Reads the next character applying the filter logic without
- advancing the current position in the stream.
-
- Peek currently is not supported.
- </summary>
- <returns>
- Char as an int or -1 if at the end of the stream.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.FindString(System.Int32,System.Boolean@,System.String@)">
- <summary>
- <para>
- 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.
- </para>
-
- <para>
- It is assumed the stream is positioned at the character after the first character
- in the target string.
- </para>
- </summary>
- <param name="startChar">First character in target string</param>
- <param name="streamEnded">Ture if the stream ended while search for the string.</param>
- <param name="nonMatchingChars">Characters that were read while searching for the string.</param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.GetNextCharacter(NAnt.Core.Filters.ReplaceString.AcquireCharDelegate)">
- <summary>
- Returns the next character in the stream replacing the specified character. Using the
- <see cref="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
- </summary>
- <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceString.CompareCharacters(System.Int32,System.Int32)">
- <summary>
- Compares to characters taking into account the _ignoreCase flag.
- </summary>
- <param name="char1"></param>
- <param name="char2"></param>
- <returns></returns>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceString.From">
- <summary>
- The string to be replaced.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceString.To">
- <summary>
- The new value for the replaced string.
- Am empty string is permissible.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceString.IgnoreCase">
- <summary>
- Determines if case will be ignored.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.ReplaceString.AcquireCharDelegate">
- <summary>
- Delegate for Read and Peek. Allows the same implementation
- to be used for both methods.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.ReplaceTokens">
- <summary>
- Replaces tokens in the original input with user-supplied values.
- </summary>
- <remarks>
- <para>
- This filter replaces all token surrounded by a beginning and ending
- token. The default beginning and ending tokens both default to '@'. The
- optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.BeginToken"/> and <see cref="P:NAnt.Core.Filters.ReplaceTokens.EndToken"/> attributes
- can be specified to change either token. By default string
- comparisons are case sensitive but this can be changed by setting the
- optional <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> attribute to <see langword="true"/>.
- </para>
- <para>
- Tokens are specified by using the <see cref="T:NAnt.Core.Types.Token"/> element. It is
- possible to specify from 1 to n tokens and replacement values. Values can
- be any valid NAnt expression.
- </para>
- <para>
- Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
- </para>
- </remarks>
- <example>
- <para>
- Replace all occurrences of the string @DATE@ with the value of property
- "TODAY".
- </para>
- <code>
- <![CDATA[
- <replacetokens>
- <token key="DATE" value="${TODAY}" />
- </replacetokens>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Replace all occurrences of the string <DATE> with the value of
- property "TODAY".
- </para>
- <code>
- <![CDATA[
- <replacetokens begintoken="<" endtoken=">">
- <token key="DATE" value="${TODAY}" />
- </replacetokens>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.Chain(NAnt.Core.Filters.ChainableReader)">
- <summary>
- Construct that allows this filter to be chained to the one
- in the parameter chainedReader.
- </summary>
- <param name="chainedReader">Filter that the filter will be chained to</param>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.Read">
- <summary>
- Reads the next character applying the filter logic.
- </summary>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.Peek">
- <summary>
- Reads the next character applying the filter logic without
- advancing the current position in the stream.
-
- Peek currently is not supported.
- </summary>
- <returns>
- Char as an int or -1 if at the end of the stream.
- </returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.Initialize">
- <summary>
- Initialize the filter by setting its parameters.
- </summary>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.FindTokenContents(System.Boolean@,System.Boolean@,System.Boolean@)">
- <summary>
- 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.
- </summary>
- <param name="tokenNotFound">A token was not found</param>
- <param name="unknownToken">A token was found by there is no replacement</param>
- <param name="streamEnded">The stream ended while looking for the token</param>
- <returns>Either the replacement token or the characters that were read looking for the token</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.GetNextCharacter(NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate)">
- <summary>
- Returns the next character in the stream replacing the specified character. Using the
- <see cref="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
- </summary>
- <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="M:NAnt.Core.Filters.ReplaceTokens.CompareCharacters(System.Int32,System.Int32)">
- <summary>
- Compares to characters taking <see cref="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase"/> into account.
- </summary>
- <param name="char1"></param>
- <param name="char2"></param>
- <returns>
- </returns>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceTokens.BeginToken">
- <summary>
- Marks the beginning of a token. The default is "@".
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceTokens.EndToken">
- <summary>
- Marks the end of a token. The default is "@".
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceTokens.Tokens">
- <summary>
- Tokens and replacement values.
- </summary>
- </member>
- <member name="P:NAnt.Core.Filters.ReplaceTokens.IgnoreCase">
- <summary>
- Determines if case will be ignored.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.ReplaceTokens.AcquireCharDelegate">
- <summary>
- Delegate for Read and Peek. Allows the same implementation
- to be used for both methods.
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.TabsToSpaces">
- <summary>
- Converts tabs to spaces.
- </summary>
- <remarks>
- <para>
- The <see cref="T:NAnt.Core.Filters.TabsToSpaces"/> filter replaces tabs in a text file
- with spaces.
- </para>
- <para>
- Filters are intended to be used as a element of a <see cref="T:NAnt.Core.Filters.FilterChain"/>.
- </para>
- </remarks>
- <example>
- <para>Replace all tabs with four spaces.</para>
- <code>
- <![CDATA[
- <tabtospaces tablength="4" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Filters.TabsToSpaces.Chain(NAnt.Core.Filters.ChainableReader)">
- <summary>
- Construct that allows this filter to be chained to the one
- in the parameter chainedReader.
- </summary>
- <param name="chainedReader">Filter that the filter will be chained to</param>
- </member>
- <member name="M:NAnt.Core.Filters.TabsToSpaces.Peek">
- <summary>
- <para>Retrieves the next character with moving the position in the stream.</para>
- <note>This method is not implemented</note>
- </summary>
- <returns>-1 if end of stream otherwise a character</returns>
- </member>
- <member name="M:NAnt.Core.Filters.TabsToSpaces.Read">
- <summary>
- <para>Retrieves the next character in the stream.</para>
- </summary>
- <returns>-1 if end of stream otherwise a character</returns>
- </member>
- <member name="M:NAnt.Core.Filters.TabsToSpaces.GetNextCharacter(NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate)">
- <summary>
- Returns the next character in the stream replacing the specified character. Using the
- <see cref="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate"/> allows for the same implementation for Read and Peek
- </summary>
- <param name="AcquireChar">Delegate to acquire the next character. (Read/Peek)</param>
- <returns>Char as an int or -1 if at the end of the stream</returns>
- </member>
- <member name="P:NAnt.Core.Filters.TabsToSpaces.TabLength">
- <summary>
- The number of spaces used when converting a tab. The default is
- "8".
- </summary>
- </member>
- <member name="T:NAnt.Core.Filters.TabsToSpaces.AcquireCharDelegate">
- <summary>
- Delegate for Read and Peek. Allows the same implementation
- to be used for both methods.
- </summary>
- </member>
- <member name="T:NAnt.Core.Functions.AssemblyFunctions">
- <summary>
- Functions to return information for a given assembly.
- </summary>
- </member>
- <member name="P:NAnt.Core.FunctionSetBase.Project">
- <summary>
- Gets or sets the <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will
- reference.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.FunctionSetBase.Project"/> that this functionset will reference.
- </value>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.LoadFromFile(System.String)">
- <summary>
- Loads an assembly given its file name or path.
- </summary>
- <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
- <returns>
- The loaded assembly.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> is not found, or the module you are trying to load does not specify a filename extension.</exception>
- <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
- <exception cref="T:System.IO.PathTooLongException">An assembly or module was loaded twice with two different evidences, or the assembly name is longer than MAX_PATH characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.Load(System.String)">
- <summary>
- Loads an assembly given the long form of its name.
- </summary>
- <param name="assemblyString">The long form of the assembly name.</param>
- <returns>
- The loaded assembly.
- </returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="assemblyString"/> is a <see langword="null"/>.</exception>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyString"/> is not found.</exception>
- <example>
- <para>
- Determine the location of the Microsoft Access 11 Primary Interop
- Assembly by loading it using its fully qualified name, and copy it
- to the build directory.
- </para>
- <code>
- <![CDATA[
- <property name="access.pia.path" value="${assembly::get-location(assembly::load('Microsoft.Office.Interop.Access, Version=11.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c'))}" />
- <copy file="${access.pia.path}" todir="${build.dir}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetFullName(System.Reflection.Assembly)">
- <summary>
- Gets the full name of the assembly, also known as the display name.
- </summary>
- <param name="assembly">The assembly to get the full name for.</param>
- <returns>
- The full name of the assembly, also known as the display name.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)">
- <summary>
- Gets an <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
- </summary>
- <param name="assembly">The assembly to get an <see cref="T:System.Reflection.AssemblyName"/> for.</param>
- <returns>
- An <see cref="T:System.Reflection.AssemblyName"/> for the specified assembly.
- </returns>
- <seealso cref="T:NAnt.Core.Functions.AssemblyNameFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyFunctions.GetLocation(System.Reflection.Assembly)">
- <summary>
- Gets the physical location, in codebase format, of the loaded file
- that contains the manifest.
- </summary>
- <param name="assembly">The assembly to get the location for.</param>
- <returns>
- The location of the specified assembly.
- </returns>
- </member>
- <member name="T:NAnt.Core.Functions.AssemblyNameFunctions">
- <summary>
- Functions that return information about an assembly's identity.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetCodeBase(System.Reflection.AssemblyName)">
- <summary>
- Gets the location of the assembly as a URL.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The location of the assembly as a URL.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetEscapedCodeBase(System.Reflection.AssemblyName)">
- <summary>
- Gets the URI, including escape characters, that represents the codebase.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The URI, including escape characters, that represents the codebase.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetFullName(System.Reflection.AssemblyName)">
- <summary>
- Gets the full name of the assembly, also known as the display name.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The full name of the assembly, also known as the display name.
- </returns>
- <example>
- <para>
- Output the full name of the <c>nunit.framework</c> assembly to the
- build log.
- </para>
- <code>
- <![CDATA[
- <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
- ]]>
- </code>
- </example>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetName(System.Reflection.AssemblyName)">
- <summary>
- Gets the simple, unencrypted name of the assembly.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The simple, unencrypted name of the assembly.
- </returns>
- <example>
- <para>
- Output the simple name of the <c>nunit.framework</c> assembly to
- the build log.
- </para>
- <code>
- <![CDATA[
- <echo message="${assemblyname::get-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
- ]]>
- </code>
- </example>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)">
- <summary>
- Gets the version of the assembly.
- </summary>
- <param name="assemblyName">The <see cref="T:System.Reflection.AssemblyName"/> of the assembly.</param>
- <returns>
- The version of the assembly.
- </returns>
- <example>
- <para>
- Output the major version of the <c>nunit.framework</c> assembly
- to the build log.
- </para>
- <code>
- <![CDATA[
- <echo message="${version::get-major-version(assemblyname::get-version(assemblyname::get-assembly-name('nunit.framework.dll')))}" />
- ]]>
- </code>
- </example>
- <seealso cref="M:NAnt.Core.Functions.AssemblyFunctions.GetName(System.Reflection.Assembly)"/>
- <seealso cref="T:NAnt.Core.Functions.VersionFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.AssemblyNameFunctions.GetAssemblyName(System.String)">
- <summary>
- Gets the <see cref="T:System.Reflection.AssemblyName"/> for a given file.
- </summary>
- <param name="assemblyFile">The assembly file for which to get the <see cref="T:System.Reflection.AssemblyName"/>.</param>
- <returns>
- An <see cref="T:System.Reflection.AssemblyName"/> object representing the given file.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> does not exist.</exception>
- <exception cref="T:System.BadImageFormatException"><paramref name="assemblyFile"/> is not a valid assembly.</exception>
- <remarks>
- The assembly is not added to this domain.
- </remarks>
- <example>
- <para>
- Output the full name of the <c>nunit.framework</c> assembly to the
- build log.
- </para>
- <code>
- <![CDATA[
- <echo message="${assemblyname::get-full-name(assemblyname::get-assembly-name('nunit.framework.dll'))}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a logical value to
- its <see cref="T:System.Boolean"/> equivalent.
- </summary>
- <param name="s">A string containing the value to convert.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is equivalent to
- "True"; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> is not equivalent to <see cref="F:System.Boolean.TrueString"/> or <see cref="F:System.Boolean.FalseString"/>.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.BooleanConversionFunctions.ToString(System.Boolean)">
- <summary>
- Converts the specified <see cref="T:System.Boolean"/> to its equivalent string
- representation.
- </summary>
- <param name="value">A <see cref="T:System.Boolean"/> to convert.</param>
- <returns>
- "True" if <paramref name="value"/> is <see langword="true"/>, or
- "False" if <paramref name="value"/> is <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ToInt(System.Int32)">
- <summary>
- Converts the argument to an integer.
- </summary>
- <param name="value">value to be converted</param>
- <returns><paramref name="value" /> converted to integer. The function fails with an exception when the conversion is not possible.</returns>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDouble(System.Double)">
- <summary>
- Converts the argument to double
- </summary>
- <param name="value">The value to be converted.</param>
- <returns><paramref name="value" /> converted to double. The function fails with an exception when the conversion is not possible.</returns>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ConvertToString(System.String)">
- <summary>
- Converts the argument to a string.
- </summary>
- <param name="value">The value to be converted.</param>
- <returns>
- <paramref name="value" /> converted to string. The function fails
- with an exception when the conversion is not possible.
- </returns>
- <remarks>
- Named method ConvertToString as a static ToString method would break
- CLS compliance.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ToDateTime(System.DateTime)">
- <summary>
- Converts the argument to a datetime.
- </summary>
- <param name="value">value to be converted</param>
- <returns><paramref name="value" /> converted to datetime. The function fails with an exception when the conversion is not possible.</returns>
- </member>
- <member name="M:NAnt.Core.Functions.ConversionFunctions.ToBoolean(System.Boolean)">
- <summary>
- Converts the argument to a boolean
- </summary>
- <param name="value">The string value to be converted to boolean. Must be 'true' or 'false'.</param>
- <returns>
- <paramref name="value" /> converted to boolean. The function fails
- with an exception when the conversion is not possible.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.Now">
- <summary>
- Gets a <see cref="T:System.DateTime"/> that is the current local date and
- time on this computer.
- </summary>
- <returns>
- A <see cref="T:System.DateTime"/> whose value is the current date and time.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetYear(System.DateTime)">
- <summary>
- Gets the year component of the specified date.
- </summary>
- <param name="date">The date of which to get the year component.</param>
- <returns>
- The year, between 1 and 9999.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMonth(System.DateTime)">
- <summary>
- Gets the month component of the specified date.
- </summary>
- <param name="date">The date of which to get the month component.</param>
- <returns>
- The month, between 1 and 12.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDay(System.DateTime)">
- <summary>
- Gets the day of the month represented by the specified date.
- </summary>
- <param name="date">The date of which to get the day of the month.</param>
- <returns>
- The day value, between 1 and 31.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetHour(System.DateTime)">
- <summary>
- Gets the hour component of the specified date.
- </summary>
- <param name="date">The date of which to get the hour component.</param>
- <returns>
- The hour, between 0 and 23.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMinute(System.DateTime)">
- <summary>
- Gets the minute component of the specified date.
- </summary>
- <param name="date">The date of which to get the minute component.</param>
- <returns>
- The minute, between 0 and 59.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetSecond(System.DateTime)">
- <summary>
- Gets the seconds component of the specified date.
- </summary>
- <param name="date">The date of which to get the seconds component.</param>
- <returns>
- The seconds, between 0 and 59.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetMillisecond(System.DateTime)">
- <summary>
- Gets the milliseconds component of the specified date.
- </summary>
- <param name="date">The date of which to get the milliseconds component.</param>
- <returns>
- The millisecond, between 0 and 999.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetTicks(System.DateTime)">
- <summary>
- Gets the number of ticks that represent the specified date.
- </summary>
- <param name="date">The date of which to get the number of ticks.</param>
- <returns>
- The number of ticks that represent the date and time of the
- specified date.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfWeek(System.DateTime)">
- <summary>
- Gets the day of the week represented by the specified date.
- </summary>
- <param name="date">The date of which to get the day of the week.</param>
- <returns>
- The day of the week, ranging from zero, indicating Sunday, to six,
- indicating Saturday.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDayOfYear(System.DateTime)">
- <summary>
- Gets the day of the year represented by the specified date.
- </summary>
- <param name="date">The date of which to get the day of the year.</param>
- <returns>
- The day of the year, between 1 and 366.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.GetDaysInMonth(System.Int32,System.Int32)">
- <summary>
- Returns the number of days in the specified month of the specified
- year.
- </summary>
- <param name="year">The year.</param>
- <param name="month">The month (a number ranging from 1 to 12).</param>
- <returns>
- The number of days in <paramref name="month"/> for the specified
- <paramref name="year"/>.
- </returns>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="month"/> is less than 1 or greater than 12.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeFunctions.IsLeapYear(System.Int32)">
- <summary>
- Returns an indication whether the specified year is a leap year.
- </summary>
- <param name="year">A 4-digit year.</param>
- <returns>
- <see langword="true" /> if <paramref name="year" /> is a leap year;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a date and time to
- its <see cref="T:System.DateTime"/> equivalent.
- </summary>
- <param name="s">A string containing a date and time to convert.</param>
- <returns>
- A <see cref="T:System.DateTime"/> equivalent to the date and time contained
- in <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> does not contain a valid string representation of a date and time.</exception>
- <remarks>
- The <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture is
- used to supply formatting information about <paramref name="s"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.DateTimeConversionFunctions.ToString(System.DateTime)">
- <summary>
- Converts the specified <see cref="T:System.DateTime"/> to its equivalent
- string representation.
- </summary>
- <param name="value">A <see cref="T:System.DateTime"/> to convert.</param>
- <returns>
- A string representation of <paramref name="value"/> formatted using
- the general format specifier ("G").
- </returns>
- <remarks>
- <paramref name="value"/> is formatted with the
- <see cref="T:System.Globalization.DateTimeFormatInfo"/> for the invariant culture.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Functions.DirectoryFunctions">
- <summary>
- Groups a set of functions for dealing with directories.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCreationTime(System.String)">
- <summary>
- Returns the creation date and time of the specified directory.
- </summary>
- <param name="path">The directory for which to obtain creation date and time information.</param>
- <returns>
- The creation date and time of the specified directory.
- </returns>
- <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastWriteTime(System.String)">
- <summary>
- Returns the date and time the specified directory was last written to.
- </summary>
- <param name="path">The directory for which to obtain write date and time information.</param>
- <returns>
- The date and time the specified directory was last written to.
- </returns>
- <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetLastAccessTime(System.String)">
- <summary>
- Returns the date and time the specified directory was last accessed.
- </summary>
- <param name="path">The directory for which to obtain access date and time information.</param>
- <returns>
- The date and time the specified directory was last accessed.
- </returns>
- <exception cref="T:System.IO.IOException">The specified directory does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetCurrentDirectory">
- <summary>
- Gets the current working directory.
- </summary>
- <returns>
- A <see cref="T:System.String"/> containing the path of the current working
- directory.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetParentDirectory(System.String)">
- <summary>
- Retrieves the parent directory of the specified path.
- </summary>
- <param name="path">The path for which to retrieve the parent directory.</param>
- <returns>
- The parent directory, or an empty <see cref="T:System.String"/> if
- <paramref name="path"/> is the root directory, including the root
- of a UNC server or share name.
- </returns>
- <exception cref="T:System.IO.IOException">The directory specified by <paramref name="path"/> is read-only.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- <exception cref="T:System.IO.DirectoryNotFoundException">The specified path was not found.</exception>
- <example>
- <para>
- Copy "readme.txt" from the current working directory to
- its parent directory.
- </para>
- <code>
- <![CDATA[
- <property name="current.dir" value="${directory::get-current-directory()}" />
- <property name="current.dir.parent" value="${directory::get-parent-directory(current.dir)}" />
- <copy file="${path::combine(current.dir, 'readme.txt')} todir="${current.dir.parent}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.GetDirectoryRoot(System.String)">
- <summary>
- Returns the volume information, root information, or both for the
- specified path.
- </summary>
- <param name="path">The path for which to retrieve the parent directory.</param>
- <returns>
- A string containing the volume information, root information, or
- both for the specified path.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)">
- <summary>
- Determines whether the given path refers to an existing directory
- on disk.
- </summary>
- <param name="path">The path to test.</param>
- <returns>
- <see langword="true" /> if <paramref name="path" /> refers to an
- existing directory; otherwise, <see langword="false" />.
- </returns>
- <example>
- <para>Remove directory "test", if it exists.</para>
- <code>
- <![CDATA[
- <delete dir="test" if="${directory::exists('test')}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Functions.DnsFunctions">
- <summary>
- Functions for requesting information from DNS.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.DnsFunctions.GetHostName">
- <summary>
- Gets the host name of the local computer.
- </summary>
- <returns>
- A string that contains the DNS host name of the local computer.
- </returns>
- <exception cref="T:System.Net.Sockets.SocketException">An error is encountered when resolving the local host name.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a number to its
- double-precision floating point number equivalent.
- </summary>
- <param name="s">A string containing a number to convert.</param>
- <returns>
- A double-precision floating point number equivalent to the numeric
- value or symbol specified in <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> is not a number in a valid format.</exception>
- <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Double.MinValue"/> or greater than <see cref="F:System.Double.MaxValue"/>.</exception>
- <remarks>
- The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
- used to supply formatting information about <paramref name="s"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.DoubleConversionFunctions.ToString(System.Double)">
- <summary>
- Converts the specified <see cref="T:System.Double"/> to its equivalent
- string representation.
- </summary>
- <param name="value">A <see cref="T:System.Double"/> to convert.</param>
- <returns>
- The string representation of <paramref name="value"/> formatted
- using the general format specifier ("G").
- </returns>
- <remarks>
- <paramref name="value"/> is formatted with the
- <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Functions.EnvironmentFunctions">
- <summary>
- Provide information about the current environment and platform.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)">
- <summary>
- Gets the path to the system special folder identified by the
- specified enumeration.
- </summary>
- <param name="folder">An enumerated constant that identifies a system special folder.</param>
- <returns>
- The path to the specified system special folder, if that folder
- physically exists on your computer; otherwise, the empty string ("").
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="folder"/> is not a member of <see cref="T:System.Environment.SpecialFolder"/>.</exception>
- <example>
- <para>
- Copy "out.log" from the project base directory to the
- program files directory.
- </para>
- <code>
- <![CDATA[
- <copy file="out.log" todir="${environment::get-folder-path('ProgramFiles')}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetMachineName">
- <summary>
- Gets the NetBIOS name of this local computer.
- </summary>
- <returns>
- The NetBIOS name of this local computer.
- </returns>
- <exception cref="T:System.InvalidOperationException">The name of this computer cannot be obtained.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem">
- <summary>
- Gets an <see cref="T:System.OperatingSystem"/> object that represents the
- current operating system.
- </summary>
- <returns>
- An <see cref="T:System.OperatingSystem"/> object that contains the current
- platform identifier and version number.
- </returns>
- <example>
- <para>
- Output string representation of the current operating system.
- </para>
- <code>
- <![CDATA[
- <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
- ]]>
- </code>
- <para>If the operating system is Windows 2000, the output is:</para>
- <code>
- Microsoft Windows NT 5.0.2195.0
- </code>
- </example>
- <seealso cref="T:NAnt.Core.Functions.OperatingSystemFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetUserName">
- <summary>
- Gets the user name of the person who started the current thread.
- </summary>
- <returns>
- The name of the person logged on to the system who started the
- current thread.
- </returns>
- <example>
- <para>
- Modify the home directory of the current user on unix-based systems.
- </para>
- <code>
- <![CDATA[
- <exec program="usermod">
- <arg value="-d" />
- <arg value="/home/temp" />
- <arg value="${environment::get-user-name()}" />
- </exec>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)">
- <summary>
- Returns the value of the specified environment variable.
- </summary>
- <param name="name">The environment variable of which the value should be returned.</param>
- <returns>
- The value of the specified environment variable.
- </returns>
- <exception cref="T:System.ArgumentException">Environment variable <paramref name="name"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.VariableExists(System.String)">
- <summary>
- Gets a value indicating whether the specified environment variable
- exists.
- </summary>
- <param name="name">The environment variable that should be checked.</param>
- <returns>
- <see langword="true" /> if the environment variable exists; otherwise,
- <see langword="false" />.
- </returns>
- <example>
- <para>
- Execute a set of tasks only if the "BUILD_DEBUG" environment
- variable is set.
- </para>
- <code>
- <![CDATA[
- <if test="${environment::variable-exists('BUILD_DEBUG')}">
- ...
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion">
- <summary>
- Gets a <see cref="T:System.Version"/> object that describes the major,
- minor, build, and revision numbers of the Common Language Runtime.
- </summary>
- <returns>
- A Version object.
- </returns>
- <example>
- <para>Output the major version of the CLR.</para>
- <code>
- <![CDATA[
- <echo message="Major version=${version::get-major(environment::get-version())}" />
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Functions.FileFunctions">
- <summary>
- Groups a set of functions for dealing with files.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.GetCreationTime(System.String)">
- <summary>
- Returns the creation date and time of the specified file.
- </summary>
- <param name="path">The file for which to obtain creation date and time information.</param>
- <returns>
- The creation date and time of the specified file.
- </returns>
- <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.GetLastWriteTime(System.String)">
- <summary>
- Returns the date and time the specified file was last written to.
- </summary>
- <param name="path">The file for which to obtain write date and time information.</param>
- <returns>
- The date and time the specified file was last written to.
- </returns>
- <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.GetLastAccessTime(System.String)">
- <summary>
- Returns the date and time the specified file was last accessed.
- </summary>
- <param name="path">The file for which to obtain access date and time information.</param>
- <returns>
- The date and time the specified file was last accessed.
- </returns>
- <exception cref="T:System.IO.IOException">The specified file does not exist.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- <exception cref="T:System.NotSupportedException">The <paramref name="path"/> parameter is in an invalid format.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)">
- <summary>
- Determines whether the specified file exists.
- </summary>
- <param name="file">The file to check.</param>
- <returns>
- <see langword="true" /> if <paramref name="file" /> refers to an
- existing file; otherwise, <see langword="false" />.
- </returns>
- <example>
- <para>Execute a set of tasks, if file "output.xml" does not exist.</para>
- <code>
- <![CDATA[
- <if test="${not file::exists('output.xml')}">
- ...
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.UpToDate(System.String,System.String)">
- <summary>
- Determines whether <paramref name="targetFile"/> is more or equal
- up-to-date than <paramref name="srcFile"/>.
- </summary>
- <param name="srcFile">The file to check against the target file.</param>
- <param name="targetFile">The file for which we want to determine the status.</param>
- <returns>
- <see langword="true"/> if <paramref name="targetFile"/> is more
- or equal up-to-date than <paramref name="srcFile"/>; otherwise,
- <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="srcFile"/> or <paramref name="targetFile"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both of either <paramref name="srcFile"/> or <paramref name="targetFile"/> exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.GetLength(System.String)">
- <summary>
- Gets the length of the file.
- </summary>
- <param name="file">filename</param>
- <returns>
- Length in bytes, of the file named <paramref name="file"/>.
- </returns>
- <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileFunctions.IsAssembly(System.String)">
- <summary>
- Checks if a given file is an assembly.
- </summary>
- <param name="assemblyFile">The name or path of the file to be checked.</param>
- <returns>True if the file is a valid assembly, false if it's not or if the assembly seems corrupted (invalid headers or metadata).</returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="assemblyFile"/> is a null <see cref="T:System.String"/>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="assemblyFile"/> is an empty <see cref="T:System.String"/>.</exception>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="assemblyFile"/> is not found, or the file you are trying to check does not specify a filename extension.</exception>
- <exception cref="T:System.Security.SecurityException">The caller does not have path discovery permission.</exception>
- </member>
- <member name="T:NAnt.Core.Functions.FileVersionInfoFunctions">
- <summary>
- Functions that provide version information for a physical file on disk.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetVersionInfo(System.String)">
- <summary>
- Returns a <see cref="T:System.Diagnostics.FileVersionInfo"/> representing the version
- information associated with the specified file.
- </summary>
- <param name="fileName">The file to retrieve the version information for.</param>
- <returns>
- A <see cref="T:System.Diagnostics.FileVersionInfo"/> containing information about the file.
- </returns>
- <exception cref="T:System.IO.FileNotFoundException">The file specified cannot be found.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetCompanyName(System.Diagnostics.FileVersionInfo)">
- <summary>
- Gets the name of the company that produced the file.
- </summary>
- <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
- <returns>
- The name of the company that produced the file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetFileVersion(System.Diagnostics.FileVersionInfo)">
- <summary>
- Gets the file version of a file.
- </summary>
- <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
- <returns>
- The file version of a file.
- </returns>
- <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductName(System.Diagnostics.FileVersionInfo)">
- <summary>
- Gets the name of the product the file is distributed with.
- </summary>
- <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
- <returns>
- The name of the product the file is distributed with.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FileVersionInfoFunctions.GetProductVersion(System.Diagnostics.FileVersionInfo)">
- <summary>
- Gets the product version of a file.
- </summary>
- <param name="fileVersionInfo">A <see cref="T:System.Diagnostics.FileVersionInfo"/> instance containing version information about a file.</param>
- <returns>
- The product version of a file.
- </returns>
- <see cref="T:NAnt.Core.Functions.VersionFunctions"/>
- </member>
- <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a number to its
- 32-bit signed integer equivalent.
- </summary>
- <param name="s">A string containing a number to convert.</param>
- <returns>
- A 32-bit signed integer equivalent to the number contained in
- <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
- <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Int32.MinValue"/> or greater than <see cref="F:System.Int32.MaxValue"/>.</exception>
- <remarks>
- The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
- used to supply formatting information about <paramref name="s"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.Int32ConversionFunctions.ToString(System.Int32)">
- <summary>
- Converts the specified <see cref="T:System.Int32"/> to its equivalent string
- representation.
- </summary>
- <param name="value">A <see cref="T:System.Int32"/> to convert.</param>
- <returns>
- The string representation of <paramref name="value"/>, consisting
- of a negative sign if the value is negative, and a sequence of
- digits ranging from 0 to 9 with no leading zeroes.
- </returns>
- <remarks>
- <paramref name="value"/> is formatted with the
- <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a number to its
- 64-bit signed integer equivalent.
- </summary>
- <param name="s">A string containing a number to convert.</param>
- <returns>
- A 64-bit signed integer equivalent to the number contained in
- <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> is not of the correct format.</exception>
- <exception cref="T:System.OverflowException"><paramref name="s"/> represents a number less than <see cref="F:System.Int64.MinValue"/> or greater than <see cref="F:System.Int64.MaxValue"/>.</exception>
- <remarks>
- The <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture is
- used to supply formatting information about <paramref name="s"/>.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.Int64ConversionFunctions.ToString(System.Int64)">
- <summary>
- Converts the specified <see cref="T:System.Int64"/> to its equivalent string
- representation.
- </summary>
- <param name="value">A <see cref="T:System.Int64"/> to convert.</param>
- <returns>
- The string representation of <paramref name="value"/>, consisting
- of a negative sign if the value is negative, and a sequence of
- digits ranging from 0 to 9 with no leading zeroes.
- </returns>
- <remarks>
- <paramref name="value"/> is formatted with the
- <see cref="T:System.Globalization.NumberFormatInfo"/> for the invariant culture.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Functions.MathFunctions.Round(System.Double)">
- <summary>
- Rounds the value to the nearest whole number
- </summary>
- <param name="value">Number to be rounded, can be anything convertible to a double.</param>
- <returns>
- Rounded value.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.MathFunctions.Floor(System.Double)">
- <summary>
- Returns the largest whole number less than or equal to the specified
- number.
- </summary>
- <param name="value">value to be , can be anything convertible to a double</param>
- <returns>
- The largest whole number less than or equal to the specified number.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.MathFunctions.Ceiling(System.Double)">
- <summary>
- Returns the smallest whole number greater than or equal to the specified number
- </summary>
- <param name="value">value</param>
- <returns>
- The smallest whole number greater than or equal to the specified number.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.MathFunctions.Abs(System.Double)">
- <summary>
- Returns the absolute value of the specified number
- </summary>
- <param name="value">value to take the absolute value from</param>
- <returns>
- <paramref name="value" /> when <paramref name="value" /> is greater
- than or equal to zero; otherwise, -<paramref name="value" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.NAntFunctions.GetBaseDirectory">
- <summary>
- Gets the base directory of the appdomain in which NAnt is running.
- </summary>
- <returns>
- The base directory of the appdomain in which NAnt is running.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.NAntFunctions.GetAssembly">
- <summary>
- Gets the NAnt assembly.
- </summary>
- <returns>
- The NAnt assembly.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetName">
- <summary>
- Gets the name of the current project.
- </summary>
- <returns>
- The name of the current project, or an empty <see cref="T:System.String"/>
- if no name is specified in the build file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFileUri">
- <summary>
- Gets the <see cref="T:System.Uri"/> form of the build file.
- </summary>
- <returns>
- The <see cref="T:System.Uri"/> form of the build file, or
- an empty <see cref="T:System.String"/> if the project is not file backed.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBuildFilePath">
- <summary>
- Gets the local path to the build file.
- </summary>
- <returns>
- The local path of the build file, or an empty <see cref="T:System.String"/>
- if the project is not file backed.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetDefaultTarget">
- <summary>
- Gets the name of the target that will be executed when no other
- build targets are specified.
- </summary>
- <returns>
- The name of the target that will be executed when no other build
- targets are specified, or an empty <see cref="T:System.String"/> if no
- default target is defined for the project.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.ProjectFunctions.GetBaseDirectory">
- <summary>
- Gets the base directory of the current project.
- </summary>
- <returns>
- The base directory of the current project.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)">
- <summary>
- Checks whether the specified target exists.
- </summary>
- <param name="name">The target to test.</param>
- <returns>
- <see langword="true" /> if the specified target exists; otherwise,
- <see langword="false" />.
- </returns>
- <example>
- <para>
- Execute target "clean", if it exists.
- </para>
- <code>
- <![CDATA[
- <if test="${target::exists('clean')}">
- <call target="clean" />
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.TargetFunctions.GetCurrentTarget">
- <summary>
- Gets the name of the target being executed.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that contains the name of the target
- being executed.
- </returns>
- <exception cref="T:System.InvalidOperationException">No target is being executed.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.TargetFunctions.HasExecuted(System.String)">
- <summary>
- Checks whether the specified target has already been executed.
- </summary>
- <param name="name">The target to test.</param>
- <returns>
- <see langword="true"/> if the specified target has already been
- executed; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException">Target <paramref name="name"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.TaskFunctions.Exists(System.String)">
- <summary>
- Checks whether the specified task exists.
- </summary>
- <param name="name">The task to test.</param>
- <returns>
- <see langword="true" /> if the specified task exists; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TaskFunctions.GetAssembly(System.String)">
- <summary>
- Returns the <see cref="T:System.Reflection.Assembly"/> from which the specified task
- was loaded.
- </summary>
- <param name="name">The name of the task to get the <see cref="T:System.Reflection.Assembly"/> of.</param>
- <returns>
- The <see cref="T:System.Reflection.Assembly"/> from which the specified task was loaded.
- </returns>
- <exception cref="T:System.ArgumentException">Task <paramref name="name"/> is not available.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)">
- <summary>
- Checks whether the specified property exists.
- </summary>
- <param name="name">The property to test.</param>
- <returns>
- <see langword="true" /> if the specified property exists; otherwise,
- <see langword="false" />.
- </returns>
- <example>
- <para>
- Execute a set of tasks if the "build.debug" property
- exists.
- </para>
- <code>
- <![CDATA[
- <if test="${property::exists('build.debug')}">
- <echo message="Starting debug build" />
- <call target="init-debug" />
- <call target="build" />
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.PropertyFunctions.IsReadOnly(System.String)">
- <summary>
- Checks whether the specified property is read-only.
- </summary>
- <param name="name">The property to test.</param>
- <returns>
- <see langword="true"/> if the specified property is read-only;
- otherwise, <see langword="false"/>.
- </returns>
- <example>
- <para>Check whether the "debug" property is read-only.</para>
- <code>property::is-readonly('debug')</code>
- </example>
- <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PropertyFunctions.IsDynamic(System.String)">
- <summary>
- Checks whether the specified property is a dynamic property.
- </summary>
- <param name="name">The property to test.</param>
- <returns>
- <see langword="true"/> if the specified property is a dynamic
- property; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException">Property <paramref name="name"/> has not been set.</exception>
- <example>
- <para>
- Check whether the "debug" property is a dynamic property.
- </para>
- <code>property::is-dynamic('debug')</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)">
- <summary>
- Checks whether the specified framework exists, and is valid.
- </summary>
- <param name="framework">The framework to test.</param>
- <returns>
- <see langword="true" /> if the specified framework exists ; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)">
- <summary>
- Checks whether the SDK for the specified framework is installed.
- </summary>
- <param name="framework">The framework to test.</param>
- <returns>
- <see langword="true"/> if the SDK for specified framework is installed;
- otherwise, <see langword="false"/>.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework">
- <summary>
- Gets the identifier of the current target framework.
- </summary>
- <returns>
- The identifier of the current target framework.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework">
- <summary>
- Gets the identifier of the runtime framework.
- </summary>
- <returns>
- The identifier of the runtime framework.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFamily(System.String)">
- <summary>
- Gets the family of the specified framework.
- </summary>
- <param name="framework">The framework of which the family should be returned.</param>
- <returns>
- The family of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetVersion(System.String)">
- <summary>
- Gets the version of the specified framework.
- </summary>
- <param name="framework">The framework of which the version should be returned.</param>
- <returns>
- The version of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetDescription(System.String)">
- <summary>
- Gets the description of the specified framework.
- </summary>
- <param name="framework">The framework of which the description should be returned.</param>
- <returns>
- The description of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetClrVersion(System.String)">
- <summary>
- Gets the Common Language Runtime version of the specified framework.
- </summary>
- <param name="framework">The framework of which the Common Language Runtime version should be returned.</param>
- <returns>
- The Common Language Runtime version of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFrameworkDirectory(System.String)">
- <summary>
- Gets the framework directory of the specified framework.
- </summary>
- <param name="framework">The framework of which the framework directory should be returned.</param>
- <returns>
- The framework directory of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetAssemblyDirectory(System.String)">
- <summary>
- Gets the assembly directory of the specified framework.
- </summary>
- <param name="framework">The framework of which the assembly directory should be returned.</param>
- <returns>
- The assembly directory of the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetSdkDirectory(System.String)">
- <summary>
- Gets the SDK directory of the specified framework.
- </summary>
- <param name="framework">The framework of which the SDK directory should be returned.</param>
- <returns>
- The SDK directory of the specified framework, or an empty
- <see cref="T:System.String"/> if the SDK of the specified framework is not
- installed.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetToolPath(System.String)">
- <summary>
- Gets the absolute path of the specified tool for the current
- target framework.
- </summary>
- <param name="tool">The file name of the tool to search for.</param>
- <returns>
- The absolute path to <paramref name="tool"/> if found in one of the
- configured tool paths; otherwise, an error is reported.
- </returns>
- <exception cref="T:System.IO.FileNotFoundException"><paramref name="tool"/> could not be found in the configured tool paths.</exception>
- <remarks>
- <para>
- The configured tool paths are scanned in the order in which they
- are defined in the framework configuration.
- </para>
- <para>
- The file name of the tool to search should include the extension.
- </para>
- </remarks>
- <example>
- <para>Use <b>gacutil</b> to install an assembly in the GAC.</para>
- <code>
- <![CDATA[
- <exec program="${framework::get-tool-path('gacutil.exe')}" managed="strict">
- <arg value="/i" />
- <arg file="Cegeka.HealthFramework.dll" />
- </exec>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeEngine(System.String)">
- <summary>
- Gets the runtime engine of the specified framework.
- </summary>
- <param name="framework">The framework of which the runtime engine should be returned.</param>
- <returns>
- The full path to the runtime engine of the specified framework, or
- an empty <see cref="T:System.String"/> if no runtime engine is defined
- for the specified framework.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetRuntimeFramework"/>
- <seealso cref="M:NAnt.Core.Functions.FrameworkFunctions.GetTargetFramework"/>
- </member>
- <member name="M:NAnt.Core.Functions.FrameworkFunctions.GetFramework(System.String)">
- <summary>
- Checks whether the specified framework is valid.
- </summary>
- <param name="framework">The framework to check.</param>
- <exception cref="T:System.ArgumentException"><paramref name="framework"/> is not a valid framework identifier.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PlatformFunctions.GetName">
- <summary>
- Gets the name of the platform on which NAnt is running.
- </summary>
- <returns>
- The name of the platform on which NAnt is running.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PlatformFunctions.IsWin32">
- <summary>
- Checks whether NAnt is running on the win32 platform.
- </summary>
- <returns>
- <see langword="true" /> if NAnt is running on the win32 platform;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PlatformFunctions.IsUnix">
- <summary>
- Checks whether NAnt is running on unix.
- </summary>
- <returns>
- <see langword="true" /> if NAnt is running on unix;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="T:NAnt.Core.Functions.OperatingSystemFunctions">
- <summary>
- Functions that return information about an operating system.
- </summary>
- </member>
- <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetPlatform(System.OperatingSystem)">
- <summary>
- Gets a <see cref="T:System.PlatformID"/> value that identifies the operating
- system platform.
- </summary>
- <param name="operatingSystem">The operating system.</param>
- <returns>
- <see cref="T:System.PlatformID"/> value that identifies the operating system
- platform.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
- </member>
- <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)">
- <summary>
- Gets a <see cref="T:System.Version"/> object that identifies this operating
- system.
- </summary>
- <param name="operatingSystem">The operating system.</param>
- <returns>
- A <see cref="T:System.Version"/> object that describes the major version,
- minor version, build, and revision of the operating system.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
- </member>
- <member name="M:NAnt.Core.Functions.OperatingSystemFunctions.ToString(System.OperatingSystem)">
- <summary>
- Converts the value of the specified operating system to its equivalent
- <see cref="T:System.String"/> representation.
- </summary>
- <param name="operatingSystem">The operating system.</param>
- <returns>
- The <see cref="T:System.String"/> representation of
- <paramref name="operatingSystem"/>.
- </returns>
- <example>
- <para>
- Output string representation of the current operating system.
- </para>
- <code>
- <![CDATA[
- <echo message="OS=${operating-system::to-string(environment::get-operating-system())}" />
- ]]>
- </code>
- <para>If the operating system is Windows 2000, the output is:</para>
- <code>
- Microsoft Windows NT 5.0.2195.0
- </code>
- </example>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetFullPath(System.String)">
- <summary>
- Returns the fully qualified path.
- </summary>
- <param name="path">The file or directory for which to obtain absolute path information.</param>
- <returns>
- A string containing the fully qualified location of <paramref name="path"/>,
- such as "C:\MyFile.txt".
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> is a zero-length string, contains only white space, or contains one or more invalid characters.</exception>
- <exception cref="T:System.NotSupportedException"><paramref name="path"/> contains a colon (":").</exception>
- <exception cref="T:System.IO.PathTooLongException">The specified path, file name, or both exceed the system-defined maximum length.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.Combine(System.String,System.String)">
- <summary>
- Combines two paths.
- </summary>
- <param name="path1">first path</param>
- <param name="path2">second path</param>
- <returns>
- A string containing the combined paths. If one of the specified paths
- is a zero-length string, this method returns the other path. If
- <paramref name="path2"/> contains an absolute path, this method
- returns <paramref name="path2"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path1"/> or <paramref name="path2"/> contain one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.ChangeExtension(System.String,System.String)">
- <summary>
- Changes the extension of the path string.
- </summary>
- <param name="path">The path information to modify. The path cannot contain any of the characters
- defined in <see cref="F:System.IO.Path.InvalidPathChars"/>InvalidPathChars.</param>
- <param name="extension">The new extension (with a leading period). Specify a null reference
- to remove an existing extension from <paramref name="path"/>.</param>
- <returns>
- <para>
- A string containing the modified path information.
- </para>
- <para>
- On Windows-based desktop platforms, if <paramref name="path"/> is
- an empty <see cref="T:System.String"/>, the path information is returned
- unmodified. If <paramref name="path"/> has no extension, the returned
- path <see cref="T:System.String"/> contains <paramref name="extension"/>
- appended to the end of <paramref name="path"/>.
- </para>
- </returns>
- <remarks>
- For more information see the <see cref="T:System.IO.Path"/> documentation.
- </remarks>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetDirectoryName(System.String)">
- <summary>
- Returns the directory information for the specified path string.
- </summary>
- <param name="path">The path of a file or directory.</param>
- <returns>
- A <see cref="T:System.String"/> containing directory information for
- <paramref name="path"/>, or an empty <see cref="T:System.String"/> if
- <paramref name="path"/> denotes a root directory, or does not
- contain directory information.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, is empty, or contains only white spaces.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetExtension(System.String)">
- <summary>
- Returns the extension for the specified path string.
- </summary>
- <param name="path">The path string from which to get the extension.</param>
- <returns>
- A <see cref="T:System.String"/> containing the extension of the specified
- <paramref name="path"/> (including the "."), or an empty
- <see cref="T:System.String"/> if <paramref name="path"/> does not have
- extension information.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)">
- <summary>
- Returns the filename for the specified path string.
- </summary>
- <param name="path">The path string from which to obtain the file name and extension.</param>
- <returns>
- <para>
- A <see cref="T:System.String"/> consisting of the characters after the last
- directory character in path.
- </para>
- <para>
- If the last character of <paramref name="path"/> is a directory or
- volume separator character, an empty <see cref="T:System.String"/> is returned.
- </para>
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetFileNameWithoutExtension(System.String)">
- <summary>
- Returns the filename without extension for the specified path string.
- </summary>
- <param name="path">The path of the file.</param>
- <returns>
- A <see cref="T:System.String"/> containing the <see cref="T:System.String"/> returned
- by <see cref="M:NAnt.Core.Functions.PathFunctions.GetFileName(System.String)"/>, minus the last period (.) and all
- characters following it.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetPathRoot(System.String)">
- <summary>
- Gets the root directory of the specified path.
- </summary>
- <param name="path">The path from which to obtain root directory information.</param>
- <returns>
- A <see cref="T:System.String"/> containing the root directory of
- <paramref name="path"/>, such as "C:\", or an empty <see cref="T:System.String"/>
- if <paramref name="path"/> does not contain root directory information.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains invalid characters, or is empty.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetTempFileName">
- <summary>
- Returns a uniquely named zero-byte temporary file on disk and returns the full path to that file.
- </summary>
- <returns>
- A <see cref="T:System.String"/> containing the name of the temporary file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.GetTempPath">
- <summary>
- Gets the path to the temporary directory.
- </summary>
- <returns>
- A <see cref="T:System.String"/> containing the path information of a
- temporary directory.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.HasExtension(System.String)">
- <summary>
- Determines whether a path string includes an extension.
- </summary>
- <param name="path">The path to search for an extension.</param>
- <returns>
- <see langword="true"/>. if the characters that follow the last
- directory separator or volume separator in the <paramref name="path"/>
- include a period (.) followed by one or more characters;
- otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PathFunctions.IsPathRooted(System.String)">
- <summary>
- Determines whether a path string is absolute.
- </summary>
- <param name="path">The path to test.</param>
- <returns>
- <see langword="true"/> if path contains an absolute <paramref name="path"/>;
- otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> contains one or more invalid characters.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetVariable(System.String,System.String)">
- <summary>
- Gets the value of a variable for the specified package.
- </summary>
- <param name="package">The package for which the variable should be retrieved.</param>
- <param name="name">The name of the variable.</param>
- <returns>
- The value of variable <paramref name="name"/> for the specified
- package.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetLinkFlags(System.String)">
- <summary>
- Gets the link flags required to compile the package, including all
- its dependencies.
- </summary>
- <param name="package">The package for which the link flags should be retrieved.</param>
- <returns>
- The link flags required to compile the package.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetCompileFlags(System.String)">
- <summary>
- Gets the compile flags required to compile the package, including all
- its dependencies.
- </summary>
- <param name="package">The package for which the compile flags should be retrieved.</param>
- <returns>
- The pre-processor and compile flags required to compile the package.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetModVersion(System.String)">
- <summary>
- Determines the version of the given package.
- </summary>
- <param name="package">The package to get the version of.</param>
- <returns>
- The version of the given package.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="package"/> does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsAtLeastVersion(System.String,System.String)">
- <summary>
- Determines whether the given package is at least version
- <paramref name="version"/>.
- </summary>
- <param name="package">The package to check.</param>
- <param name="version">The version the package should at least have.</param>
- <returns>
- <see langword="true"/> if the given package is at least version
- <paramref name="version"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsExactVersion(System.String,System.String)">
- <summary>
- Determines whether the given package is exactly version
- <paramref name="version"/>.
- </summary>
- <param name="package">The package to check.</param>
- <param name="version">The version the package should have.</param>
- <returns>
- <see langword="true"/> if the given package is exactly version
- <paramref name="version"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsMaxVersion(System.String,System.String)">
- <summary>
- Determines whether the given package is at no newer than version
- <paramref name="version"/>.
- </summary>
- <param name="package">The package to check.</param>
- <param name="version">The version the package should maximum have.</param>
- <returns>
- <see langword="true"/> if the given package is at no newer than
- version <paramref name="version"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.IsBetweenVersion(System.String,System.String,System.String)">
- <summary>
- Determines whether the given package is between two versions.
- </summary>
- <param name="package">The package to check.</param>
- <param name="minVersion">The version the package should at least have.</param>
- <param name="maxVersion">The version the package should maximum have.</param>
- <returns>
- <see langword="true"/> if the given package is between <paramref name="minVersion"/>
- and <paramref name="maxVersion"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.Exists(System.String)">
- <summary>
- Determines whether the given package exists.
- </summary>
- <param name="package">The package to check.</param>
- <returns>
- <see langword="true"/> if the package exists; otherwise,
- <see langword="false"/>.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>pkg-config</c> could not be started.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigBool(NAnt.Core.Types.Argument[])">
- <summary>
- Runs pkg-config with the specified arguments and returns a
- <see cref="T:System.Boolean"/> based on the exit code.
- </summary>
- <param name="args">The arguments to pass to pkg-config.</param>
- <returns>
- <see langword="true"/> if pkg-config exited with exit code 0;
- otherwise, <see langword="false"/>
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.RunPkgConfigString(NAnt.Core.Types.Argument[])">
- <summary>
- Runs pkg-config with the specified arguments and returns the result
- as a <see cref="T:System.String"/>.
- </summary>
- <param name="args">The arguments to pass to pkg-config.</param>
- <returns>
- The result of running pkg-config with the specified arguments.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.PkgConfigFunctions.GetTask(System.IO.Stream)">
- <summary>
- Factory method to return a new instance of ExecTask
- </summary>
- <param name="stream"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.GetLength(System.String)">
- <summary>
- Returns the length of the specified string.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string's length.
- </returns>
- <example>
- <code>string::get-length('foo') ==> 3</code>
- </example>
- <example>
- <code>string::get-length('') ==> 0</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.Substring(System.String,System.Int32,System.Int32)">
- <summary>
- Returns a substring of the specified string.
- </summary>
- <param name="str">input string</param>
- <param name="startIndex">position of the start of the substring</param>
- <param name="length">the length of the substring</param>
- <returns>
- <para>
- If the <paramref name="length"/> is greater than zero, the
- function returns a substring starting at character position
- <paramref name="startIndex"/> with a length of <paramref name="length"/>
- characters.
- </para>
- <para>
- If the <paramref name="length"/> is equal to zero, the function
- returns an empty string.
- </para>
- </returns>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> or <paramref name="length"/> is less than zero.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> is greater than the length of <paramref name="str"/>.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="startIndex"/> plus <paramref name="length"/> indicates a position not within <paramref name="str"/>.</exception>
- <example>
- <code>string::substring('testing string', 0, 4) ==> 'test'</code>
- </example>
- <example>
- <code>string::substring('testing string', 8, 3) ==> 'str'</code>
- </example>
- <example>
- <code>string::substring('testing string', 8, 0) ==> ''</code>
- </example>
- <example>
- <code>string::substring('testing string', -1, 5) ==> ERROR</code>
- </example>
- <example>
- <code>string::substring('testing string', 8, -1) ==> ERROR</code>
- </example>
- <example>
- <code>string::substring('testing string', 5, 17) ==> ERROR</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.StartsWith(System.String,System.String)">
- <summary>
- Tests whether the specified string starts with the specified prefix
- string.
- </summary>
- <param name="s1">test string</param>
- <param name="s2">prefix string</param>
- <returns>
- <see langword="true" /> when <paramref name="s2" /> is a prefix for
- the string <paramref name="s1" />. Meaning, the characters at the
- beginning of <paramref name="s1" /> are identical to
- <paramref name="s2" />; otherwise, <see langword="false" />.
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::starts-with('testing string', 'test') ==> true</code>
- </example>
- <example>
- <code>string::starts-with('testing string', 'testing') ==> true</code>
- </example>
- <example>
- <code>string::starts-with('testing string', 'string') ==> false</code>
- </example>
- <example>
- <code>string::starts-with('test', 'testing string') ==> false</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.EndsWith(System.String,System.String)">
- <summary>
- Tests whether the specified string ends with the specified suffix
- string.
- </summary>
- <param name="s1">test string</param>
- <param name="s2">suffix string</param>
- <returns>
- <see langword="true" /> when <paramref name="s2" /> is a suffix for
- the string <paramref name="s1" />. Meaning, the characters at the
- end of <paramref name="s1" /> are identical to
- <paramref name="s2" />; otherwise, <see langword="false" />.
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::ends-with('testing string', 'string') ==> true</code>
- </example>
- <example>
- <code>string::ends-with('testing string', '') ==> true</code>
- </example>
- <example>
- <code>string::ends-with('testing string', 'bring') ==> false</code>
- </example>
- <example>
- <code>string::ends-with('string', 'testing string') ==> false</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.ToLower(System.String)">
- <summary>
- Returns the specified string converted to lowercase.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> in lowercase.
- </returns>
- <remarks>
- The casing rules of the invariant culture are used to convert the
- <paramref name="s" /> to lowercase.
- </remarks>
- <example>
- <code>string::to-lower('testing string') ==> 'testing string'</code>
- </example>
- <example>
- <code>string::to-lower('Testing String') ==> 'testing string'</code>
- </example>
- <example>
- <code>string::to-lower('Test 123') ==> 'test 123'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.ToUpper(System.String)">
- <summary>
- Returns the specified string converted to uppercase.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> in uppercase.
- </returns>
- <remarks>
- The casing rules of the invariant culture are used to convert the
- <paramref name="s" /> to uppercase.
- </remarks>
- <example>
- <code>string::to-upper('testing string') ==> 'TESTING STRING'</code>
- </example>
- <example>
- <code>string::to-upper('Testing String') ==> 'TESTING STRING'</code>
- </example>
- <example>
- <code>string::to-upper('Test 123') ==> 'TEST 123'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.Replace(System.String,System.String,System.String)">
- <summary>
- Returns a string corresponding to the replacement of a given string
- with another in the specified string.
- </summary>
- <param name="str">input string</param>
- <param name="oldValue">A <see cref="T:System.String"/> to be replaced.</param>
- <param name="newValue">A <see cref="T:System.String"/> to replace all occurrences of <paramref name="oldValue"/>.</param>
- <returns>
- A <see cref="T:System.String"/> equivalent to <paramref name="str"/> but
- with all instances of <paramref name="oldValue"/> replaced with
- <paramref name="newValue"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="oldValue"/> is an empty string.</exception>
- <remarks>
- This function performs a word (case-sensitive and culture-sensitive)
- search to find <paramref name="oldValue"/>.
- </remarks>
- <example>
- <code>string::replace('testing string', 'test', 'winn') ==> 'winning string'</code>
- </example>
- <example>
- <code>string::replace('testing string', 'foo', 'winn') ==> 'testing string'</code>
- </example>
- <example>
- <code>string::replace('testing string', 'ing', '') ==> 'test str'</code>
- </example>
- <example>
- <code>string::replace('banana', 'ana', 'ana') ==> 'banana'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.Contains(System.String,System.String)">
- <summary>
- Tests whether the specified string contains the given search string.
- </summary>
- <param name="source">The string to search.</param>
- <param name="value">The string to locate within <paramref name="source" />.</param>
- <returns>
- <see langword="true" /> if <paramref name="value" /> is found in
- <paramref name="source" />; otherwise, <see langword="false" />.
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::contains('testing string', 'test') ==> true</code>
- </example>
- <example>
- <code>string::contains('testing string', '') ==> true</code>
- </example>
- <example>
- <code>string::contains('testing string', 'Test') ==> false</code>
- </example>
- <example>
- <code>string::contains('testing string', 'foo') ==> false</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.IndexOf(System.String,System.String)">
- <summary>
- Returns the position of the first occurrence in the specified string
- of the given search string.
- </summary>
- <param name="source">The string to search.</param>
- <param name="value">The string to locate within <paramref name="source" />.</param>
- <returns>
- <para>
- The lowest-index position of <paramref name="value" /> in
- <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
- does not contain <paramref name="value" />.
- </para>
- <para>
- If <paramref name="value" /> is an empty string, the return value
- will always be <c>0</c>.
- </para>
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::index-of('testing string', 'test') ==> 0</code>
- </example>
- <example>
- <code>string::index-of('testing string', '') ==> 0</code>
- </example>
- <example>
- <code>string::index-of('testing string', 'Test') ==> -1</code>
- </example>
- <example>
- <code>string::index-of('testing string', 'ing') ==> 4</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.LastIndexOf(System.String,System.String)">
- <summary>
- Returns the position of the last occurrence in the specified string
- of the given search string.
- </summary>
- <param name="source">The string to search.</param>
- <param name="value">The string to locate within <paramref name="source" />.</param>
- <returns>
- <para>
- The highest-index position of <paramref name="value" /> in
- <paramref name="source" /> if it is found, or -1 if <paramref name="source" />
- does not contain <paramref name="value" />.
- </para>
- <para>
- If <paramref name="value" /> is an empty string, the return value
- is the last index position in <paramref name="source" />.
- </para>
- </returns>
- <remarks>
- This function performs a case-sensitive word search using the
- invariant culture.
- </remarks>
- <example>
- <code>string::last-index-of('testing string', 'test') ==> 0</code>
- </example>
- <example>
- <code>string::last-index-of('testing string', '') ==> 13</code>
- </example>
- <example>
- <code>string::last-index-of('testing string', 'Test') ==> -1</code>
- </example>
- <example>
- <code>string::last-index-of('testing string', 'ing') ==> 11</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.PadLeft(System.String,System.Int32,System.String)">
- <summary>
- Returns the given string left-padded to the given length.
- </summary>
- <param name="s">The <see cref="T:System.String"/> that needs to be left-padded.</param>
- <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
- <param name="paddingChar">A Unicode padding character.</param>
- <returns>
- If the length of <paramref name="s"/> is at least
- <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
- to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
- will be padded on the left with as many <paramref name="paddingChar"/>
- characters as needed to create a length of <paramref name="totalWidth"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
- <remarks>
- Note that only the first character of <paramref name="paddingChar"/>
- will be used when padding the result.
- </remarks>
- <example>
- <code>string::pad-left('test', 10, ' ') ==> ' test'</code>
- </example>
- <example>
- <code>string::pad-left('test', 10, 'test') ==> 'tttttttest'</code>
- </example>
- <example>
- <code>string::pad-left('test', 3, ' ') ==> 'test'</code>
- </example>
- <example>
- <code>string::pad-left('test', -4, ' ') ==> ERROR</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.PadRight(System.String,System.Int32,System.String)">
- <summary>
- Returns the given string right-padded to the given length.
- </summary>
- <param name="s">The <see cref="T:System.String"/> that needs to be right-padded.</param>
- <param name="totalWidth">The number of characters in the resulting string, equal to the number of original characters plus any additional padding characters.</param>
- <param name="paddingChar">A Unicode padding character.</param>
- <returns>
- If the length of <paramref name="s"/> is at least
- <paramref name="totalWidth"/>, then a new <see cref="T:System.String"/> identical
- to <paramref name="s"/> is returned. Otherwise, <paramref name="s"/>
- will be padded on the right with as many <paramref name="paddingChar"/>
- characters as needed to create a length of <paramref name="totalWidth"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="totalWidth"/> is less than zero.</exception>
- <remarks>
- Note that only the first character of <paramref name="paddingChar"/>
- will be used when padding the result.
- </remarks>
- <example>
- <code>string::pad-right('test', 10, ' ') ==> 'test '</code>
- </example>
- <example>
- <code>string::pad-right('test', 10, 'abcd') ==> 'testaaaaaa'</code>
- </example>
- <example>
- <code>string::pad-right('test', 3, ' ') ==> 'test'</code>
- </example>
- <example>
- <code>string::pad-right('test', -3, ' ') ==> ERROR</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.Trim(System.String)">
- <summary>
- Returns the given string trimmed of whitespace.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> with any leading or trailing
- white space characters removed.
- </returns>
- <example>
- <code>string::trim(' test ') ==> 'test'</code>
- </example>
- <example>
- <code>string::trim('\t\tfoo \r\n') ==> 'foo'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.TrimStart(System.String)">
- <summary>
- Returns the given string trimmed of leading whitespace.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> with any leading
- whites pace characters removed.
- </returns>
- <example>
- <code>string::trim-start(' test ') ==> 'test '</code>
- </example>
- <example>
- <code>string::trim-start('\t\tfoo \r\n') ==> 'foo \r\n'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.StringFunctions.TrimEnd(System.String)">
- <summary>
- Returns the given string trimmed of trailing whitespace.
- </summary>
- <param name="s">input string</param>
- <returns>
- The string <paramref name="s" /> with any trailing
- white space characters removed.
- </returns>
- <example>
- <code>string::trim-end(' test ') ==> ' test'</code>
- </example>
- <example>
- <code>string::trim-end('\t\tfoo \r\n') ==> '\t\tfoo'</code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalDays(System.TimeSpan)">
- <summary>
- Returns the total number of days represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional days.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of days represented by the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalHours(System.TimeSpan)">
- <summary>
- Returns the total number of hours represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional hours.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of hours represented by the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMinutes(System.TimeSpan)">
- <summary>
- Returns the total number of minutes represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional minutes.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of minutes represented by the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalSeconds(System.TimeSpan)">
- <summary>
- Returns the total number of seconds represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional seconds.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of seconds represented by the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTotalMilliseconds(System.TimeSpan)">
- <summary>
- Returns the total number of milliseconds represented by the specified
- <see cref="T:System.TimeSpan"/>, expressed in whole and fractional milliseconds.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The total number of milliseconds represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetDays(System.TimeSpan)">
- <summary>
- Returns the number of whole days represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole days represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- <example>
- <para>
- Remove all files that have not been modified in the last 7 days from directory "binaries".</para>
- <code>
- <![CDATA[
- <foreach item="File" in="binaries" property="filename">
- <if test="${timespan::get-days(datetime::now() - file::get-last-write-time(filename)) >= 7}">
- <delete file="${filename}" />
- </if>
- </foreach>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetHours(System.TimeSpan)">
- <summary>
- Returns the number of whole hours represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole hours represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMinutes(System.TimeSpan)">
- <summary>
- Returns the number of whole minutes represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole minutes represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetSeconds(System.TimeSpan)">
- <summary>
- Returns the number of whole seconds represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole seconds represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetMilliseconds(System.TimeSpan)">
- <summary>
- Returns the number of whole milliseconds represented by the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of whole milliseconds represented by the given
- <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.GetTicks(System.TimeSpan)">
- <summary>
- Returns the number of ticks contained in the specified
- <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/>.</param>
- <returns>
- The number of ticks contained in the given <see cref="T:System.TimeSpan"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromDays(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of days, where the specification is accurate to the nearest millisecond.
- </summary>
- <param name="value">A number of days, accurate to the nearest millisecond.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromHours(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of hours, where the specification is accurate to the nearest
- millisecond.
- </summary>
- <param name="value">A number of hours, accurate to the nearest millisecond.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMinutes(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of minutes, where the specification is accurate to the nearest
- millisecond.
- </summary>
- <param name="value">A number of minutes, accurate to the nearest millisecond.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromSeconds(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of seconds, where the specification is accurate to the nearest
- millisecond.
- </summary>
- <param name="value">A number of seconds, accurate to the nearest millisecond.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromMilliseconds(System.Double)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified number
- of milliseconds.
- </summary>
- <param name="value">A number of milliseconds.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanFunctions.FromTicks(System.Int64)">
- <summary>
- Returns a <see cref="T:System.TimeSpan"/> that represents a specified time,
- where the specification is in units of ticks.
- </summary>
- <param name="value">A number of ticks that represent a time.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that represents <paramref name="value"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.Parse(System.String)">
- <summary>
- Constructs a <see cref="T:System.TimeSpan"/> from a time indicated by a
- specified string.
- </summary>
- <param name="s">A string.</param>
- <returns>
- A <see cref="T:System.TimeSpan"/> that corresponds to <paramref name="s"/>.
- </returns>
- <exception cref="T:System.FormatException"><paramref name="s"/> has an invalid format.</exception>
- <exception cref="T:System.OverflowException">At least one of the hours, minutes, or seconds components is outside its valid range.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.TimeSpanConversionFunctions.ToString(System.TimeSpan)">
- <summary>
- Converts the specified <see cref="T:System.TimeSpan"/> to its equivalent
- string representation.
- </summary>
- <param name="value">A <see cref="T:System.TimeSpan"/> to convert.</param>
- <returns>
- The string representation of <paramref name="value"/>. The format
- of the return value is of the form: [-][d.]hh:mm:ss[.ff].
- </returns>
- </member>
- <member name="M:NAnt.Core.Functions.VersionFunctions.GetMajor(System.Version)">
- <summary>
- Gets the value of the major component of a given version.
- </summary>
- <param name="version">A version.</param>
- <returns>
- The major version number.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="M:NAnt.Core.Functions.VersionFunctions.GetMinor(System.Version)">
- <summary>
- Gets the value of the minor component of a given version.
- </summary>
- <param name="version">A version.</param>
- <returns>
- The minor version number.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="M:NAnt.Core.Functions.VersionFunctions.GetBuild(System.Version)">
- <summary>
- Gets the value of the build component of a given version.
- </summary>
- <param name="version">A version.</param>
- <returns>
- The build number, or -1 if the build number is undefined.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="M:NAnt.Core.Functions.VersionFunctions.GetRevision(System.Version)">
- <summary>
- Gets the value of the revision component of a given version.
- </summary>
- <param name="version">A version.</param>
- <returns>
- The revision number, or -1 if the revision number is undefined.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="M:NAnt.Core.Functions.VersionConversionFunctions.Parse(System.String)">
- <summary>
- Converts the specified string representation of a version to
- its <see cref="T:System.Version"/> equivalent.
- </summary>
- <param name="version">A string containing the major, minor, build, and revision numbers, where each number is delimited with a period character ('.').</param>
- <returns>
- A <see cref="T:System.Version"/> instance representing the specified
- <see cref="T:System.String"/>.
- </returns>
- <exception cref="T:System.ArgumentException"><paramref name="version"/> has fewer than two components or more than four components.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">A major, minor, build, or revision component is less than zero.</exception>
- <exception cref="T:System.FormatException">At least one component of <paramref name="version"/> does not parse to a decimal integer.</exception>
- </member>
- <member name="M:NAnt.Core.Functions.VersionConversionFunctions.ToString(System.Version)">
- <summary>
- Converts the specified <see cref="T:System.Version"/> to its equivalent
- string representation.
- </summary>
- <param name="value">A <see cref="T:System.Version"/> to convert.</param>
- <returns>
- The string representation of the values of the major, minor, build,
- and revision components of the specified <see cref="T:System.Version"/>.
- </returns>
- <seealso cref="M:NAnt.Core.Functions.AssemblyNameFunctions.GetVersion(System.Reflection.AssemblyName)"/>
- <seealso cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/>
- <seealso cref="M:NAnt.Core.Functions.OperatingSystemFunctions.GetVersion(System.OperatingSystem)"/>
- </member>
- <member name="T:NAnt.Core.Tasks.AttribTask">
- <summary>
- Changes the file attributes of a file or set of files and directories.
- </summary>
- <remarks>
- <para>
- <see cref="T:NAnt.Core.Tasks.AttribTask"/> does not have the concept of turning
- attributes off. Instead you specify all the attributes that you want
- turned on and the rest are turned off by default.
- </para>
- <para>
- Refer to the <see cref="T:System.IO.FileAttributes"/> enumeration in the .NET SDK
- for more information about file attributes.
- </para>
- </remarks>
- <example>
- <para>
- Set the <c>read-only</c> file attribute for the specified file in
- the project directory.
- </para>
- <code>
- <![CDATA[
- <attrib file="myfile.txt" readonly="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Set the <c>normal</c> file attribute for the specified file.
- </para>
- <code>
- <![CDATA[
- <attrib file="myfile.txt" normal="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Set the <c>normal</c> file attribute for all executable files in
- the current project directory and sub-directories.
- </para>
- <code>
- <![CDATA[
- <attrib normal="true">
- <fileset>
- <include name="**/*.exe" />
- <include name="bin" />
- </fileset>
- </attrib>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Task">
- <summary>
- Provides the abstract base class for tasks.
- </summary>
- <remarks>
- A task is a piece of code that can be executed.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.Execute">
- <summary>
- Executes the task unless it is skipped.
- </summary>
- </member>
- <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String)">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to be logged.</param>
- <remarks>
- <para>
- The actual logging is delegated to the project.
- </para>
- <para>
- If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
- message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
- priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>
- when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
- </para>
- <para>
- This will allow individual tasks to run in verbose mode while
- the build log itself is still configured with threshold
- <see cref="F:NAnt.Core.Level.Info"/>.
- </para>
- <para>
- The threshold of the project is not taken into account to determine
- whether a message should be passed to the logging infrastructure,
- as build listeners might be interested in receiving all messages.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a formatted message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- <para>
- The actual logging is delegated to the project.
- </para>
- <para>
- If the <see cref="P:NAnt.Core.Task.Verbose"/> attribute is set on the task and a
- message is logged with level <see cref="F:NAnt.Core.Level.Verbose"/>, the
- priority of the message will be increased to <see cref="F:NAnt.Core.Level.Info"/>.
- when the threshold of the build log is <see cref="F:NAnt.Core.Level.Info"/>.
- </para>
- <para>
- This will allow individual tasks to run in verbose mode while
- the build log itself is still configured with threshold
- <see cref="F:NAnt.Core.Level.Info"/>.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.IsLogEnabledFor(NAnt.Core.Level)">
- <summary>
- Determines whether build output is enabled for the given
- <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to check.</param>
- <returns>
- <see langword="true"/> if messages with the given <see cref="T:NAnt.Core.Level"/>
- should be passed on to the logging infrastructure; otherwise,
- <see langword="false"/>.
- </returns>
- <remarks>
- The threshold of the project is not taken into account to determine
- whether a message should be passed to the logging infrastructure,
- as build listeners might be interested in receiving all messages.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.InitializeTaskConfiguration">
- <summary>
- Initializes the configuration of the task using configuration
- settings retrieved from the NAnt configuration file.
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Task.Initialize">
- <summary>Initializes the task.</summary>
- </member>
- <member name="M:NAnt.Core.Task.InitializeTask(System.Xml.XmlNode)">
- <summary>Initializes the task.</summary>
- </member>
- <member name="M:NAnt.Core.Task.ExecuteTask">
- <summary>Executes the task.</summary>
- </member>
- <member name="M:NAnt.Core.Task.GetAttributeConfigurationNode(NAnt.Core.FrameworkInfo,System.String)">
- <summary>
- Locates the XML node for the specified attribute in either the
- configuration section of the extension assembly or the.project.
- </summary>
- <param name="attributeName">The name of attribute for which the XML configuration node should be located.</param>
- <param name="framework">The framework to use to obtain framework specific information, or <see langword="null" /> if no framework specific information should be used.</param>
- <returns>
- The XML configuration node for the specified attribute, or
- <see langword="null" /> if no corresponding XML node could be
- located.
- </returns>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Task.FailOnError">
- <summary>
- Determines if task failure stops the build, or is just reported.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.Verbose">
- <summary>
- Determines whether the task should report detailed build log messages.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.IfDefined">
- <summary>
- If <see langword="true" /> then the task will be executed; otherwise,
- skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Task.IfDefined"/>. If <see langword="false"/>
- then the task will be executed; otherwise, skipped. The default is
- <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.Name">
- <summary>
- The name of the task.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.LogPrefix">
- <summary>
- The prefix used when sending messages to the log.
- </summary>
- </member>
- <member name="P:NAnt.Core.Task.Threshold">
- <summary>
- Gets or sets the log threshold for this <see cref="T:NAnt.Core.Task"/>. By
- default the threshold of a task is <see cref="F:NAnt.Core.Level.Debug"/>,
- causing no messages to be filtered in the task itself.
- </summary>
- <value>
- The log threshold level for this <see cref="T:NAnt.Core.Task"/>.
- </value>
- <remarks>
- When the threshold of a <see cref="T:NAnt.Core.Task"/> is higher than the
- threshold of the <see cref="T:NAnt.Core.Project"/>, then all messages will
- still be delivered to the build listeners.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Task.TaskBuilder">
- <summary>
- Returns the TaskBuilder used to construct an instance of this
- <see cref="T:NAnt.Core.Task"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.File">
- <summary>
- The name of the file which will have its attributes set. This is
- provided as an alternate to using the task's fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.AttribFileSet">
- <summary>
- All the matching files and directories in this fileset will have
- their attributes set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.ArchiveAttrib">
- <summary>
- Set the archive attribute. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.HiddenAttrib">
- <summary>
- Set the hidden attribute. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.NormalAttrib">
- <summary>
- Set the normal file attributes. This attribute is only valid if used
- alone. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.ReadOnlyAttrib">
- <summary>
- Set the read-only attribute. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AttribTask.SystemAttrib">
- <summary>
- Set the system attribute. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.AvailableTask">
- <summary>
- Checks if a resource is available at runtime.
- </summary>
- <remarks>
- <para>
- The specified property is set to <see langword="true"/> if the
- requested resource is available at runtime, and <see langword="false"/>
- if the resource is not available.
- </para>
- <note>
- we advise you to use the following functions instead:
- </note>
- <list type="table">
- <listheader>
- <term>Function</term>
- <description>Description</description>
- </listheader>
- <item>
- <term><see cref="M:NAnt.Core.Functions.FileFunctions.Exists(System.String)"/></term>
- <description>Determines whether the specified file exists.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.DirectoryFunctions.Exists(System.String)"/></term>
- <description>Determines whether the given path refers to an existing directory on disk.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.Exists(System.String)"/></term>
- <description>Checks whether the specified framework exists..</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.FrameworkFunctions.SdkExists(System.String)"/></term>
- <description>Checks whether the SDK for the specified framework is installed.</description>
- </item>
- </list>
- </remarks>
- <example>
- <para>
- Sets the <c>myfile.present</c> property to <see langword="true"/> if the
- file is available on the filesystem and <see langword="false"/> if the
- file is not available.
- </para>
- <code>
- <![CDATA[
- <available type="File" resource="myfile.txt" property="myfile.present" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Sets the <c>build.dir.present</c> property to <see langword="true"/>
- if the directory is available on the filesystem and <see langword="false"/>
- if the directory is not available.
- </para>
- <code>
- <![CDATA[
- <available type="Directory" resource="build" property="build.dir.present" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Sets the <c>mono-0.21.framework.present</c> property to <see langword="true"/>
- if the Mono 0.21 framework is available on the current system and
- <see langword="false"/> if the framework is not available.
- </para>
- <code>
- <![CDATA[
- <available type="Framework" resource="mono-0.21" property="mono-0.21.framework.present" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Sets the <c>net-1.1.frameworksdk.present</c> property to <see langword="true"/>
- if the .NET 1.1 Framework SDK is available on the current system and
- <see langword="false"/> if the SDK is not available.
- </para>
- <code>
- <![CDATA[
- <available type="FrameworkSDK" resource="net-1.1" property="net-1.1.frameworksdk.present" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- <remarks>
- <para>
- Sets the property identified by <see cref="P:NAnt.Core.Tasks.AvailableTask.PropertyName"/> to
- <see langword="true"/> when the resource exists and to <see langword="false"/>
- when the resource doesn't exist.
- </para>
- </remarks>
- <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.Evaluate">
- <summary>
- Evaluates the availability of a resource.
- </summary>
- <returns>
- <see langword="true"/> if the resource is available; otherwise,
- <see langword="false"/>.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">The availability of the resource could not be evaluated.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFile">
- <summary>
- Checks if the file specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/> property is
- available on the filesystem.
- </summary>
- <returns>
- <see langword="true"/> when the file exists; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.CheckDirectory">
- <summary>
- Checks if the directory specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
- property is available on the filesystem.
- </summary>
- <returns>
- <see langword="true"/> when the directory exists; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFramework">
- <summary>
- Checks if the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
- property is available on the current system.
- </summary>
- <returns>
- <see langword="true"/> when the framework is available; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.AvailableTask.CheckFrameworkSDK">
- <summary>
- Checks if the SDK for the framework specified in the <see cref="P:NAnt.Core.Tasks.AvailableTask.Resource"/>
- property is available on the current system.
- </summary>
- <returns>
- <see langword="true"/> when the SDK for the specified framework is
- available; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="P:NAnt.Core.Tasks.AvailableTask.Resource">
- <summary>
- The resource which must be available.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AvailableTask.Type">
- <summary>
- The type of resource which must be present.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.AvailableTask.PropertyName">
- <summary>
- The property that must be set if the resource is available.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.AvailableTask.ResourceType">
- <summary>
- Defines the possible resource checks.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.File">
- <summary>
- Determines whether a given file exists.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Directory">
- <summary>
- Determines whether a given directory exists.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.Framework">
- <summary>
- Determines whether a given framework is available.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.AvailableTask.ResourceType.FrameworkSDK">
- <summary>
- Determines whether a given SDK is available.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.CallTask">
- <summary>
- Calls a NAnt target in the current project.
- </summary>
- <remarks>
- <para>
- When the <see cref="T:NAnt.Core.Tasks.CallTask"/> is used to execute a target, both that
- target and all its dependent targets will be re-executed.
- </para>
- <para>
- To avoid dependent targets from being executed more than once, two
- options are available:
- </para>
- <list type="bullet">
- <item>
- <description>
- Add an "unless" attribute with value "${<see href="../functions/target.has-executed.html">target::has-executed</see>('<c><target name></c>')}"
- to the dependent targets.
- </description>
- </item>
- <item>
- <description>
- Set the <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute on the
- <see cref="T:NAnt.Core.Tasks.CallTask"/> to <see langword="false "/> (<c>recommended</c>).
- </description>
- </item>
- </list>
- </remarks>
- <example>
- <para>
- Call the target "build".
- </para>
- <code>
- <![CDATA[
- <call target="build" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- This shows how a project could 'compile' a debug and release build
- using a common compile target.
- </para>
- <code>
- <![CDATA[
- <project default="build">
- <property name="debug" value="false" />
- <target name="init">
- <echo message="initializing" />
- </target>
- <target name="compile" depends="init">
- <echo message="compiling with debug = ${debug}" />
- </target>
- <target name="build">
- <property name="debug" value="false" />
- <call target="compile" />
- <property name="debug" value="true" />
- <call target="compile" />
- </target>
- </project>
- ]]>
- </code>
- <para>
- The <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> parameter of the
- <see cref="T:NAnt.Core.Tasks.CallTask"/> defaults to <see langword="true"/>,
- causing the "init" target to be executed for both
- the "debug" and "release" build.
- </para>
- <para>
- This results in the following build log:
- </para>
- <code>
- build:
-
- init:
-
- [echo] initializing
-
- compile:
-
- [echo] compiling with debug = false
-
- init:
-
- [echo] initializing
-
- compile:
-
- [echo] compiling with debug = true
-
- BUILD SUCCEEDED
- </code>
- <para>
- If the "init" should only be executed once, set the
- <see cref="P:NAnt.Core.Tasks.CallTask.CascadeDependencies"/> attribute of the <see cref="T:NAnt.Core.Tasks.CallTask"/>
- to <see langword="false"/>.
- </para>
- <para>
- The build log would then look like this:
- </para>
- <code>
- build:
-
- init:
-
- [echo] initializing
-
- compile:
-
- [echo] compiling with debug = false
-
- compile:
-
- [echo] compiling with debug = true
-
- BUILD SUCCEEDED
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.CallTask.ExecuteTask">
- <summary>
- Executes the specified target.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.CallTask.Initialize">
- <summary>
- Makes sure the <see cref="T:NAnt.Core.Tasks.CallTask"/> is not calling its own
- parent.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CallTask.TargetName">
- <summary>
- NAnt target to call.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CallTask.ForceExecute">
- <summary>
- Force an execute even if the target has already been executed. The
- default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CallTask.CascadeDependencies">
- <summary>
- Execute the specified targets dependencies -- even if they have been
- previously executed. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.CopyTask">
- <summary>
- Copies a file or set of files to a new file or directory.
- </summary>
- <remarks>
- <para>
- Files are only copied if the source file is newer than the destination
- file, or if the destination file does not exist. However, you can
- explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/> attribute.
- </para>
- <para>
- When a <see cref="T:NAnt.Core.Types.FileSet"/> is used to select files to copy, the
- <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set. Files that are
- located under the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/> will
- be copied to a directory under the destination directory matching the
- path relative to the base directory of the <see cref="T:NAnt.Core.Types.FileSet"/>,
- unless the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/> attribute is set to
- <see langword="true"/>.
- </para>
- <para>
- Files that are not located under the the base directory of the
- <see cref="T:NAnt.Core.Types.FileSet"/> will be copied directly under to the destination
- directory, regardless of the value of the <see cref="P:NAnt.Core.Tasks.CopyTask.Flatten"/>
- attribute.
- </para>
- <h4>Encoding</h4>
- <para>
- Unless an encoding is specified, the encoding associated with the
- system's current ANSI code page is used.
- </para>
- <para>
- 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.
- </para>
- <note>
- If you employ filters in your copy operation, you should limit the copy
- to text files. Binary files will be corrupted by the copy operation.
- </note>
- </remarks>
- <example>
- <para>
- Copy a single file while changing its encoding from "latin1" to
- "utf-8".
- </para>
- <code>
- <![CDATA[
- <copy
- file="myfile.txt"
- tofile="mycopy.txt"
- inputencoding="latin1"
- outputencoding="utf-8" />
- ]]>
- </code>
- </example>
- <example>
- <para>Copy a set of files to a new directory.</para>
- <code>
- <![CDATA[
- <copy todir="${build.dir}">
- <fileset basedir="bin">
- <include name="*.dll" />
- </fileset>
- </copy>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Copy a set of files to a directory, replacing <c>@TITLE@</c> with
- "Foo Bar" in all files.
- </para>
- <code>
- <![CDATA[
- <copy todir="../backup/dir">
- <fileset basedir="src_dir">
- <include name="**/*" />
- </fileset>
- <filterchain>
- <replacetokens>
- <token key="TITLE" value="Foo Bar" />
- </replacetokens>
- </filterchain>
- </copy>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.#ctor">
- <summary>
- Initialize new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.Initialize">
- <summary>
- Checks whether the task is initialized with valid attributes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.ExecuteTask">
- <summary>
- Executes the Copy task.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">A file that has to be copied does not exist or could not be copied.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.DoFileOperations">
- <summary>
- Actually does the file copies.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.SourceFile">
- <summary>
- The file to copy.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.ToFile">
- <summary>
- The file to copy to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.ToDirectory">
- <summary>
- The directory to copy to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.Overwrite">
- <summary>
- Overwrite existing files even if the destination files are newer.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.Flatten">
- <summary>
- Ignore directory structure of source directory, copy all files into
- a single directory, specified by the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
- attribute. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.IncludeEmptyDirs">
- <summary>
- Copy any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
- The default is <see langword="true"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.CopyFileSet">
- <summary>
- Used to select the files to copy. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
- the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/> attribute must be set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.Filters">
- <summary>
- Chain of filters used to alter the file's content as it is copied.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.InputEncoding">
- <summary>
- The encoding to use when reading files. The default is the system's
- current ANSI code page.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.OutputEncoding">
- <summary>
- The encoding to use when writing the files. The default is
- the encoding of the input file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.FileCopyMap">
- <summary>
- The set of files to perform a file operation on.
- </summary>
- <remarks>
- <para>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the absolute path of
- the destination file and the value is a <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
- holding the path and last write time of the most recently updated
- source file that is selected to be copied or moved to the
- destination file.
- </para>
- <para>
- On Windows, the <see cref="T:System.Collections.Hashtable"/> is case-insensitive.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.Core.Tasks.CopyTask.FileDateInfo">
- <summary>
- Holds the absolute paths and last write time of a given file.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.CopyTask.FileDateInfo.#ctor(System.String,System.DateTime)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Tasks.CopyTask.FileDateInfo"/>
- class for the specified file and last write time.
- </summary>
- <param name="path">The absolute path of the file.</param>
- <param name="lastWriteTime">The last write time of the file.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.Path">
- <summary>
- Gets the absolute path of the current file.
- </summary>
- <value>
- The absolute path of the current file.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.CopyTask.FileDateInfo.LastWriteTime">
- <summary>
- Gets the time when the current file was last written to.
- </summary>
- <value>
- The time when the current file was last written to.
- </value>
- </member>
- <member name="T:NAnt.Core.Tasks.DeleteTask">
- <summary>
- Deletes a file, fileset or directory.
- </summary>
- <remarks>
- <para>
- Deletes either a single file, all files in a specified directory and
- its sub-directories, or a set of files specified by one or more filesets.
- </para>
- <para>
- If the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> or <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/> attribute is
- set then the fileset contents will be ignored. To delete the files
- in the fileset ommit the <see cref="P:NAnt.Core.Tasks.DeleteTask.File"/> and <see cref="P:NAnt.Core.Tasks.DeleteTask.Directory"/>
- attributes in the <c><delete></c> element.
- </para>
- <para>
- If the specified file or directory does not exist, no error is
- reported.
- </para>
- <note>
- Read-only files cannot be deleted. Use the <see cref="T:NAnt.Core.Tasks.AttribTask"/>
- first to remove the read-only attribute.
- </note>
- </remarks>
- <example>
- <para>Delete a single file.</para>
- <code>
- <![CDATA[
- <delete file="myfile.txt" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Delete a directory and the contents within. If the directory does not
- exist, no error is reported.
- </para>
- <code>
- <![CDATA[
- <delete dir="${build.dir}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Delete a set of files.
- </para>
- <code>
- <![CDATA[
- <delete>
- <fileset>
- <include name="${basename}-??.exe" />
- <include name="${basename}-??.pdb" />
- </fileset>
- </delete>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.DeleteTask.Initialize">
- <summary>
- Ensures the supplied attributes are valid.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.File">
- <summary>
- The file to delete.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.Directory">
- <summary>
- The directory to delete.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.IncludeEmptyDirs">
- <summary>
- Remove any empty directories included in the <see cref="T:NAnt.Core.Types.FileSet"/>.
- The default is <see langword="true"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.DeleteFileSet">
- <summary>
- All the files in the file set will be deleted.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.DeleteTask.Verbose">
- <summary>
- Controls whether to show the name of each deleted file or directory.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.DescriptionTask">
- <summary>
- An empty task that allows a build file to contain a description.
- </summary>
- <example>
- <para>Set a description.</para>
- <code>
- <![CDATA[
- <description>This is a description.</description>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Tasks.EchoTask">
- <summary>
- Writes a message to the build log or a specified file.
- </summary>
- <remarks>
- <para>
- The message can be specified using the <see cref="P:NAnt.Core.Tasks.EchoTask.Message"/> attribute
- or as inline content.
- </para>
- <para>
- Macros in the message will be expanded.
- </para>
- <para>
- When writing to a file, the <see cref="P:NAnt.Core.Tasks.EchoTask.MessageLevel"/> attribute is
- ignored.
- </para>
- </remarks>
- <example>
- <para>
- Writes a message with level <see cref="F:NAnt.Core.Level.Debug"/> to the build log.
- </para>
- <code>
- <![CDATA[
- <echo message="Hello, World!" level="Debug" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Writes a message with expanded macro to the build log.
- </para>
- <code>
- <![CDATA[
- <echo message="Base build directory = ${nant.project.basedir}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Functionally equivalent to the previous example.
- </para>
- <code>
- <![CDATA[
- <echo>Base build directory = ${nant.project.basedir}</echo>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Writes the previous message to a file in the project directory,
- overwriting the file if it exists.
- </para>
- <code>
- <![CDATA[
- <echo file="buildmessage.txt">Base build directory = ${nant.project.basedir}</echo>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.EchoTask.ExecuteTask">
- <summary>
- Outputs the message to the build log or the specified file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.Message">
- <summary>
- The message to output.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.Contents">
- <summary>
- Gets or sets the inline content that should be output.
- </summary>
- <value>
- The inline content that should be output.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.File">
- <summary>
- The file to write the message to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.Append">
- <summary>
- Determines whether the <see cref="T:NAnt.Core.Tasks.EchoTask"/> should append to the
- file, or overwrite it. By default, the file will be overwritten.
- </summary>
- <value>
- <see langword="true"/> if output should be appended to the file;
- otherwise, <see langword="false"/>. The default is
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.EchoTask.MessageLevel">
- <summary>
- The logging level with which the message should be output. The default
- is <see cref="F:NAnt.Core.Level.Info"/>.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.ExecTask">
- <summary>
- Executes a system command.
- </summary>
- <remarks>
- <para>
- Use of nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> element(s)
- is advised over the <see cref="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments"/> parameter, as
- it supports automatic quoting and can resolve relative to absolute
- paths.
- </para>
- </remarks>
- <example>
- <para>Ping "nant.sourceforge.net".</para>
- <code>
- <![CDATA[
- <exec program="ping">
- <arg value="nant.sourceforge.net" />
- </exec>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Execute a java application using <c>IKVM.NET</c> that requires the
- Apache FOP jars, and a set of custom jars.
- </para>
- <code>
- <![CDATA[
- <path id="fop-classpath">
- <pathelement file="${fop.dist.dir}/build/fop.jar" />
- <pathelement file="${fop.dist.dir}/lib/xercesImpl-2.2.1.jar" />
- <pathelement file="${fop.dist.dir}/lib/avalon-framework-cvs-20020806.jar" />
- <pathelement file="${fop.dist.dir}/lib/batik.jar" />
- </path>
- <exec program="ikvm.exe" useruntimeengine="true">
- <arg value="-cp" />
- <arg>
- <path>
- <pathelement dir="conf" />
- <path refid="fop-classpath" />
- <pathelement file="lib/mylib.jar" />
- <pathelement file="lib/otherlib.zip" />
- </path>
- </arg>
- <arg value="org.me.MyProg" />
- </exec>
- ]]>
- </code>
- <para>
- Assuming the base directory of the build file is "c:\ikvm-test" and
- the value of the "fop.dist.dir" property is "c:\fop", then the value
- of the <c>-cp</c> argument that is passed to<c>ikvm.exe</c> is
- "c:\ikvm-test\conf;c:\fop\build\fop.jar;conf;c:\fop\lib\xercesImpl-2.2.1.jar;c:\fop\lib\avalon-framework-cvs-20020806.jar;c:\fop\lib\batik.jar;c:\ikvm-test\lib\mylib.jar;c:\ikvm-test\lib\otherlib.zip"
- on a DOS-based system.
- </para>
- </example>
- </member>
- <member name="T:NAnt.Core.Tasks.ExternalProgramBase">
- <summary>
- Provides the abstract base class for tasks that execute external applications.
- </summary>
- <remarks>
- <para>
- When a <see cref="T:NAnt.Core.Attributes.ProgramLocationAttribute"/> is applied to the
- deriving class and <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName"/> does not return an
- absolute path, then the program to execute will first be searched for
- in the location specified by <see cref="P:NAnt.Core.Attributes.ProgramLocationAttribute.LocationType"/>.
- </para>
- <para>
- If the program does not exist in that location, then the list of tool
- paths of the current target framework will be scanned in the order in
- which they are defined in the NAnt configuration file.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Core.Tasks.ExternalProgramBase.UnknownExitCode">
- <summary>
- Defines the exit code that will be returned by <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode"/>
- if the process could not be started, or did not exit (in time).
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.ExternalProgramBase._lockObject">
- <summary>
- Will be used to ensure thread-safe operations.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.ExecuteTask">
- <summary>
- Starts the external process and captures its output.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The external process did not finish within the configured timeout.</para>
- <para>-or-</para>
- <para>The exit code of the external process indicates a failure.</para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
- <see cref="T:System.Diagnostics.Process"/>.
- </summary>
- <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StartProcess">
- <summary>
- Starts the process and handles errors.
- </summary>
- <returns>The <see cref="T:System.Diagnostics.Process"/> that was started.</returns>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Output">
- <summary>
- Reads from the stream until the external program is ended.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.StreamReaderThread_Error">
- <summary>
- Reads from the stream until the external program is ended.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.ExternalProgramBase.DetermineFilePath">
- <summary>
- Determines the path of the external program that should be executed.
- </summary>
- <returns>
- A fully qualifies pathname including the program name.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">The task is not available or not configured for the current framework.</exception>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExeName">
- <summary>
- The name of the executable that should be used to launch the
- external program.
- </summary>
- <value>
- The name of the executable that should be used to launch the external
- program, or <see langword="null" /> if no name is specified.
- </value>
- <remarks>
- If available, the configured value in the NAnt configuration
- file will be used if no name is specified.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- <remarks>
- Override in derived classes to explicitly set the location of the
- external tool.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Output">
- <summary>
- Gets the file to which the standard output should be redirected.
- </summary>
- <value>
- The file to which the standard output should be redirected, or
- <see langword="null" /> if the standard output should not be
- redirected.
- </value>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputAppend">
- <summary>
- Gets a value indicating whether output will be appended to the
- <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>.
- </summary>
- <value>
- <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Output"/>;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.BaseDirectory">
- <summary>
- Gets the working directory for the application.
- </summary>
- <value>
- The working directory for the application.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.TimeOut">
- <summary>
- The maximum amount of time the application is allowed to execute,
- expressed in milliseconds. Defaults to no time-out.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments">
- <summary>
- The command-line arguments for the external program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.UseRuntimeEngine">
- <summary>
- Specifies whether the external program is a managed application
- which should be executed using a runtime engine, if configured.
- The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the external program should be executed
- using a runtime engine; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Managed">
- <summary>
- Specifies whether the external program is a managed application
- which should be executed using a runtime engine, if configured.
- The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the external program should be executed
- using a runtime engine; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which standard output
- messages of the external program will be written.
- </summary>
- <value>
- The <see cref="T:System.IO.TextWriter"/> to which standard output messages of
- the external program will be written.
- </value>
- <remarks>
- By default, standard output messages wil be written to the build log
- with level <see cref="F:NAnt.Core.Level.Info"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ErrorWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which error output
- of the external program will be written.
- </summary>
- <value>
- The <see cref="T:System.IO.TextWriter"/> to which error output of the external
- program will be written.
- </value>
- <remarks>
- By default, error output wil be written to the build log with level
- <see cref="F:NAnt.Core.Level.Warning"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ExitCode">
- <summary>
- Gets the value that the process specified when it terminated.
- </summary>
- <value>
- The code that the associated process specified when it terminated,
- or <c>-1000</c> if the process could not be started or did not
- exit (in time).
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.ProcessId">
- <summary>
- Gets the unique identifier for the spawned application.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.Spawn">
- <summary>
- 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 <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExternalProgramBase.CommandLine">
- <summary>
- Gets the command-line arguments, separated by spaces.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.ExecTask.Initialize">
- <summary>
- Performs additional checks after the task has been initialized.
- </summary>
- <exception cref="T:NAnt.Core.BuildException"><see cref="P:NAnt.Core.Tasks.ExecTask.FileName"/> does not hold a valid file name.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.ExecTask.ExecuteTask">
- <summary>
- Executes the external program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.FileName">
- <summary>
- The program to execute without command arguments.
- </summary>
- <remarks>
- The path will not be evaluated to a full path using the project
- base directory.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.CommandLineArguments">
- <summary>
- The command-line arguments for the program. These will be
- passed as is to the external program. When quoting is necessary,
- these must be explictly set as part of the value. Consider using
- nested <see cref="P:NAnt.Core.Tasks.ExternalProgramBase.Arguments"/> elements instead.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet">
- <summary>
- Environment variables to pass to the program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.WorkingDirectory">
- <summary>
- The directory in which the command will be executed.
- </summary>
- <value>
- The directory in which the command will be executed. The default
- is the project's base directory.
- </value>
- <remarks>
- <para>
- The working directory will be evaluated relative to the project's
- base directory if it is relative.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.ResultProperty">
- <summary>
- <para>
- The name of a property in which the exit code of the program should
- be stored. Only of interest if <see cref="P:NAnt.Core.Task.FailOnError"/> is
- <see langword="false"/>.
- </para>
- <para>
- If the exit code of the program is "-1000" then the program could
- not be started, or did not exit (in time).
- </para>
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.UseRuntimeEngine">
- <summary>
- Specifies whether the external program should be executed using a
- runtime engine, if configured. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the external program should be executed
- using a runtime engine; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.Managed">
- <summary>
- Specifies whether the external program is a managed application
- which should be executed using a runtime engine, if configured.
- The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the external program should be executed
- using a runtime engine; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.BaseDirectory">
- <summary>
- The directory the program is in.
- </summary>
- <remarks>
- <value>
- The directory the program is in. The default is the project's base
- directory.
- </value>
- <para>
- The basedir will be evaluated relative to the project's base
- directory if it is relative.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.Output">
- <summary>
- The file to which the standard output will be redirected.
- </summary>
- <remarks>
- By default, the standard output is redirected to the console.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.OutputAppend">
- <summary>
- Gets or sets a value indicating whether output should be appended
- to the output file. The default is <see langword="false"/>.
- </summary>
- <value>
- <see langword="true"/> if output should be appended to the <see cref="P:NAnt.Core.Tasks.ExecTask.Output"/>;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.Spawn">
- <summary>
- 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 <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.ExecTask.ProcessIdProperty">
- <summary>
- The name of a property in which the unique identifier of the spawned
- application should be stored. Only of interest if <see cref="P:NAnt.Core.Tasks.ExecTask.Spawn"/>
- is <see langword="true"/>.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.FailTask">
- <summary>
- Exits the current build by throwing a <see cref="T:NAnt.Core.BuildException"/>,
- optionally printing additional information.
- </summary>
- <remarks>
- <para>
- The cause of the build failure can be specified using the <see cref="P:NAnt.Core.Tasks.FailTask.Message"/>
- attribute or as inline content.
- </para>
- <para>
- Macros in the message will be expanded.
- </para>
- </remarks>
- <example>
- <para>Exits the current build without giving further information.</para>
- <code>
- <![CDATA[
- <fail />
- ]]>
- </code>
- </example>
- <example>
- <para>Exits the current build and writes a message to the build log.</para>
- <code>
- <![CDATA[
- <fail message="Something wrong here." />
- ]]>
- </code>
- </example>
- <example>
- <para>Functionally equivalent to the previous example.</para>
- <code>
- <![CDATA[
- <fail>Something wrong here.</fail>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.FailTask.Message">
- <summary>
- A message giving further information on why the build exited.
- </summary>
- <remarks>
- Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.FailTask.Contents">
- <summary>
- Gets or sets the inline content that should be output in the build
- log, giving further information on why the build exited.
- </summary>
- <value>
- The inline content that should be output in the build log.
- </value>
- <remarks>
- Inline content and <see cref="P:NAnt.Core.Tasks.FailTask.Message"/> are mutually exclusive.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Tasks.GetTask">
- <summary>
- Gets a particular file from a URL source.
- </summary>
- <remarks>
- <para>
- Options include verbose reporting and timestamp based fetches.
- </para>
- <para>
- Currently, only HTTP and UNC protocols are supported. FTP support may
- be added when more pluggable protocols are added to the System.Net
- assembly.
- </para>
- <para>
- The <see cref="P:NAnt.Core.Tasks.GetTask.UseTimeStamp"/> option enables you to control downloads
- so that the remote file is only fetched if newer than the local copy.
- If there is no local copy, the download always takes place. When a file
- is downloaded, the timestamp of the downloaded file is set to the remote
- timestamp.
- </para>
- <note>
- This timestamp facility only works on downloads using the HTTP protocol.
- </note>
- </remarks>
- <example>
- <para>
- Gets the index page of the NAnt home page, and stores it in the file
- <c>help/index.html</c> relative to the project base directory.
- </para>
- <code>
- <![CDATA[
- <get src="http://nant.sourceforge.org/" dest="help/index.html" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Gets the index page of a secured web site using the given credentials,
- while connecting using the specified password-protected proxy server.
- </para>
- <code>
- <![CDATA[
- <get src="http://password.protected.site/index.html" dest="secure/index.html">
- <credentials username="user" password="guess" domain="mydomain" />
- <proxy host="proxy.company.com" port="8080">
- <credentials username="proxyuser" password="dunno" />
- </proxy>
- </get>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.GetTask.Initialize">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.GetTask.ExecuteTask">
- <summary>
- This is where the work is done
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.GetTask.TouchFile(System.IO.FileInfo,System.DateTime)">
- <summary>
- Sets the timestamp of a given file to a specified time.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Source">
- <summary>
- The URL from which to retrieve a file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.DestinationFile">
- <summary>
- The file where to store the retrieved file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.HttpProxy">
- <summary>
- If inside a firewall, proxy server/port information
- Format: {proxy server name}:{port number}
- Example: proxy.mycompany.com:8080
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Proxy">
- <summary>
- The network proxy to use to access the Internet resource.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Credentials">
- <summary>
- The network credentials used for authenticating the request with
- the Internet resource.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.IgnoreErrors">
- <summary>
- Log errors but don't treat as fatal. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.UseTimeStamp">
- <summary>
- Conditionally download a file based on the timestamp of the local
- copy. HTTP only. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Timeout">
- <summary>
- The length of time, in milliseconds, until the request times out.
- The default is <c>100000</c> milliseconds.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.GetTask.Certificates">
- <summary>
- The security certificates to associate with the request.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.IfTask">
- <summary>
- Checks the conditional attributes and executes the children if
- <see langword="true"/>.
- </summary>
- <remarks>
- <para>
- If no conditions are checked, all child tasks are executed.
- </para>
- <para>
- If more than one attribute is used, they are &&'d. The first
- to fail stops the check.
- </para>
- <para>
- The order of condition evaluation is, <see cref="P:NAnt.Core.Tasks.IfTask.TargetNameExists"/>,
- <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameExists"/>, <see cref="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue"/>,
- <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>.
- </para>
- <note>
- instead of using the deprecated attributes, we advise you to use the
- following functions in combination with the <see cref="P:NAnt.Core.Tasks.IfTask.Test"/>
- attribute:
- </note>
- <list type="table">
- <listheader>
- <term>Function</term>
- <description>Description</description>
- </listheader>
- <item>
- <term><see cref="M:NAnt.Core.Functions.PropertyFunctions.Exists(System.String)"/></term>
- <description>Checks whether the specified property exists.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.TargetFunctions.Exists(System.String)"/></term>
- <description>Checks whether the specified target exists.</description>
- </item>
- </list>
- </remarks>
- <example>
- <para>Tests the value of a property using expressions.</para>
- <code>
- <![CDATA[
- <if test="${build.configuration=='release'}">
- <echo>Build release configuration</echo>
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>Tests the the output of a function.</para>
- <code>
- <![CDATA[
- <if test="${not file::exists(filename) or file::get-length(filename) = 0}">
- <echo message="The version file ${filename} doesn't exist or is empty!" />
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para><c>(Deprecated)</c> Check that a target exists.</para>
- <code>
- <![CDATA[
- <target name="myTarget" />
- <if targetexists="myTarget">
- <echo message="myTarget exists" />
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para><c>(Deprecated)</c> Check existence of a property.</para>
- <code>
- <![CDATA[
- <if propertyexists="myProp">
- <echo message="myProp Exists. Value='${myProp}'" />
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para><c>(Deprecated)</c> Check that a property value is true.</para>
- <code>
- <![CDATA[
- <if propertytrue="myProp">
- <echo message="myProp is true. Value='${myProp}'" />
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>
- <c>(Deprecated)</c> Check that a property exists and is <see langword="true"/>
- (uses multiple conditions).
- </para>
- <code>
- <![CDATA[
- <if propertyexists="myProp" propertytrue="myProp">
- <echo message="myProp is '${myProp}'" />
- </if>
- ]]>
- </code>
- <para>which is the same as</para>
- <code>
- <![CDATA[
- <if propertyexists="myProp">
- <if propertytrue="myProp">
- <echo message="myProp is '${myProp}'" />
- </if>
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>
- <c>(Deprecated)</c> Check file dates. If <c>myfile.dll</c> is uptodate,
- then do stuff.
- </para>
- <code>
- <![CDATA[
- <if uptodatefile="myfile.dll" comparefile="myfile.cs">
- <echo message="myfile.dll is newer/same-date as myfile.cs" />
- </if>
- ]]>
- </code>
- <para>or</para>
- <code>
- <![CDATA[
- <if uptodatefile="myfile.dll">
- <comparefiles>
- <include name="*.cs" />
- </comparefiles>
- <echo message="myfile.dll is newer/same-date as myfile.cs" />
- </if>
- ]]>
- </code>
- <para>or</para>
- <code>
- <![CDATA[
- <if>
- <uptodatefiles>
- <include name="myfile.dll" />
- </uptodatefiles>
- <comparefiles>
- <include name="*.cs" />
- </comparefiles>
- <echo message="myfile.dll is newer/same-date as myfile.cs" />
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.TaskContainer">
- <summary>
- Executes embedded tasks in the order in which they are defined.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskContainer.Initialize">
- <summary>
- Automatically exclude build elements that are defined on the task
- from things that get executed, as they are evaluated normally during
- XML task initialization.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskContainer.ExecuteChildTasks">
- <summary>
- Creates and executes the embedded (child XML nodes) elements.
- </summary>
- <remarks>
- Skips any element defined by the host <see cref="T:NAnt.Core.Task"/> that has
- a <see cref="T:NAnt.Core.Attributes.BuildElementAttribute"/> defined.
- </remarks>
- </member>
- <member name="P:NAnt.Core.TaskContainer.CustomXmlProcessing">
- <summary>
- Gets a value indicating whether the element is performing additional
- processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
- initialize the element.
- </summary>
- <value>
- <see langword="true"/>, as a <see cref="T:NAnt.Core.TaskContainer"/> is
- responsable for creating tasks from the nested build elements.
- </value>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFile">
- <summary>
- The file to compare if uptodate.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.CompareFile">
- <summary>
- The file to check against for the uptodate file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.CompareFiles">
- <summary>
- The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the comparison files for
- the <see cref="P:NAnt.Core.Tasks.IfTask.UpToDateFile"/>(s) check.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.UpToDateFiles">
- <summary>
- The <see cref="T:NAnt.Core.Types.FileSet"/> that contains the uptodate files for
- the <see cref="P:NAnt.Core.Tasks.IfTask.CompareFile"/>(s) check.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameTrue">
- <summary>
- Used to test whether a property is true.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.PropertyNameExists">
- <summary>
- Used to test whether a property exists.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.TargetNameExists">
- <summary>
- Used to test whether a target exists.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IfTask.Test">
- <summary>
- Used to test arbitrary boolean expression.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.IfNotTask">
- <summary>
- The opposite of the <c>if</c> task.
- </summary>
- <example>
- <para>Check that a property does not exist.</para>
- <code>
- <![CDATA[
- <ifnot propertyexists="myProp">
- <echo message="myProp does not exist."/>
- </if>
- ]]>
- </code>
- <para>Check that a property value is not true.</para>
- <code>
- <![CDATA[
- <ifnot propertytrue="myProp">
- <echo message="myProp is not true."/>
- </if>
- ]]>
- </code>
- </example>
- <example>
- <para>Check that a target does not exist.</para>
- <code>
- <![CDATA[
- <ifnot targetexists="myTarget">
- <echo message="myTarget does not exist."/>
- </if>
- ]]>
- </code>
- </example>
- </member>
- <member name="T:NAnt.Core.Tasks.IncludeTask">
- <summary>
- Includes an external build file.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- <note>
- 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.
- </note>
- <note>
- The project element attributes are ignored.
- </note>
- <note>
- This task can only be in the global (project level) section of the
- build file.
- </note>
- <note>
- This task can only include files from the file system.
- </note>
- </remarks>
- <example>
- <para>
- Include a task that fetches the project version from the
- <c>GetProjectVersion.include</c> build file.
- </para>
- <code>
- <![CDATA[
- <include buildfile="GetProjectVersion.include" />
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Core.Tasks.IncludeTask._includedFileNames">
- <summary>
- Used to check for recursived includes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.IncludeTask.Initialize">
- <summary>
- Verifies parameters.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.IncludeTask.BuildFileName">
- <summary>
- Build file to include.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.LoadFileTask">
- <summary>
- Load a text file into a single property.
- </summary>
- <remarks>
- <para>
- Unless an encoding is specified, the encoding associated with the
- system's current ANSI code page is used.
- </para>
- <para>
- 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.
- </para>
- </remarks>
- <example>
- <para>
- Load file <c>message.txt</c> into property "message".
- </para>
- <code>
- <![CDATA[
- <loadfile
- file="message.txt"
- property="message" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Load a file using the "latin-1" encoding.
- </para>
- <code>
- <![CDATA[
- <loadfile
- file="loadfile.xml"
- property="encoded-file"
- encoding="iso-8859-1" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Load a file, replacing all <c>@NOW@</c> tokens with the current
- date/time.
- </para>
- <code>
- <![CDATA[
- <loadfile file="token.txt" property="token-file">
- <filterchain>
- <replacetokens>
- <token key="NOW" value="${datetime::now()}" />
- </replacetokens>
- </filterchain>
- </loadfile>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadFileTask.File">
- <summary>
- The file to load.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadFileTask.Property">
- <summary>
- The name of the property to save the content to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadFileTask.Encoding">
- <summary>
- The encoding to use when loading the file. The default is the encoding
- associated with the system's current ANSI code page.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadFileTask.FilterChain">
- <summary>
- The filterchain definition to use.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.LoadTasksTask">
- <summary>
- Loads tasks form a given assembly or all assemblies in a given directory
- or <see cref="T:NAnt.Core.Types.FileSet"/>.
- </summary>
- <example>
- <para>
- Load tasks from a single assembly.
- </para>
- <code>
- <![CDATA[
- <loadtasks assembly="c:foo\NAnt.Contrib.Tasks.dll" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Scan a single directory for task assemblies.
- </para>
- <code>
- <![CDATA[
- <loadtasks path="c:\foo" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Use a <see cref="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet"/> containing both a directory and an
- assembly.
- </para>
- <code>
- <![CDATA[
- <loadtasks>
- <fileset>
- <include name="C:\cvs\NAntContrib\build" />
- <include name="C:\cvs\NAntContrib\build\NAnt.Contrib.Tasks.dll" />
- </fileset>
- </loadtasks>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.LoadTasksTask.ExecuteTask">
- <summary>
- Executes the Load Tasks task.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">Specified assembly or path does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Tasks.LoadTasksTask.Initialize">
- <summary>
- Validates the attributes.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">Both <see cref="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath"/> and <see cref="P:NAnt.Core.Tasks.LoadTasksTask.Path"/> are set.</exception>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadTasksTask.AssemblyPath">
- <summary>
- An assembly to load tasks from.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadTasksTask.Path">
- <summary>
- A directory to scan for task assemblies.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoadTasksTask.TaskFileSet">
- <summary>
- Used to select which directories or individual assemblies to scan.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.LoopTask">
- <summary>
- Loops over a set of items.
- </summary>
- <remarks>
- <para>
- Can loop over files in directory, lines in a file, etc.
- </para>
- <para>
- The property value is stored before the loop is done, and restored
- when the loop is finished.
- </para>
- <para>
- The property is returned to its normal value once it is used. Read-only
- parameters cannot be overridden in this loop.
- </para>
- </remarks>
- <example>
- <para>Loops over the files in <c>c:\</c>.</para>
- <code>
- <![CDATA[
- <foreach item="File" in="c:\" property="filename">
- <echo message="${filename}" />
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>Loops over all files in the project directory.</para>
- <code>
- <![CDATA[
- <foreach item="File" property="filename">
- <in>
- <items>
- <include name="**" />
- </items>
- </in>
- <do>
- <echo message="${filename}" />
- </do>
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>Loops over the folders in <c>c:\</c>.</para>
- <code>
- <![CDATA[
- <foreach item="Folder" in="c:\" property="foldername">
- <echo message="${foldername}" />
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>Loops over all folders in the project directory.</para>
- <code>
- <![CDATA[
- <foreach item="Folder" property="foldername">
- <in>
- <items>
- <include name="**" />
- </items>
- </in>
- <do>
- <echo message="${foldername}" />
- </do>
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>Loops over a list.</para>
- <code>
- <![CDATA[
- <foreach item="String" in="1 2,3" delim=" ," property="count">
- <echo message="${count}" />
- </foreach>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Loops over lines in the file <c>properties.csv</c>, where each line
- is of the format name,value.
- </para>
- <code>
- <![CDATA[
- <foreach item="Line" in="properties.csv" delim="," property="x,y">
- <echo message="Read pair ${x}=${y}" />
- </foreach>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.Property">
- <summary>
- The NAnt property name(s) that should be used for the current
- iterated item.
- </summary>
- <remarks>
- If specifying multiple properties, separate them with a comma.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.ItemType">
- <summary>
- The type of iteration that should be done.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.TrimType">
- <summary>
- The type of whitespace trimming that should be done. The default
- is <see cref="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.Source">
- <summary>
- The source of the iteration.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.Delimiter">
- <summary>
- The deliminator char.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.InElement">
- <summary>
- Stuff to operate in. Just like the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/>
- attribute, but supports more complicated things like a <see cref="T:NAnt.Core.Types.FileSet"/>
- and such.
- <note>
- Please remove the <see cref="P:NAnt.Core.Tasks.LoopTask.Source"/> attribute if you
- are using this element.
- </note>
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.LoopTask.StuffToDo">
- <summary>
- Tasks to execute for each matching item.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.None">
- <summary>
- Do not remove any white space characters.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.End">
- <summary>
- Remove all white space characters from the end of the current
- item.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Start">
- <summary>
- Remove all white space characters from the beginning of the
- current item.
- </summary>
- </member>
- <member name="F:NAnt.Core.Tasks.LoopTask.LoopTrim.Both">
- <summary>
- Remove all white space characters from the beginning and end of
- the current item.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.MailTask">
- <summary>
- Sends an SMTP message.
- </summary>
- <remarks>
- <para>
- Text and text files to include in the message body may be specified as
- well as binary attachments.
- </para>
- </remarks>
- <example>
- <para>
- Sends an email from <c>nant@sourceforge.net</c> to three recipients
- with a subject about the attachments. The body of the message will be
- the combined contents of all <c>.txt</c> files in the base directory.
- All zip files in the base directory will be included as attachments.
- The message will be sent using the <c>smtpserver.anywhere.com</c> SMTP
- server.
- </para>
- <code>
- <![CDATA[
- <mail
- from="nant@sourceforge.net"
- tolist="recipient1@sourceforge.net"
- cclist="recipient2@sourceforge.net"
- bcclist="recipient3@sourceforge.net"
- subject="Msg 7: With attachments"
- mailhost="smtpserver.anywhere.com">
- <files>
- <include name="*.txt" />
- </files>
- <attachments>
- <include name="*.zip" />
- </attachments>
- </mail>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.MailTask.Initialize">
- <summary>
- Initializes task and ensures the supplied attributes are valid.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.MailTask.ExecuteTask">
- <summary>
- This is where the work is done.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.MailTask.ReadFile(System.String)">
- <summary>
- Reads a text file and returns the content
- in a string.
- </summary>
- <param name="filename">The file to read content of.</param>
- <returns>
- The content of the specified file.
- </returns>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.From">
- <summary>
- Email address of sender.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.ToList">
- <summary>
- Semicolon-separated list of recipient email addresses.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.CcList">
- <summary>
- Semicolon-separated list of CC: recipient email addresses.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.BccList">
- <summary>
- Semicolon-separated list of BCC: recipient email addresses.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Mailhost">
- <summary>
- Host name of mail server. The default is <c>localhost</c>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Message">
- <summary>
- Text to send in body of email message.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Subject">
- <summary>
- Text to send in subject line of email message.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Format">
- <summary>
- Format of the message. The default is <see cref="F:System.Web.Mail.MailFormat.Text"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Files">
- <summary>
- Files that are transmitted as part of the body of the email message.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MailTask.Attachments">
- <summary>
- Attachments that are transmitted with the message.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.MkDirTask">
- <summary>
- Creates a directory and any non-existent parent directory if necessary.
- </summary>
- <example>
- <para>Create the directory <c>build</c>.</para>
- <code>
- <![CDATA[
- <mkdir dir="build" />
- ]]>
- </code>
- </example>
- <example>
- <para>Create the directory tree <c>one/two/three</c>.</para>
- <code>
- <![CDATA[
- <mkdir dir="one/two/three" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.MkDirTask.ExecuteTask">
- <summary>
- Creates the directory specified by the <see cref="P:NAnt.Core.Tasks.MkDirTask.Dir"/> property.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">The directory could not be created.</exception>
- </member>
- <member name="P:NAnt.Core.Tasks.MkDirTask.Dir">
- <summary>
- The directory to create.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.MoveTask">
- <summary>
- Moves a file or set of files to a new file or directory.
- </summary>
- <remarks>
- <para>
- Files are only moved if the source file is newer than the destination
- file, or if the destination file does not exist. However, you can
- explicitly overwrite files with the <see cref="P:NAnt.Core.Tasks.CopyTask.Overwrite"/>
- attribute.
- </para>
- <para>
- A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to move. To use
- a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.Core.Tasks.CopyTask.ToDirectory"/>
- attribute must be set.
- </para>
- <h3>Encoding</h3>
- <para>
- Unless an encoding is specified, the encoding associated with the
- system's current ANSI code page is used.
- </para>
- <para>
- 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.
- </para>
- <note>
- If you employ filters in your move operation, you should limit the
- move to text files. Binary files will be corrupted by the move
- operation.
- </note>
- </remarks>
- <example>
- <para>
- Move a single file while changing its encoding from "latin1" to
- "utf-8".
- </para>
- <code>
- <![CDATA[
- <move
- file="myfile.txt"
- tofile="mycopy.txt"
- inputencoding="latin1"
- outputencoding="utf-8" />
- ]]>
- </code>
- </example>
- <example>
- <para>Move a set of files.</para>
- <code>
- <![CDATA[
- <move todir="${build.dir}">
- <fileset basedir="bin">
- <include name="*.dll" />
- </fileset>
- </move>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Move a set of files to a directory, replacing <c>@TITLE@</c> with
- "Foo Bar" in all files.
- </para>
- <code>
- <![CDATA[
- <move todir="../backup/dir">
- <fileset basedir="src_dir">
- <include name="**/*" />
- </fileset>
- <filterchain>
- <replacetokens>
- <token key="TITLE" value="Foo Bar" />
- </replacetokens>
- </filterchain>
- </move>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.MoveTask.DoFileOperations">
- <summary>
- Actually does the file moves.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.SourceFile">
- <summary>
- The file to move.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.ToFile">
- <summary>
- The file to move to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.ToDirectory">
- <summary>
- The directory to move to.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.CopyFileSet">
- <summary>
- Used to select the files to move. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
- the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/> attribute must be set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.Flatten">
- <summary>
- Ignore directory structure of source directory, move all files into
- a single directory, specified by the <see cref="P:NAnt.Core.Tasks.MoveTask.ToDirectory"/>
- attribute. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.MoveTask.Filters">
- <summary>
- Chain of filters used to alter the file's content as it is moved.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.NAntSchemaTask">
- <summary>
- Creates an XSD File for all available tasks.
- </summary>
- <remarks>
- <para>
- This can be used in conjuntion with the command-line option to do XSD
- Schema validation on the build file.
- </para>
- </remarks>
- <example>
- <para>Creates a <c>NAnt.xsd</c> file in the current project directory.</para>
- <code>
- <![CDATA[
- <nantschema output="NAnt.xsd" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntSchemaTask.WriteSchema(System.IO.Stream,System.Type[],System.Type[],System.String)">
- <summary>
- Creates a NAnt Schema for given types
- </summary>
- <param name="stream">The output stream to save the schema to. If <see langword="null" />, writing is ignored, no exception generated.</param>
- <param name="tasks">The list of tasks to generate XML Schema for.</param>
- <param name="dataTypes">The list of datatypes to generate XML Schema for.</param>
- <param name="targetNS">The target namespace to output.</param>
- <returns>The new NAnt Schema.</returns>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdAttribute(System.String,System.Boolean)">
- <summary>
- Creates a new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.
- </summary>
- <param name="name">The name of the attribute.</param>
- <param name="required">Value indicating whether the attribute should be required.</param>
- <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaAttribute"/> instance.</returns>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntSchemaTask.CreateXsdSequence(System.Decimal,System.Decimal)">
- <summary>
- Creates a new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.
- </summary>
- <param name="min">The minimum value to allow for this choice</param>
- <param name="max">The maximum value to allow, Decimal.MaxValue sets it to 'unbound'</param>
- <returns>The new <see cref="T:System.Xml.Schema.XmlSchemaSequence"/> instance.</returns>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntSchemaTask.OutputFile">
- <summary>
- The name of the output file to which the XSD should be written.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntSchemaTask.TargetNamespace">
- <summary>
- The target namespace for the output. Defaults to "http://tempuri.org/nant-donotuse.xsd"
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntSchemaTask.ForType">
- <summary>
- The <see cref="T:System.Type"/> for which an XSD should be created. If not
- specified, an XSD will be created for all available tasks.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator.#ctor(System.Type[],System.Type[],System.String)">
- <summary>
- Creates a new instance of the <see cref="T:NAnt.Core.Tasks.NAntSchemaTask.NAntSchemaGenerator"/>
- class.
- </summary>
- <param name="tasks">Tasks for which a schema should be generated.</param>
- <param name="dataTypes">Data Types for which a schema should be generated.</param>
- <param name="targetNS">The namespace to use.
- <example> http://tempuri.org/nant.xsd </example>
- </param>
- </member>
- <member name="T:NAnt.Core.Tasks.NAntTask">
- <summary>
- Runs NAnt on a supplied build file, or a set of build files.
- </summary>
- <remarks>
- <para>
- By default, all the properties of the current project will be available
- in the new project. Alternatively, you can set <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>
- to <see langword="false"/> to not copy any properties to the new
- project.
- </para>
- <para>
- You can also set properties in the new project from the old project by
- using nested property tags. These properties are always passed to the
- new project regardless of the setting of <see cref="P:NAnt.Core.Tasks.NAntTask.InheritAll"/>.
- This allows you to parameterize your subprojects.
- </para>
- <para>
- References to data types can also be passed to the new project, but by
- default they are not. If you set the <see cref="P:NAnt.Core.Tasks.NAntTask.InheritRefs"/> to
- <see langword="true"/>, all references will be copied.
- </para>
- </remarks>
- <example>
- <para>
- Build a project located in a different directory if the <c>debug</c>
- property is not <see langword="true"/>.
- </para>
- <code>
- <![CDATA[
- <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build" unless="${debug}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Build a project while adding a set of properties to that project.
- </para>
- <code>
- <![CDATA[
- <nant buildfile="${src.dir}/Extras/BuildServer/BuildServer.build">
- <properties>
- <property name="build.dir" value="c:/buildserver" />
- <property name="build.debug" value="false" />
- <property name="lib.dir" value="c:/shared/lib" readonly="true" />
- </properties>
- </nant>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Build all projects named <c>default.build</c> located anywhere under
- the project base directory.
- </para>
- <code>
- <![CDATA[
- <nant>
- <buildfiles>
- <include name="**/default.build" />
- <!-- avoid recursive execution of current build file -->
- <exclude name="${project::get-buildfile-path()}" />
- </buildfiles>
- </nant>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.NAntTask.Initialize">
- <summary>
- Validates the <see cref="T:NAnt.Core.Tasks.NAntTask"/> element.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.BuildFile">
- <summary>
- The build file to build.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.DefaultTarget">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.BuildFiles">
- <summary>
- Used to specify a set of build files to process.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.InheritAll">
- <summary>
- Specifies whether current property values should be inherited by
- the executed project. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.InheritRefs">
- <summary>
- Specifies whether all references will be copied to the new project.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.NAntTask.OverrideProperties">
- <summary>
- 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.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.PropertyTask">
- <summary>
- Sets a property in the current project.
- </summary>
- <remarks>
- <note>NAnt uses a number of predefined properties.</note>
- </remarks>
- <example>
- <para>
- Define a <c>debug</c> property with value <see langword="true" />.
- </para>
- <code>
- <![CDATA[
- <property name="debug" value="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Use the user-defined <c>debug</c> property.
- </para>
- <code>
- <![CDATA[
- <property name="trace" value="${debug}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Define a read-only property. This is just like passing in the param
- on the command line.
- </para>
- <code>
- <![CDATA[
- <property name="do_not_touch_ME" value="hammer" readonly="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Define a property, but do not overwrite the value if the property already exists (eg. it was specified on the command line).
- </para>
- <code>
- <![CDATA[
- <project name="property-example">
- <property name="debug" value="true" overwrite="false" />
- <echo message="debug: ${debug}" />
- </project>
- ]]>
- </code>
- <para>
- Executing this build file with the command line option <c>-D:debug=false</c>,
- would cause the value specified on the command line to remain unaltered.
- </para>
- <code>
- <![CDATA[
- [echo] debug: false
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.PropertyName">
- <summary>
- The name of the NAnt property to set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.Value">
- <summary>
- The value to assign to the NAnt property.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.ReadOnly">
- <summary>
- Specifies whether the property is read-only or not.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.Dynamic">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.PropertyTask.Overwrite">
- <summary>
- Specifies whether the value of a property should be overwritten if
- the property already exists (unless the property is read-only).
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.RegexTask">
- <summary>
- Sets project properties based on the evaluatuion of a regular expression.
- </summary>
- <remarks>
- <para>
- The <see cref="P:NAnt.Core.Tasks.RegexTask.Pattern"/> attribute must contain one or more
- <see href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpgenref/html/cpcongroupingconstructs.asp">
- named grouping constructs</see>, which represents the names of the
- properties to be set. These named grouping constructs can be enclosed
- by angle brackets (?<name>) or single quotes (?'name').
- </para>
- <note>
- In the build file, use the XML element <![CDATA[<]]> to specify <,
- and <![CDATA[>]]> to specify >.
- </note>
- <note>
- The named grouping construct must not contain any punctuation and it
- cannot begin with a number.
- </note>
- </remarks>
- <example>
- <para>
- Find the last word in the given string and stores it in the property
- <c>lastword</c>.
- </para>
- <code>
- <![CDATA[
- <regex pattern="(?'lastword'\w+)$" input="This is a test sentence" />
- <echo message="${lastword}" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Split the full filename and extension of a filename.
- </para>
- <code>
- <![CDATA[
- <regex pattern="^(?'filename'.*)\.(?'extension'\w+)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Split the path and the filename. (This checks for <c>/</c> or <c>\</c>
- as the path separator).
- </para>
- <code>
- <![CDATA[
- <regex pattern="^(?'path'.*(\\|/)|(/|\\))(?'file'.*)$" input="d:\Temp\SomeDir\SomeDir\bla.xml" />
- ]]>
- </code>
- <para>
- Results in path=<c>d:\Temp\SomeDir\SomeDir\</c> and file=<c>bla.xml</c>.
- </para>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.RegexTask.ExecuteTask">
- <summary>
- Executes the task.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.RegexTask.Pattern">
- <summary>
- Represents the regular expression to be evalued.
- </summary>
- <value>
- The regular expression to be evalued.
- </value>
- <remarks>
- The pattern must contain one or more named constructs, which may
- not contain any punctuation and cannot begin with a number.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Tasks.RegexTask.Options">
- <summary>
- A comma separated list of options to pass to the regex engine. The
- default is <see cref="F:System.Text.RegularExpressions.RegexOptions.None"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.RegexTask.Input">
- <summary>
- Represents the input for the regular expression.
- </summary>
- <value>
- The input for the regular expression.
- </value>
- </member>
- <member name="T:NAnt.Core.Tasks.SetEnvTask">
- <summary>
- Sets an environment variable or a whole collection of them. Use an empty
- <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute to clear a variable.
- </summary>
- <remarks>
- <note>
- Variables will be set for the current NAnt process and all child
- processes that NAnt spawns (compilers, shell tools, etc). If the
- intention is to only set a variable for a single child process, then
- using the <see cref="T:NAnt.Core.Tasks.ExecTask"/> and its nested <see cref="P:NAnt.Core.Tasks.ExecTask.EnvironmentSet"/>
- element might be a better option.
- </note>
- <note>
- Expansion of inline environment variables is performed using the syntax
- of the current platform. So on Windows platforms using the string %PATH%
- in the <see cref="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue"/> attribute will result in the value of
- the PATH variable being expanded in place before the variable is set.
- </note>
- </remarks>
- <example>
- <para>Set the MONO_PATH environment variable on a *nix platform.</para>
- <code>
- <![CDATA[
- <setenv name=="MONO_PATH" value="/home/jimbob/dev/foo:%MONO_PATH%"/>
- ]]>
- </code>
- </example>
- <example>
- <para>Set a collection of environment variables. Note the nested variable used to set var3.</para>
- <code>
- <![CDATA[
- <setenv>
- <variable name="var1" value="value2" />
- <variable name="var2" value="value2" />
- <variable name="var3" value="value3:%var2%" />
- </setenv>
- ]]>
- </code>
- </example>
- <example>
- <para>Set environment variables using nested path elements.</para>
- <code>
- <![CDATA[
- <path id="build.path">
- <pathelement dir="c:/windows" />
- <pathelement dir="c:/cygwin/usr/local/bin" />
- </path>
- <setenv>
- <variable name="build_path" >
- <path refid="build.path" />
- </variable>
- <variable name="path2">
- <path>
- <pathelement dir="c:/windows" />
- <pathelement dir="c:/cygwin/usr/local/bin" />
- </path>
- </variable>
- </setenv>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.SetEnvironmentVariable(System.String,System.String)">
- <summary>
- Win32 DllImport for the SetEnvironmentVariable function.
- </summary>
- <param name="lpName"></param>
- <param name="lpValue"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.setenv(System.String,System.String,System.Int32)">
- <summary>
- *nix dllimport for the setenv function.
- </summary>
- <param name="name"></param>
- <param name="value"></param>
- <param name="overwrite"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.Initialize">
- <summary>
- Checks whether the task is initialized with valid attributes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.ExecuteTask">
- <summary>
- Set the environment variables
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.SetEnvTask.SetSingleEnvironmentVariable(System.String,System.String)">
- <summary>
- Do the actual work here.
- </summary>
- <param name="name">The name of the environment variable.</param>
- <param name="value">The value of the environment variable.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.EnvName">
- <summary>
- The name of a single Environment variable to set
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.LiteralValue">
- <summary>
- The literal value for the environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.File">
- <summary>
- The value for a file-based environment variable. NAnt will convert
- it to an absolute filename.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.Directory">
- <summary>
- The value for a directory-based environment variable. NAnt will
- convert it to an absolute path.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SetEnvTask.Path">
- <summary>
- The value for a PATH like environment variable. You can use
- <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
- the platform's local conventions.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.SleepTask">
- <summary>
- A task for sleeping a specified period of time, useful when a build or deployment process
- requires an interval between tasks.
- </summary>
- <example>
- <para>Sleep 1 hour, 2 minutes, 3 seconds and 4 milliseconds.</para>
- <code>
- <![CDATA[
- <sleep hours="1" minutes="2" seconds="3" milliseconds="4" />
- ]]>
- </code>
- </example>
- <example>
- <para>Sleep 123 milliseconds.</para>
- <code>
- <![CDATA[
- <sleep milliseconds="123" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.SleepTask.Initialize">
- <summary>
- Verify parameters.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.SleepTask.GetSleepTime">
- <summary>
- Return time to sleep.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.SleepTask.DoSleep(System.Int32)">
- <summary>
- Sleeps for the specified number of milliseconds.
- </summary>
- <param name="millis">Number of milliseconds to sleep.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.SleepTask.Hours">
- <summary>
- Hours to add to the sleep time.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SleepTask.Minutes">
- <summary>
- Minutes to add to the sleep time.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SleepTask.Seconds">
- <summary>
- Seconds to add to the sleep time.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.SleepTask.Milliseconds">
- <summary>
- Milliseconds to add to the sleep time.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.StyleTask">
- <summary>
- Processes a document via XSLT.
- </summary>
- <example>
- <para>Create a report in HTML.</para>
- <code>
- <![CDATA[
- <style style="report.xsl" in="data.xml" out="report.html" />
- ]]>
- </code>
- </example>
- <example>
- <para>Create a report in HTML, with a param.</para>
- <code>
- <![CDATA[
- <style style="report.xsl" in="data.xml" out="report.html">
- <parameters>
- <parameter name="reportType" namespaceuri="" value="Plain" />
- </parameters>
- </style>
- ]]>
- </code>
- </example>
- <example>
- <para>Create a report in HTML, with a expanded param.</para>
- <code>
- <![CDATA[
- <style style="report.xsl" in="data.xml" out="report.html">
- <parameters>
- <parameter name="reportType" namespaceuri="" value="${report.type}" />
- </parameters>
- </style>
- ]]>
- </code>
- </example>
- <example>
- <para>Create some code based on a directory of templates.</para>
- <code>
- <![CDATA[
- <style style="CodeGenerator.xsl" extension="java">
- <infiles>
- <include name="*.xml" />
- </infiles>
- <parameters>
- <parameter name="reportType" namespaceuri="" value="Plain" if="${report.plain}" />
- </parameters>
- <style>
- ]]>
- </code>
- </example>
- <example>
- <para>Create a report in HTML, with an extension object.</para>
- <code>
- <![CDATA[
- <style style="report.xsl" in="data.xml" out="report.html">
- <extensionobjects>
- <extensionobject namespaceuri="urn:Formatter" typename="XsltExtensionObjects.Formatter" assembly="XsltExtensionObjects.dll" />
- </extensionobjects>
- </style>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.DestDir">
- <summary>
- Directory in which to store the results. The default is the project
- base directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.Extension">
- <summary>
- Desired file extension to be used for the targets. The default is
- <c>html</c>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.XsltFile">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.SrcFile">
- <summary>
- Specifies a single XML document to be styled. Should be used with
- the <see cref="P:NAnt.Core.Tasks.StyleTask.OutputFile"/> attribute.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.OutputFile">
- <summary>
- Specifies the output name for the styled result from the <see cref="P:NAnt.Core.Tasks.StyleTask.SrcFile"/>
- attribute.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.InFiles">
- <summary>
- Specifies a group of input files to which to apply the stylesheet.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.Parameters">
- <summary>
- XSLT parameters to be passed to the XSLT transformation.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.ExtensionObjects">
- <summary>
- XSLT extension objects to be passed to the XSLT transformation.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.StyleTask.Proxy">
- <summary>
- The network proxy to use to access the Internet resource.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.SysInfoTask">
- <summary>
- Sets properties with system information.
- </summary>
- <remarks>
- <para>Sets a number of properties with information about the system environment. The intent of this task is for nightly build logs to have a record of system information so that the build was performed on.</para>
- <list type="table">
- <listheader>
- <term>Property</term>
- <description>Value</description>
- </listheader>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.clr.version</term>
- <description>Common Language Runtime version number.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.*</term>
- <description>Environment variables (e.g., <<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.env.PATH).</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.platform</term>
- <description>Operating system platform ID.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.version</term>
- <description>Operating system version.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os</term>
- <description>Operating system version string.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.applicationdata</term>
- <description>The directory that serves as a common repository for application-specific data for the current roaming user.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonapplicationdata</term>
- <description>The directory that serves as a common repository for application-specific data that is used by all users.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.commonprogramfiles</term>
- <description>The directory for components that are shared across applications.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.desktopdirectory</term>
- <description>The directory used to physically store file objects on the desktop. Do not confuse this directory with the desktop folder itself, which is a virtual folder.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.programfiles</term>
- <description>The Program Files directory.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.system</term>
- <description>The System directory.</description>
- </item>
- <item>
- <term><<see cref="P:NAnt.Core.Tasks.SysInfoTask.Prefix"/>>.os.folder.temp</term>
- <description>The temporary directory.</description>
- </item>
- </list>
- <para>
- When the name of an environment variable is not a valid property name,
- the task will fail. In that case, set <see cref="P:NAnt.Core.Task.FailOnError"/> to
- <see langword="true"/> to allow that environment variable to be
- skipped.
- </para>
- <note>
- we advise you to use the following functions instead:
- </note>
- <list type="table">
- <listheader>
- <term>Function</term>
- <description>Description</description>
- </listheader>
- <item>
- <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetOperatingSystem"/></term>
- <description>Gets a <see cref="T:System.OperatingSystem"/> object that identifies this operating system.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetFolderPath(System.Environment.SpecialFolder)"/></term>
- <description>Gets the path to a system special folder.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVariable(System.String)"/></term>
- <description>Returns the value of a environment variable.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.PathFunctions.GetTempPath"/></term>
- <description>Gets the path to the temporary directory.</description>
- </item>
- <item>
- <term><see cref="M:NAnt.Core.Functions.EnvironmentFunctions.GetVersion"/></term>
- <description>Gets the Common Language Runtime version.</description>
- </item>
- </list>
- </remarks>
- <example>
- <para>Register the properties with the default property prefix.</para>
- <code>
- <![CDATA[
- <sysinfo />
- ]]>
- </code>
- </example>
- <example>
- <para>Register the properties without a prefix.</para>
- <code>
- <![CDATA[
- <sysinfo prefix="" />
- ]]>
- </code>
- </example>
- <example>
- <para>Register properties and display a summary.</para>
- <code>
- <![CDATA[
- <sysinfo verbose="true" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.SysInfoTask.Prefix">
- <summary>
- The string to prefix the property names with. The default is "sys.".
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.TStampTask">
- <summary>
- Sets properties with the current date and time.
- </summary>
- <remarks>
- <para>
- By default the <see cref="T:NAnt.Core.Tasks.TStampTask"/> displays the current date
- and time and sets the following properties:
- </para>
- <list type="bullet">
- <item><description>tstamp.date to yyyyMMdd</description></item>
- <item><description>tstamp.time to HHmm</description></item>
- <item><description>tstamp.now using the default DateTime.ToString() method</description></item>
- </list>
- <para>
- To set an additional property with a custom date/time use the
- <see cref="P:NAnt.Core.Tasks.TStampTask.Property"/> and <see cref="P:NAnt.Core.Tasks.TStampTask.Pattern"/> attributes.
- To set a number of additional properties with the exact same date and
- time use the <see cref="P:NAnt.Core.Tasks.TStampTask.Formatters"/> nested element (see example).
- </para>
- <para>
- The date and time string displayed by the <see cref="T:NAnt.Core.Tasks.TStampTask"/>
- uses the computer's default long date and time string format. You
- might consider setting these to the
- <see href="http://www.cl.cam.ac.uk/~mgk25/iso-time.html">ISO 8601 standard
- for date and time notation</see>.
- </para>
- </remarks>
- <example>
- <para>Set the <c>build.date</c> property.</para>
- <code>
- <![CDATA[
- <tstamp property="build.date" pattern="yyyyMMdd" verbose="true" />
- ]]>
- </code>
- </example>
- <example>
- <para>Set a number of properties for Ant like compatibility.</para>
- <code>
- <![CDATA[
- <tstamp verbose="true">
- <formatter property="TODAY" pattern="dd MMM yyyy"/>
- <formatter property="DSTAMP" pattern="yyyyMMdd" unless="${date.not.needed}" />
- <formatter property="TSTAMP" pattern="HHmm" if="${need.hours}" />
- </tstamp>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.TStampTask.Property">
- <summary>
- The property to receive the date/time string in the given pattern.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TStampTask.Pattern">
- <summary>The date/time pattern to be used.</summary>
- <remarks>
- <para>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.</para>
- <list type="table">
- <listheader>
- <description>Format Character</description>
- <description>Description Example Format Pattern (en-US)</description>
- </listheader>
- <item><description>d</description><description>MM/dd/yyyy</description></item>
- <item><description>D</description><description>dddd, dd MMMM yyyy</description></item>
- <item><description>f</description><description>dddd, dd MMMM yyyy HH:mm</description></item>
- <item><description>F</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
- <item><description>g</description><description>MM/dd/yyyy HH:mm</description></item>
- <item><description>G</description><description>MM/dd/yyyy HH:mm:ss</description></item>
- <item><description>m, M</description><description>MMMM dd</description></item>
- <item><description>r, R</description><description>ddd, dd MMM yyyy HH':'mm':'ss 'GMT'</description></item>
- <item><description>s</description><description>yyyy'-'MM'-'dd'T'HH':'mm':'ss</description></item>
- <item><description>t</description><description>HH:mm</description></item>
- <item><description>T</description><description>HH:mm:ss</description></item>
- <item><description>u</description><description>yyyy'-'MM'-'dd HH':'mm':'ss'Z'</description></item>
- <item><description>U</description><description>dddd, dd MMMM yyyy HH:mm:ss</description></item>
- <item><description>y, Y</description><description>yyyy MMMM</description></item>
- </list>
- <para>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.</para>
- <list type="table">
- <listheader>
- <description>Format</description>
- <description>Pattern Description</description>
- </listheader>
- <item><description>d</description><description>The day of the month. Single-digit days will not have a leading zero.</description></item>
- <item><description>dd</description><description>The day of the month. Single-digit days will have a leading zero.</description></item>
- <item><description>ddd</description><description>The abbreviated name of the day of the week.</description></item>
- <item><description>dddd</description><description>The full name of the day of the week.</description></item>
- <item><description>M</description><description>The numeric month. Single-digit months will not have a leading zero.</description></item>
- <item><description>MM</description><description>The numeric month. Single-digit months will have a leading zero.</description></item>
- <item><description>MMM</description><description>The abbreviated name of the month.</description></item>
- <item><description>MMMM</description><description>The full name of the month.</description></item>
- <item><description>y</description><description>The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero.</description></item>
- <item><description>yy</description><description>The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero.</description></item>
- <item><description>yyyy</description><description>The year in four digits, including the century.</description></item>
- <item><description>gg</description><description>The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string.</description></item>
- <item><description>h</description><description>The hour in a 12-hour clock. Single-digit hours will not have a leading zero.</description></item>
- <item><description>hh</description><description>The hour in a 12-hour clock. Single-digit hours will have a leading zero.</description></item>
- <item><description>H</description><description>The hour in a 24-hour clock. Single-digit hours will not have a leading zero.</description></item>
- <item><description>HH</description><description>The hour in a 24-hour clock. Single-digit hours will have a leading zero.</description></item>
- <item><description>m</description><description>The minute. Single-digit minutes will not have a leading zero.</description></item>
- <item><description>mm</description><description>The minute. Single-digit minutes will have a leading zero.</description></item>
- <item><description>s</description><description>The second. Single-digit seconds will not have a leading zero.</description></item>
- <item><description>ss</description><description>The second. Single-digit seconds will have a leading zero.</description></item>
- <item><description>f</description><description>The fraction of a second in single-digit precision. The remaining digits are truncated.</description></item>
- <item><description>ff</description><description>The fraction of a second in double-digit precision. The remaining digits are truncated.</description></item>
- <item><description>fff</description><description>The fraction of a second in three-digit precision. The remaining digits are truncated.</description></item>
- <item><description>ffff</description><description>The fraction of a second in four-digit precision. The remaining digits are truncated.</description></item>
- <item><description>fffff</description><description>The fraction of a second in five-digit precision. The remaining digits are truncated. </description></item>
- <item><description>ffffff</description><description>The fraction of a second in six-digit precision. The remaining digits are truncated. </description></item>
- <item><description>fffffff</description><description>The fraction of a second in seven-digit precision. The remaining digits are truncated. </description></item>
- <item><description>t</description><description>The first character in the AM/PM designator.</description></item>
- <item><description>tt</description><description>The AM/PM designator. </description></item>
- <item><description>z</description><description>The 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".</description></item>
- <item><description>zz</description><description>The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08".</description></item>
- <item><description>zzz</description><description>The 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".</description></item>
- <item><description>:</description><description>The default time separator.</description></item>
- <item><description>/</description><description>The default date separator.</description></item>
- <item><description>\ c</description><description>Pattern Where c is any character. Displays the character literally. To display the backslash character, use "\\". </description></item>
- </list>
- </remarks>
- </member>
- <member name="T:NAnt.Core.Tasks.TouchTask">
- <summary>
- Touches a file or set of files -- corresponds to the Unix touch command.
- </summary>
- <remarks>
- <para>
- If the file specified does not exist, the task will create it.
- </para>
- </remarks>
- <example>
- <para>Touch the <c>Main.cs</c> file. The current time is used.</para>
- <code>
- <![CDATA[
- <touch file="Main.cs" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Touch all executable files in the project base directory and its
- subdirectories.
- </para>
- <code>
- <![CDATA[
- <touch>
- <fileset>
- <include name="**/*.exe" />
- <include name="**/*.dll" />
- </fileset>
- </touch>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.TouchTask.Initialize">
- <summary>
- Ensures the supplied attributes are valid.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TouchTask.File">
- <summary>
- The file to touch.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TouchTask.Millis">
- <summary>
- Specifies the new modification time of the file(s) in milliseconds
- since midnight Jan 1 1970.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TouchTask.Datetime">
- <summary>
- Specifies the new modification time of the file in the format
- MM/DD/YYYY HH:MM:SS.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.TouchTask.TouchFileSet">
- <summary>
- Used to select files that should be touched.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.UpToDateTask">
- <summary>
- Check modification dates on groups of files.
- </summary>
- <remarks>
- If all <see cref="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles"/> are same or newer than all <see cref="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles"/>, the specified property is set to <see langword="true"/>, otherwise it
- is set to <see langword="false"/>.
- </remarks>
- <example>
- <para>
- Check file dates. If <c>myfile.dll</c> is same or newer than <c>myfile.cs</c>, then set <c>myfile.dll.uptodate</c> property
- to either <see langword="true"/> or <see langword="false"/>.
- </para>
- <code>
- <![CDATA[
- <uptodate property="myfile.dll.uptodate">
- <sourcefiles>
- <include name="myfile.cs" />
- </sourcefiles>
- <targetfiles>
- <include name="myfile.dll" />
- </targetfiles>
- </uptodate>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.Core.Tasks.UpToDateTask.PropertyName">
- <summary>
- Property that will be set to <see langword="true" /> or <see langword="false" /> depending on the
- result of the date check.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.UpToDateTask.SourceFiles">
- <summary>
- The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of source files.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.UpToDateTask.TargetFiles">
- <summary>
- The <see cref="T:NAnt.Core.Types.FileSet"/> that contains list of target files.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.XmlPeekTask">
- <summary>
- Extracts text from an XML file at the location specified by an XPath
- expression.
- </summary>
- <remarks>
- <para>
- If the XPath expression specifies multiple nodes the node index is used
- to determine which of the nodes' text is returned.
- </para>
- </remarks>
- <example>
- <para>
- The example provided assumes that the following XML file (App.config)
- exists in the current build directory.
- </para>
- <code>
- <![CDATA[
- <?xml version="1.0" encoding="utf-8" ?>
- <configuration xmlns="http://www.gordic.cz/shared/project-config/v_1.0.0.0">
- <appSettings>
- <add key="server" value="testhost.somecompany.com" />
- </appSettings>
- </configuration>
- ]]>
- </code>
- </example>
- <example>
- <para>
- The example will read the server value from the above
- configuration file.
- </para>
- <code>
- <![CDATA[
- <xmlpeek
- file="App.config"
- xpath="/x:configuration/x:appSettings/x:add[@key = 'server']/@value"
- property="configuration.server">
- <namespaces>
- <namespace prefix="x" uri="http://www.gordic.cz/shared/project-config/v_1.0.0.0" />
- </namespaces>
- </xmlpeek>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPeekTask.ExecuteTask">
- <summary>
- Executes the XML peek task.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPeekTask.LoadDocument(System.String)">
- <summary>
- Loads an XML document from a file on disk.
- </summary>
- <param name="fileName">The file name of the file to load the XML document from.</param>
- <returns>
- A <see cref="T:System.Xml.XmlDocument">document</see> containing
- the document object representing the file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPeekTask.GetNodeContents(System.String,System.Xml.XmlDocument,System.Int32)">
- <summary>
- Gets the contents of the node specified by the XPath expression.
- </summary>
- <param name="xpath">The XPath expression used to determine which nodes to choose from.</param>
- <param name="document">The XML document to select the nodes from.</param>
- <param name="nodeIndex">The node index in the case where multiple nodes satisfy the expression.</param>
- <returns>
- The contents of the node specified by the XPath expression.
- </returns>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.XmlFile">
- <summary>
- The name of the file that contains the XML document
- that is going to be peeked at.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.NodeIndex">
- <summary>
- The index of the node that gets its text returned when the query
- returns multiple nodes.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.Property">
- <summary>
- The property that receives the text representation of the XML inside
- the node returned from the XPath expression.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.XPath">
- <summary>
- The XPath expression used to select which node to read.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPeekTask.Namespaces">
- <summary>
- Namespace definitions to resolve prefixes in the XPath expression.
- </summary>
- </member>
- <member name="T:NAnt.Core.Tasks.XmlPokeTask">
- <summary>
- Replaces text in an XML file at the location specified by an XPath
- expression.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- </remarks>
- <example>
- <para>
- Change the <c>server</c> setting in the configuration from <c>testhost.somecompany.com</c>
- to <c>productionhost.somecompany.com</c>.
- </para>
- <para>XML file:</para>
- <code>
- <![CDATA[
- <?xml version="1.0" encoding="utf-8" ?>
- <configuration>
- <appSettings>
- <add key="server" value="testhost.somecompany.com" />
- </appSettings>
- </configuration>
- ]]>
- </code>
- <para>Build fragment:</para>
- <code>
- <![CDATA[
- <xmlpoke
- file="App.config"
- xpath="/configuration/appSettings/add[@key = 'server']/@value"
- value="productionhost.somecompany.com" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Modify the <c>noNamespaceSchemaLocation</c> in an XML file.
- </para>
- <para>XML file:</para>
- <code>
- <![CDATA[
- <?xml version="1.0" encoding="utf-8" ?>
- <Commands xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Path Value">
- </Commands>
- ]]>
- </code>
- <para>Build fragment:</para>
- <code>
- <![CDATA[
- <xmlpoke file="test.xml" xpath="/Commands/@xsi:noNamespaceSchemaLocation" value="d:\Commands.xsd">
- <namespaces>
- <namespace prefix="xsi" uri="http://www.w3.org/2001/XMLSchema-instance" />
- </namespaces>
- </xmlpoke>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.ExecuteTask">
- <summary>
- Executes the XML poke task.
- </summary>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.LoadDocument(System.String)">
- <summary>
- Loads an XML document from a file on disk.
- </summary>
- <param name="fileName">
- The file name of the file to load the XML document from.
- </param>
- <returns>
- An <see cref="T:System.Xml.XmlDocument"/> containing
- the document object model representing the file.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.SelectNodes(System.String,System.Xml.XmlDocument,System.Xml.XmlNamespaceManager)">
- <summary>
- Given an XML document and an expression, returns a list of nodes
- which match the expression criteria.
- </summary>
- <param name="xpath">
- The XPath expression used to select the nodes.
- </param>
- <param name="document">
- The XML document that is searched.
- </param>
- <param name="nsMgr">
- An <see cref="T:System.Xml.XmlNamespaceManager"/> to use for resolving namespaces
- for prefixes in the XPath expression.
- </param>
- <returns>
- An <see cref="T:System.Xml.XmlNodeList"/> containing references to the nodes
- that matched the XPath expression.
- </returns>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.UpdateNodes(System.Xml.XmlNodeList,System.String)">
- <summary>
- Given a node list, replaces the XML within those nodes.
- </summary>
- <param name="nodes">
- The list of nodes to replace the contents of.
- </param>
- <param name="value">
- The text to replace the contents with.
- </param>
- </member>
- <member name="M:NAnt.Core.Tasks.XmlPokeTask.SaveDocument(System.Xml.XmlDocument,System.String)">
- <summary>
- Saves the XML document to a file.
- </summary>
- <param name="document">The XML document to be saved.</param>
- <param name="fileName">The file name to save the XML document under.</param>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPokeTask.XmlFile">
- <summary>
- The name of the file that contains the XML document that is going
- to be poked.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPokeTask.XPath">
- <summary>
- The XPath expression used to select which nodes are to be modified.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPokeTask.Value">
- <summary>
- The value that replaces the contents of the selected nodes.
- </summary>
- </member>
- <member name="P:NAnt.Core.Tasks.XmlPokeTask.Namespaces">
- <summary>
- Namespace definitions to resolve prefixes in the XPath expression.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.Argument">
- <summary>
- Represents a command-line argument.
- </summary>
- <remarks>
- <para>
- When passed to an external application, the argument will be quoted
- when appropriate. This does not apply to the <see cref="P:NAnt.Core.Types.Argument.Line"/>
- parameter, which is always passed as is.
- </para>
- </remarks>
- <example>
- <para>
- A single command-line argument containing a space character.
- </para>
- <code>
- <![CDATA[
- <arg value="-l -a" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Two separate command-line arguments.
- </para>
- <code>
- <![CDATA[
- <arg line="-l -a" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- A single command-line argument with the value <c>\dir;\dir2;\dir3</c>
- on DOS-based systems and <c>/dir:/dir2:/dir3</c> on Unix-like systems.
- </para>
- <code>
- <![CDATA[
- <arg path="/dir;/dir2:\dir3" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Types.Argument.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Argument.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
- with the specified command-line argument.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Argument.#ctor(System.IO.FileInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
- with the given file.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Argument.#ctor(NAnt.Core.Types.PathSet)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Argument"/> class
- with the given path.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Argument.ToString">
- <summary>
- Returns the argument as a <see cref="T:System.String"/>.
- </summary>
- <returns>
- The argument as a <see cref="T:System.String"/>.
- </returns>
- <remarks>
- File and individual path elements will be quoted if necessary.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Types.Argument.QuoteArgument(System.String)">
- <summary>
- Quotes a command line argument if it contains a single quote or a
- space.
- </summary>
- <param name="argument">The command line argument.</param>
- <returns>
- A quoted command line argument if <paramref name="argument" />
- contains a single quote or a space; otherwise,
- <paramref name="argument" />.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.Argument.Value">
- <summary>
- A single command-line argument; can contain space characters.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.File">
- <summary>
- The name of a file as a single command-line argument; will be
- replaced with the absolute filename of the file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.Directory">
- <summary>
- The value for a directory-based command-line argument; will be
- replaced with the absolute path of the directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.Path">
- <summary>
- The value for a PATH-like command-line argument; you can use
- <c>:</c> or <c>;</c> as path separators and NAnt will convert it
- to the platform's local conventions, while resolving references to
- environment variables.
- </summary>
- <remarks>
- Individual parts will be replaced with the absolute path, resolved
- relative to the project base directory.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Types.Argument.PathSet">
- <summary>
- Sets a single command-line argument and treats it like a PATH - ensures
- the right separator for the local platform is used.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.Line">
- <summary>
- List of command-line arguments; will be passed to the executable
- as is.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.IfDefined">
- <summary>
- Indicates if the argument should be passed to the external program.
- If <see langword="true" /> then the argument will be passed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.UnlessDefined">
- <summary>
- Indicates if the argument should not be passed to the external
- program. If <see langword="false" /> then the argument will be
- passed; otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Argument.StringValue">
- <summary>
- Gets string value corresponding with the argument.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.ArgumentCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.Argument"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.ArgumentCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.#ctor(NAnt.Core.Types.Argument[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.Argument"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Add(NAnt.Core.Types.Argument)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.Argument"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.Argument[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.Argument"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.Argument"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.AddRange(NAnt.Core.Types.ArgumentCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.ArgumentCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(NAnt.Core.Types.Argument)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Argument"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Argument"/> with value
- <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.CopyTo(NAnt.Core.Types.Argument[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.IndexOf(NAnt.Core.Types.Argument)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Argument"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.Argument"/>. If the <see cref="T:NAnt.Core.Types.Argument"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Insert(System.Int32,NAnt.Core.Types.Argument)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.Argument"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentCollection.Remove(NAnt.Core.Types.Argument)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Argument"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.ArgumentCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.Argument"/> with the specified value.
- </summary>
- <param name="value">The value of the <see cref="T:NAnt.Core.Types.Argument"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.ArgumentEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.Argument"/> elements of a <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentEnumerator.#ctor(NAnt.Core.Types.ArgumentCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ArgumentEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.ArgumentCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.ArgumentEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.ArgumentEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.Credential">
- <summary>
- Provides credentials for password-based authentication schemes.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Credential.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Credential"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Credential.GetCredential">
- <summary>
- Returns a <see cref="T:System.Net.NetworkCredential"/> instance representing
- the current <see cref="T:NAnt.Core.Types.Credential"/>.
- </summary>
- <returns>
- A <see cref="T:System.Net.NetworkCredential"/> instance representing the current
- <see cref="T:NAnt.Core.Types.Credential"/>, or <see langword="null"/> if the
- credentials should not be used to provide authentication information
- to the external resource.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.Credential.Domain">
- <summary>
- The domain or computer name that verifies the credentials.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Credential.Password">
- <summary>
- The password for the user name associated with the credentials.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Credential.UserName">
- <summary>
- The user name associated with the credentials.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Credential.IfDefined">
- <summary>
- Indicates if the credentials should be used to provide authentication
- information to the external resource. If <see langword="true" /> then
- the credentials will be passed; otherwise, not. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Credential.UnlessDefined">
- <summary>
- Indicates if the credentials should not be used to provide authentication
- information to the external resource. If <see langword="false" /> then the
- credentials will be passed; otherwise, not. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.DirSet">
- <summary>
- A specialized <see cref="T:NAnt.Core.Types.FileSet"/> used for specifying a set of
- directories.
- </summary>
- <remarks>
- Hint for supporting tasks that the included directories instead of
- files should be used.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Types.FileSet">
- <summary>
- Filesets are groups of files. These files can be found in a directory
- tree starting in a base directory and are matched by patterns taken
- from a number of patterns. Filesets can appear inside tasks that support
- this feature or at the project level, i.e., as children of <c><project></c>.
- </summary>
- <remarks>
- <h3>Patterns</h3>
- <para>
- As described earlier, patterns are used for the inclusion and exclusion.
- These patterns look very much like the patterns used in DOS and UNIX:
- </para>
- <list type="bullet">
- <item>
- <description>
- <para>'<c>*</c>' matches zero or more characters</para>
- <para>For example:</para>
- <para>
- <c>*.cs</c> matches <c>.cs</c>, <c>x.cs</c> and <c>FooBar.cs</c>,
- but not <c>FooBar.xml</c> (does not end with <c>.cs</c>).
- </para>
- </description>
- </item>
- <item>
- <description>
- <para>'<c>?</c>' matches one character</para>
- <para>For example:</para>
- <para>
- <c>?.cs</c> matches <c>x.cs</c>, <c>A.cs</c>, but not
- <c>.cs</c> or <c>xyz.cs</c> (both don't have one character
- before <c>.cs</c>).
- </para>
- </description>
- </item>
- </list>
- <para>
- Combinations of <c>*</c>'s and <c>?</c>'s are allowed.
- </para>
- <para>
- Matching is done per-directory. This means that first the first directory
- in the pattern is matched against the first directory in the path to match.
- Then the second directory is matched, and so on. For example, when we have
- the pattern <c>/?abc/*/*.cs</c> and the path <c>/xabc/foobar/test.cs</c>,
- the first <c>?abc</c> is matched with <c>xabc</c>, then <c>*</c> is matched
- with <c>foobar</c>, and finally <c>*.cs</c> is matched with <c>test.cs</c>.
- They all match, so the path matches the pattern.
- </para>
- <para>
- To make things a bit more flexible, we added one extra feature, which makes
- it possible to match multiple directory levels. This can be used to match a
- complete directory tree, or a file anywhere in the directory tree. To do this,
- <c>**</c> must be used as the name of a directory. When <c>**</c> is used as
- the name of a directory in the pattern, it matches zero or more directories.
- For example: <c>/test/**</c> matches all files/directories under <c>/test/</c>,
- such as <c>/test/x.cs</c>, or <c>/test/foo/bar/xyz.html</c>, but not <c>/xyz.xml</c>.
- </para>
- <para>
- There is one "shorthand" - if a pattern ends with <c>/</c> or <c>\</c>, then
- <c>**</c> is appended. For example, <c>mypackage/test/</c> is interpreted as
- if it were <c>mypackage/test/**</c>.
- </para>
- <h3>Case-Sensitivity</h3>
- <para>
- By default, pattern matching is case-sensitive on Unix and case-insensitive
- on other platforms. The <see cref="P:NAnt.Core.Types.FileSet.CaseSensitive"/> parameter can be used
- to override this.
- </para>
- <h3>Default Excludes</h3>
- <para>
- There are a set of definitions that are excluded by default from all
- tasks that use filesets. They are:
- </para>
- <list type="bullet">
- <item>
- <description>
- **/*~
- </description>
- </item>
- <item>
- <description>
- **/#*#
- </description>
- </item>
- <item>
- <description>
- **/.#*
- </description>
- </item>
- <item>
- <description>
- **/%*%
- </description>
- </item>
- <item>
- <description>
- **/CVS
- </description>
- </item>
- <item>
- <description>
- **/CVS/**
- </description>
- </item>
- <item>
- <description>
- **/.cvsignore
- </description>
- </item>
- <item>
- <description>
- **/.svn
- </description>
- </item>
- <item>
- <description>
- **/.svn/**
- </description>
- </item>
- <item>
- <description>
- **/_svn
- </description>
- </item>
- <item>
- <description>
- **/_svn/**
- </description>
- </item>
- <item>
- <description>
- **/SCCS
- </description>
- </item>
- <item>
- <description>
- **/SCCS/**
- </description>
- </item>
- <item>
- <description>
- **/vssver.scc
- </description>
- </item>
- <item>
- <description>
- **/_vti_cnf/**
- </description>
- </item>
- </list>
- <para>
- If you do not want these default excludes applied, you may disable them
- by setting <see cref="P:NAnt.Core.Types.FileSet.DefaultExcludes"/> to <see langword="false"/>.
- </para>
- </remarks>
- <example>
- <list type="table">
- <listheader>
- <term>Pattern</term>
- <description>Match</description>
- </listheader>
- <item>
- <term><c>**/CVS/*</c></term>
- <description>
- <para>
- Matches all files in <c>CVS</c> directories that can be
- located anywhere in the directory tree.
- </para>
- <para>Matches:</para>
- <list type="bullet">
- <item>
- <description>CVS/Repository</description>
- </item>
- <item>
- <description>org/apache/CVS/Entries</description>
- </item>
- <item>
- <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
- </item>
- </list>
- <para>But not:</para>
- <list type="bullet">
- <item>
- <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
- </item>
- </list>
- </description>
- </item>
- <item>
- <term><c>org/apache/jakarta/**</c></term>
- <description>
- <para>
- Matches all files in the <c>org/apache/jakarta</c> directory
- tree.
- </para>
- <para>Matches:</para>
- <list type="bullet">
- <item>
- <description>org/apache/jakarta/tools/ant/docs/index.html</description>
- </item>
- <item>
- <description>org/apache/jakarta/test.xml</description>
- </item>
- </list>
- <para>But not:</para>
- <list type="bullet">
- <item>
- <description>org/apache/xyz.java (<c>jakarta/</c> part is missing)</description>
- </item>
- </list>
- </description>
- </item>
- <item>
- <term><c>org/apache/**/CVS/*</c></term>
- <description>
- <para>
- Matches all files in <c>CVS</c> directories that are located
- anywhere in the directory tree under <c>org/apache</c>.
- </para>
- <para>Matches:</para>
- <list type="bullet">
- <item>
- <description>org/apache/CVS/Entries</description>
- </item>
- <item>
- <description>org/apache/jakarta/tools/ant/CVS/Entries</description>
- </item>
- </list>
- <para>But not:</para>
- <list type="bullet">
- <item>
- <description>org/apache/CVS/foo/bar/Entries (<c>foo/bar/</c> part does not match)</description>
- </item>
- </list>
- </description>
- </item>
- <item>
- <term><c>**/test/**</c></term>
- <description>
- <para>
- Matches all files that have a <c>test</c> element in their
- path, including <c>test</c> as a filename.
- </para>
- </description>
- </item>
- </list>
- </example>
- <seealso cref="T:NAnt.Core.Types.PatternSet"/>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FileSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.#ctor(NAnt.Core.Types.FileSet)">
- <summary>
- copy constructor
- </summary>
- <param name="fs"></param>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.Types.FileSet"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.AddPatternSet(NAnt.Core.Types.PatternSet)">
- <summary>
- Adds a nested set of patterns, or references a standalone patternset.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.CopyTo(NAnt.Core.Types.FileSet)">
- <summary>
- Copies all instance data of the <see cref="T:NAnt.Core.Types.FileSet"/> to a given
- <see cref="T:NAnt.Core.Types.FileSet"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.String,System.DateTime)">
- <summary>
- Determines if a file has a more recent last write time than the
- given time, or no longer exists.
- </summary>
- <param name="fileName">A file to check the last write time against.</param>
- <param name="targetLastWriteTime">The datetime to compare against.</param>
- <returns>
- The name of the file that has a last write time greater than
- <paramref name="targetLastWriteTime" /> or that no longer exists;
- otherwise, <see langword="null" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FileSet.FindMoreRecentLastWriteTime(System.Collections.Specialized.StringCollection,System.DateTime)">
- <summary>
- 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.
- </summary>
- <param name="fileNames">A collection of filenames to check the last write time against.</param>
- <param name="targetLastWriteTime">The datetime to compare against.</param>
- <returns>
- The name of the first file that has a last write time greater than
- <paramref name="targetLastWriteTime" />; otherwise, null.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.CaseSensitive">
- <summary>
- Indicates whether include and exclude patterns must be treated in a
- case-sensitive way. The default is <see langword="true" /> on Unix;
- otherwise, <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.FailOnEmpty">
- <summary>
- When set to <see langword="true"/>, causes the fileset element to
- throw a <see cref="T:NAnt.Core.ValidationException"/> when no files match the
- includes and excludes criteria. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.DefaultExcludes">
- <summary>
- Indicates whether default excludes should be used or not.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.BaseDirectory">
- <summary>
- The base of the directory of this fileset. The default is the project
- base directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Includes">
- <summary>
- Gets the collection of include patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Excludes">
- <summary>
- Gets the collection of exclude patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.AsIs">
- <summary>
- Gets the collection of files that will be added to the
- <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking if the
- file exists.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.FileNames">
- <summary>
- Gets the collection of file names that match the fileset.
- </summary>
- <value>
- A collection that contains the file names that match the
- <see cref="T:NAnt.Core.Types.FileSet"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.DirectoryNames">
- <summary>
- Gets the collection of directory names that match the fileset.
- </summary>
- <value>
- A collection that contains the directory names that match the
- <see cref="T:NAnt.Core.Types.FileSet"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ScannedDirectories">
- <summary>
- Gets the collection of directory names that were scanned for files.
- </summary>
- <value>
- A collection that contains the directory names that were scanned for
- files.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.SetIncludes">
- <summary>
- The items to include in the fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludeElements">
- <summary>
- The items to include in the fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.SetExcludes">
- <summary>
- The items to exclude from the fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludeElements">
- <summary>
- The items to exclude from the fileset.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.SetIncludesList">
- <summary>
- The files from which a list of patterns or files to include should
- be obtained.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFiles">
- <summary>
- The files from which a list of patterns or files to include should
- be obtained.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFiles">
- <summary>
- The files from which a list of patterns or files to exclude should
- be obtained.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.MostRecentLastWriteTimeFile">
- <summary>
- Determines the most recently modified file in the fileset (by LastWriteTime of the <see cref="T:System.IO.FileInfo"/>).
- </summary>
- <returns>
- The <see cref="T:System.IO.FileInfo"/> of the file that has the newest (closest to present) last write time.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Exclude.Pattern">
- <summary>
- The pattern or file name to exclude.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Exclude.IfDefined">
- <summary>
- If <see langword="true" /> then the pattern will be excluded;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Exclude.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.FileSet.Exclude.IfDefined"/>. If <see langword="false"/>
- then the pattern will be excluded; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.AsIs">
- <summary>
- If <see langword="true"/> then the file name will be added to
- the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern matching or checking
- if the file exists. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.FromPath">
- <summary>
- If <see langword="true" /> then the file will be searched for
- on the path. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.Pattern">
- <summary>
- The pattern or file name to include.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.IfDefined">
- <summary>
- If <see langword="true" /> then the pattern will be included;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.Include.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.FileSet.Include.IfDefined"/>. If <see langword="false"/>
- then the pattern will be included; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.Patterns">
- <summary>
- Gets the list of patterns in <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined">
- <summary>
- If <see langword="true" /> then the patterns will be excluded;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.FileSet.ExcludesFile.IfDefined"/>. If <see langword="false"/>
- then the patterns will be excluded; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.ExcludesFile.PatternFile">
- <summary>
- The name of a file; each line of this file is taken to be a
- pattern.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFile.AsIs">
- <summary>
- If <see langword="true"/> then the patterns in the include file
- will be added to the <see cref="T:NAnt.Core.Types.FileSet"/> without pattern
- matching or checking if the file exists. The default is
- <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFile.FromPath">
- <summary>
- If <see langword="true" /> then the patterns in the include file
- will be searched for on the path. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined">
- <summary>
- If <see langword="true" /> then the patterns will be included;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FileSet.IncludesFile.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.FileSet.IncludesFile.IfDefined"/>. If <see langword="false"/>
- then the patterns will be included; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.DirSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.DirSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.DirSet.#ctor(NAnt.Core.Types.FileSet)">
- <summary>
- Copy constructor for <see cref="T:NAnt.Core.Types.FileSet"/>. Required in order to
- assign references of <see cref="T:NAnt.Core.Types.FileSet"/> type where
- <see cref="T:NAnt.Core.Types.DirSet"/> is used.
- </summary>
- <param name="fs">A <see cref="T:NAnt.Core.Types.FileSet"/> instance to create a <see cref="T:NAnt.Core.Types.DirSet"/> from.</param>
- </member>
- <member name="T:NAnt.Core.Types.EnvironmentVariable">
- <summary>
- Represents an environment variable.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor(System.String,System.String)">
- <summary>
- Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance with the
- specified name and value.
- </summary>
- <param name="name">The name of the environment variable.</param>
- <param name="value">The value of the environment variable.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariable.#ctor">
- <summary>
- Initializes a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instance.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.VariableName">
- <summary>
- The name of the environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.LiteralValue">
- <summary>
- The literal value for the environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.File">
- <summary>
- The value for a file-based environment variable. NAnt will convert
- it to an absolute filename.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.Directory">
- <summary>
- The value for a directory-based environment variable. NAnt will
- convert it to an absolute path.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.Path">
- <summary>
- The value for a PATH like environment variable. You can use
- <c>:</c> or <c>;</c> as path separators and NAnt will convert it to
- the platform's local conventions.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.PathSet">
- <summary>
- Sets a single environment variable and treats it like a PATH -
- ensures the right separator for the local platform is used.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.Value">
- <summary>
- Gets the value of the environment variable.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.IfDefined">
- <summary>
- Indicates if the environment variable should be passed to the
- external program. If <see langword="true" /> then the environment
- variable will be passed; otherwise, skipped. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariable.UnlessDefined">
- <summary>
- Indicates if the environment variable should not be passed to the
- external program. If <see langword="false" /> then the environment
- variable will be passed; otherwise, skipped. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.EnvironmentSet">
- <summary>
- A set of environment variables.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentSet.Options">
- <summary>
- Environment variable to pass to a program.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentSet.EnvironmentVariables">
- <summary>
- Environment variable to pass to a program.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.EnvironmentVariableCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.#ctor(NAnt.Core.Types.EnvironmentVariable[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Add(NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariable[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.AddRange(NAnt.Core.Types.EnvironmentVariableCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with value
- <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.CopyTo(NAnt.Core.Types.EnvironmentVariable[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.IndexOf(NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.EnvironmentVariable"/>. If the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Insert(System.Int32,NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableCollection.Remove(NAnt.Core.Types.EnvironmentVariable)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariableCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> with the specified name.
- </summary>
- <param name="name">The name of the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.EnvironmentVariableEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.EnvironmentVariable"/> elements of a <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.#ctor(NAnt.Core.Types.EnvironmentVariableCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.EnvironmentVariableEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.EnvironmentVariableCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.EnvironmentVariableEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.EnvironmentVariableEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.Formatter.Property">
- <summary>
- The name of the NAnt property to set.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Formatter.Pattern">
- <summary>
- The string pattern to use to format the property.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Formatter.IfDefined">
- <summary>
- Indicates if the formatter should be used to format the timestamp.
- If <see langword="true" /> then the formatter will be used;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Formatter.UnlessDefined">
- <summary>
- Indicates if the formatter should be not used to format the
- timestamp. If <see langword="false" /> then the formatter will be
- used; otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.FormatterCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.Formatter"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.FormatterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.#ctor(NAnt.Core.Types.Formatter[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.Formatter"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.Add(NAnt.Core.Types.Formatter)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.Formatter"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.Formatter[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.Formatter"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.Formatter"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.AddRange(NAnt.Core.Types.FormatterCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.FormatterCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.Contains(NAnt.Core.Types.Formatter)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Formatter"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.CopyTo(NAnt.Core.Types.Formatter[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.IndexOf(NAnt.Core.Types.Formatter)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Formatter"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.Formatter"/>. If the <see cref="T:NAnt.Core.Types.Formatter"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.Insert(System.Int32,NAnt.Core.Types.Formatter)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.Formatter"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterCollection.Remove(NAnt.Core.Types.Formatter)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Formatter"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.FormatterCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.Core.Types.FormatterEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.Formatter"/> elements of a <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.FormatterEnumerator.#ctor(NAnt.Core.Types.FormatterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.FormatterEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.FormatterCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.FormatterEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.FormatterEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.FormatterEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.ManagedExecution">
- <summary>
- Specifies the execution mode for managed applications.
- </summary>
- <remarks>
- <para>
- For backward compatibility, the following string values can also be
- used in build files:
- </para>
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Corresponding field</description>
- </listheader>
- <item>
- <term>"true"</term>
- <description><see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/></description>
- </item>
- <item>
- <term>"false"</term>
- <description><see cref="F:NAnt.Core.Types.ManagedExecution.Default"/></description>
- </item>
- </list>
- <para>
- Even if set to <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>, the operating system can still
- run the program as a managed application.
- </para>
- <para>On Linux this can be done through <b>binfmt_misc</b>, while on
- Windows installing the .NET Framework redistributable caused managed
- applications to run on the MS CLR by default.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Core.Types.ManagedExecution.Default">
- <summary>
- Do not threat the program as a managed application.
- </summary>
- </member>
- <member name="F:NAnt.Core.Types.ManagedExecution.Auto">
- <summary>
- Leave it up to the CLR to determine which specific version of
- the CLR will be used to run the application.
- </summary>
- </member>
- <member name="F:NAnt.Core.Types.ManagedExecution.Strict">
- <summary>
- Forces an application to run against the currently targeted
- version of a given CLR.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.ManagedExecutionConverter">
- <summary>
- Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
- case-insensitive conversion of "true" to
- <see cref="F:NAnt.Core.Types.ManagedExecution.Auto"/> and "false" to
- <see cref="F:NAnt.Core.Types.ManagedExecution.Default"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ManagedExecutionConverter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.ManagedExecutionConverter"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.ManagedExecutionConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <summary>
- Converts the given object to the type of this converter, using the
- specified context and culture information.
- </summary>
- <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
- <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
- <param name="value">The <see cref="T:System.Object"/> to convert.</param>
- <returns>
- An <see cref="T:System.Object"/> that represents the converted value.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.Option">
- <summary>
- Represents an option.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Option.#ctor(System.String,System.String)">
- <summary>
- name, value constructor
- </summary>
- <param name="name"></param>
- <param name="value"></param>
- </member>
- <member name="M:NAnt.Core.Types.Option.#ctor">
- <summary>
- Default constructor
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Option.OptionName">
- <summary>
- Name of the option.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Option.Value">
- <summary>
- Value of the option. The default is <see langword="null" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Option.IfDefined">
- <summary>
- Indicates if the option should be passed to the task.
- If <see langword="true" /> then the option will be passed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Option.UnlessDefined">
- <summary>
- Indicates if the option should not be passed to the task.
- If <see langword="false" /> then the option will be passed;
- otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.OptionCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.Option"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.OptionCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.#ctor(NAnt.Core.Types.Option[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.Option"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Add(NAnt.Core.Types.Option)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.Option"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.Option[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.Option"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.Option"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.AddRange(NAnt.Core.Types.OptionCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.OptionCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Contains(NAnt.Core.Types.Option)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Option"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Option"/> for the specified
- task is in the collection.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.Types.Option"/> should be located in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.Option"/> for the specified
- task is found in the collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.CopyTo(NAnt.Core.Types.Option[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.IndexOf(NAnt.Core.Types.Option)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Option"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.Option"/>. If the <see cref="T:NAnt.Core.Types.Option"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Insert(System.Int32,NAnt.Core.Types.Option)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.Option"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.OptionEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionCollection.Remove(NAnt.Core.Types.Option)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Option"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.OptionCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.OptionCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.Option"/> with the specified name.
- </summary>
- <param name="name">The name of the option that should be located in the collection.</param>
- </member>
- <member name="T:NAnt.Core.Types.OptionEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.Option"/> elements of a <see cref="T:NAnt.Core.Types.OptionCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.OptionEnumerator.#ctor(NAnt.Core.Types.OptionCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.OptionEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.OptionCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.OptionEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.OptionEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.OptionEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.PathElement">
- <summary>
- Represents a nested path element.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.File">
- <summary>
- The name of a file to add to the path. Will be replaced with
- the absolute path of the file.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.Directory">
- <summary>
- The name of a directory to add to the path. Will be replaced with
- the absolute path of the directory.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.Path">
- <summary>
- A string that will be treated as a path-like string. You can use
- <c>:</c> or <c>;</c> as path separators and NAnt will convert it
- to the platform's local conventions, while resolving references
- to environment variables.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.IfDefined">
- <summary>
- If <see langword="true" /> then the entry will be added to the
- path; otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.UnlessDefined">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Types.PathElement.IfDefined"/>. If <see langword="false"/>
- then the entry will be added to the path; otherwise, skipped.
- The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PathElement.Parts">
- <summary>
- Gets the parts of a path represented by this element.
- </summary>
- <value>
- A <see cref="T:System.Collections.Specialized.StringCollection"/> containing the parts of a path
- represented by this element.
- </value>
- </member>
- <member name="T:NAnt.Core.Types.PathSet">
- <summary>
- <para>
- 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.
- </para>
- </summary>
- <example>
- <para>
- Define a global <c><path></c> that can be referenced by other
- tasks or types.
- </para>
- <code>
- <![CDATA[
- <path id="includes-path">
- <pathelement path="%INCLUDE%" />
- <pathelement dir="${build.dir}/include" />
- </path>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.PathSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.#ctor(NAnt.Core.Project,System.String)">
- <summary>
- Invoked by <see cref="T:NAnt.Core.Element.AttributeConfigurator"/> for build
- attributes with an underlying <see cref="T:NAnt.Core.Types.PathSet"/> type.
- </summary>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
- <param name="path">The string representing a path.</param>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.ToString">
- <summary>
- Returns a textual representation of the path, which can be used as
- PATH environment variable definition.
- </summary>
- <returns>
- A textual representation of the path.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.AddPath(NAnt.Core.Types.PathSet)">
- <summary>
- Defines a set of path elements to add to the current path.
- </summary>
- <param name="path">The <see cref="T:NAnt.Core.Types.PathSet"/> to add.</param>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.AddPathElement(NAnt.Core.Types.PathElement)">
- <summary>
- Defines a path element to add to the current path.
- </summary>
- <param name="pathElement">The <see cref="T:NAnt.Core.Types.PathElement"/> to add.</param>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.GetElements">
- <summary>
- Returns all path elements defined by this path object.
- </summary>
- <returns>
- A list of path elements.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.PathSet.TranslatePath(NAnt.Core.Project,System.String)">
- <summary>
- Splits a PATH (with ; or : as separators) into its parts, while
- resolving references to environment variables.
- </summary>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> to be used to resolve relative paths.</param>
- <param name="source">The path to translate.</param>
- <returns>
- A PATH split up its parts, with references to environment variables
- resolved and duplicate entries removed.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.Pattern.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Pattern"/> class.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Pattern.PatternName">
- <summary>
- The name pattern to include/exclude.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Pattern.IfDefined">
- <summary>
- If <see langword="true" /> then the pattern will be used;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Pattern.UnlessDefined">
- <summary>
- If <see langword="false" /> then the pattern will be used;
- otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.PatternCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.Pattern"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.Clear">
- <summary>
- Removes all items from the <see cref="T:NAnt.Core.Types.PatternCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.Add(NAnt.Core.Types.Pattern)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.Pattern"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.Pattern[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.Pattern"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.Pattern"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.AddRange(NAnt.Core.Types.PatternCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.PatternCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.Contains(NAnt.Core.Types.Pattern)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.Pattern"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.CopyTo(NAnt.Core.Types.Pattern[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array,
- starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.IndexOf(NAnt.Core.Types.Pattern)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.Pattern"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.Pattern"/>. If the <see cref="T:NAnt.Core.Types.Pattern"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.Insert(System.Int32,NAnt.Core.Types.Pattern)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.Pattern"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.PatternEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.PatternCollection.Remove(NAnt.Core.Types.Pattern)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.Pattern"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.PatternCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.Core.Types.PatternEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.Pattern"/> elements of a <see cref="T:NAnt.Core.Types.PatternCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.PatternEnumerator.#ctor(NAnt.Core.Types.PatternCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.PatternCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.PatternEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.PatternEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PatternEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.PatternEnumerator.System#Collections#IEnumerator#Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.PatternSet">
- <summary>
- A set of patterns, mostly used to include or exclude certain files.
- </summary>
- <remarks>
- <para>
- The individual patterns support <c>if</c> and <c>unless</c> attributes
- to specify that the element should only be used if or unless a given
- condition is met.
- </para>
- <para>
- The <see cref="P:NAnt.Core.Types.PatternSet.IncludesFile"/> and <see cref="P:NAnt.Core.Types.PatternSet.ExcludesFile"/>
- elements load patterns from a file. When the file is a relative path,
- it will be resolved relative to the project base directory in which
- the patternset is defined. Each line of this file is taken to be a
- pattern.
- </para>
- <para>
- Patterns can be grouped to sets, and later be referenced by their
- <see cref="P:NAnt.Core.DataTypeBase.ID"/>.
- </para>
- <para>
- When used as a standalone element (global type), any properties that
- are referenced will be resolved when the definition is processed, not
- when it actually used. Passing a reference to a nested build file
- will not cause the properties to be re-evaluated.
- </para>
- <para>
- To improve reuse of globally defined patternsets, avoid referencing
- any properties altogether.
- </para>
- </remarks>
- <example>
- <para>
- Define a set of patterns that matches all .cs files that do not contain
- the text <c>Test</c> in their name.
- </para>
- <code>
- <![CDATA[
- <patternset id="non.test.sources">
- <include name="**/*.cs" />
- <exclude name="**/*Test*" />
- </patternset>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Define two sets. One holding C# sources, and one holding VB sources.
- Both sets only include test sources when the <c>test</c> property is
- set. A third set combines both C# and VB sources.
- </para>
- <code>
- <![CDATA[
- <patternset id="cs.sources">
- <include name="src/**/*.cs" />
- <include name="test/**/*.cs" if=${property::exist('test')}" />
- </patternset>
-
- <patternset id="vb.sources">
- <include name="src/**/*.vb" />
- <include name="test/**/*.vb" if=${property::exist('test')}" />
- </patternset>
-
- <patternset id="all.sources">
- <patternset refid="cs.sources" />
- <patternset refid="vb.sources" />
- </patternset>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Define a set from patterns in a file.
- </para>
- <code>
- <![CDATA[
- <patternset id="sources">
- <includesfile name="test.sources" />
- <includesfile name="non.test.sources" />
- </patternset>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Defines a patternset with patterns that are loaded from an external
- file, and shows the behavior when that patternset is passed as a
- reference to a nested build script.
- </para>
- <para>
- External file "c:\foo\build\service.lst" holding patterns
- of source files to include for the Foo.Service assembly:
- </para>
- <code>
- <![CDATA[
- AssemblyInfo.cs
- *Channel.cs
- ServiceFactory.cs]]></code>
- <para>
- Main build script located in "c:\foo\default.build":
- </para>
- <code>
- <![CDATA[
- <project name="main" default="build">
- <property name="build.debug" value="true" />
-
- <patternset id="service.sources">
- <include name="TraceListener.cs" if="${build.debug}" />
- <includesfile name="build/service.lst" />
- </patternset>
-
- <property name="build.debug" value="false" />
-
- <target name="build">
- <nant buildfile="service/default.build" inheritrefs="true" />
- </target>
- </project>]]></code>
- <para>
- Nested build script located in "c:\foo\services\default.build"
- which uses the patternset to feed sources files to the C# compiler:
- </para>
- <code>
- <![CDATA[
- <project name="service" default="build">
- <target name="build">
- <csc output="../bin/Foo.Service.dll" target="library">
- <fileset basedir="src">
- <patternset refid="service.sources" />
- </fileset>
- </csc>
- </target>
- </project>]]></code>
- <para>
- At the time when the patternset is used in the "service"
- build script, the following source files in "c:\foo\services\src"
- match the defined patterns:
- </para>
- <code>
- <![CDATA[
- AssemblyInfo.cs
- MsmqChannel.cs
- SmtpChannel.cs
- ServiceFactory.cs
- TraceListener.cs]]></code>
- <para>
- You should have observed that:
- </para>
- <list type="bullet">
- <item>
- <description>
- although the patternset is used from the "service"
- build script, the path to the external file is resolved relative
- to the base directory of the "main" build script in
- which the patternset is defined.
- </description>
- </item>
- <item>
- <description>
- the "TraceListener.cs" file is included, even though
- the "build.debug" property was changed to <b>false</b>
- after the patternset was defined (but before it was passed to
- the nested build, and used).
- </description>
- </item>
- </list>
- </example>
- <seealso cref="T:NAnt.Core.Types.FileSet"/>
- </member>
- <member name="M:NAnt.Core.Types.PatternSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.PatternSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.PatternSet.Append(NAnt.Core.Types.PatternSet)">
- <summary>
- Adds a nested set of patterns, or references other standalone
- patternset.
- </summary>
- <param name="patternSet">The <see cref="T:NAnt.Core.Types.PatternSet"/> to add.</param>
- </member>
- <member name="P:NAnt.Core.Types.PatternSet.Include">
- <summary>
- Defines a single pattern for files to include.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PatternSet.IncludesFile">
- <summary>
- Loads multiple patterns of files to include from a given file, set
- using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PatternSet.Exclude">
- <summary>
- Defines a single pattern for files to exclude.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.PatternSet.ExcludesFile">
- <summary>
- Loads multiple patterns of files to exclude from a given file, set
- using the <see cref="P:NAnt.Core.Types.Pattern.PatternName"/> parameter.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.Proxy">
- <summary>
- Contains HTTP proxy settings used to process requests to Internet
- resources.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Proxy.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.Proxy"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.Proxy.GetWebProxy">
- <summary>
- Gets a <see cref="T:System.Net.WebProxy"/> instance representing the current
- <see cref="T:NAnt.Core.Types.Proxy"/>.
- </summary>
- <returns>
- A <see cref="T:System.Net.WebProxy"/> instance representing the current
- <see cref="T:NAnt.Core.Types.Proxy"/>, or <see langword="GlobalProxySelection.Select"/>
- if this proxy should not be used to connect to the external resource.
- </returns>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.Host">
- <summary>
- The name of the proxy host.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.Port">
- <summary>
- The port number on <see cref="P:NAnt.Core.Types.Proxy.Host"/> to use.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.BypassOnLocal">
- <summary>
- Specifies whether to bypass the proxy server for local addresses.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.Credentials">
- <summary>
- The credentials to submit to the proxy server for authentication.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.IfDefined">
- <summary>
- Indicates if the proxy should be used to connect to the external
- resource. If <see langword="true" /> then the proxy will be used;
- otherwise, not. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Proxy.UnlessDefined">
- <summary>
- Indicates if the proxy should not be used to connect to the external
- resource. If <see langword="false" /> then the proxy will be used;
- otherwise, not. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.RawXml">
- <summary>
- Represents an element of which the XML is processed by its parent task
- or type.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.RawXml.Xml">
- <summary>
- Gets the XML that this element represents.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.RawXml.CustomXmlProcessing">
- <summary>
- Gets a value indicating whether the element is performing additional
- processing using the <see cref="T:System.Xml.XmlNode"/> that was use to
- initialize the element.
- </summary>
- <value>
- <see langword="true"/>, as the XML that represents this build
- element is processed by the containing task or type.
- </value>
- </member>
- <member name="T:NAnt.Core.Types.Token">
- <summary>
- ReplaceTokens filter token.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Token.Key">
- <summary>
- Token to be replaced.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Token.Value">
- <summary>
- New value of token.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Token.IfDefined">
- <summary>
- Indicates if the token should be used to replace values.
- If <see langword="true" /> then the token will be used;
- otherwise, not. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.Token.UnlessDefined">
- <summary>
- Indicates if the token should not be used to replace values.
- If <see langword="false" /> then the token will be used;
- otherwise, not. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.XmlNamespace">
- <summary>
- Represents an XML namespace.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespace.Prefix">
- <summary>
- The prefix to associate with the namespace.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespace.Uri">
- <summary>
- The associated XML namespace URI.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespace.IfDefined">
- <summary>
- Indicates if the namespace should be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- If <see langword="true"/> then the namespace will be added;
- otherwise, skipped. The default is <see langword="true"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespace.UnlessDefined">
- <summary>
- Indicates if the namespace should not be added to the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- list. If <see langword="false"/> then the parameter will be
- added; otherwise, skipped. The default is <see langword="false"/>.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.XmlNamespaceCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.#ctor(NAnt.Core.Types.XmlNamespace[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Add(NAnt.Core.Types.XmlNamespace)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.XmlNamespace"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespace[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespace"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.AddRange(NAnt.Core.Types.XmlNamespaceCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(NAnt.Core.Types.XmlNamespace)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XmlNamespace"/> with
- value <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.CopyTo(NAnt.Core.Types.XmlNamespace[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.IndexOf(NAnt.Core.Types.XmlNamespace)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XmlNamespace"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.XmlNamespace"/>. If the <see cref="T:NAnt.Core.Types.XmlNamespace"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Insert(System.Int32,NAnt.Core.Types.XmlNamespace)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.XmlNamespace"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceCollection.Remove(NAnt.Core.Types.XmlNamespace)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XmlNamespace"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespaceCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.XmlNamespace"/> with the specified prefix.
- </summary>
- <param name="value">The prefix of the <see cref="T:NAnt.Core.Types.XmlNamespace"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.XmlNamespaceEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.XmlNamespace"/> elements of a <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.#ctor(NAnt.Core.Types.XmlNamespaceCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XmlNamespaceEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.XmlNamespaceCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XmlNamespaceEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XmlNamespaceEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.XsltExtensionObject">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObject.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- class.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.NamespaceUri">
- <summary>
- The namespace URI to associate with the extension object.
- </summary>
- <value>
- The namespace URI to associate with the extension object, or
- <see cref="F:System.String.Empty"/> if not set.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.TypeName">
- <summary>
- The full type name of the XSLT extension object.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.AssemblyPath">
- <summary>
- The assembly which contains the XSLT extension object.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.IfDefined">
- <summary>
- Indicates if the extension object should be added to the XSLT argument
- list. If <see langword="true" /> then the extension object will be
- added; otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObject.UnlessDefined">
- <summary>
- Indicates if the extension object should not be added to the XSLT argument
- list. If <see langword="false" /> then the extension object will be
- added; otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.XsltExtensionObjectCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor">
- <summary>
- Initializes a new instance of the
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
- <summary>
- Initializes a new instance of the
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
- specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.#ctor(NAnt.Core.Types.XsltExtensionObject[])">
- <summary>
- Initializes a new instance of the
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/> class with the
- specified array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Add(NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to be added
- to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObject[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> array to the
- end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.AddRange(NAnt.Core.Types.XsltExtensionObjectCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
- to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>
- to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is in the
- collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to locate
- in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the
- specified value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the
- collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- with value <paramref name="value"/> is found in the collection;
- otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.CopyTo(NAnt.Core.Types.XsltExtensionObject[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array,
- starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the
- destination of the elements copied from the collection. The array
- must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/>
- at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.IndexOf(NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> object for
- which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>. If the
- <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> is not currently a member of the
- collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Insert(System.Int32,NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> into the collection at
- the specified index.
- </summary>
- <param name="index">The zero-based index at which
- <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to
- insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> for the entire
- collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectCollection.Remove(NAnt.Core.Types.XsltExtensionObject)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> to remove
- from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get
- or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObjectCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> with the specified name.
- </summary>
- <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/>
- to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.XsltExtensionObjectEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.XsltExtensionObject"/> elements of a
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.#ctor(NAnt.Core.Types.XsltExtensionObjectCollection)">
- <summary>
- Initializes a new instance of the
- <see cref="T:NAnt.Core.Types.XsltExtensionObjectEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.XsltExtensionObjectCollection"/>.
- </summary>
- <param name="arguments">The collection that should be
- enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltExtensionObjectEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltExtensionObjectEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Types.XsltParameter">
- <summary>
- Represents an XSLT parameter.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameter"/>
- class.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.ParameterName">
- <summary>
- The name of the XSLT parameter.
- </summary>
- <value>
- The name of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
- not set.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.NamespaceUri">
- <summary>
- The namespace URI to associate with the parameter.
- </summary>
- <value>
- The namespace URI to associate with the parameter, or
- <see cref="F:System.String.Empty"/> if not set.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.Value">
- <summary>
- The value of the XSLT parameter.
- </summary>
- <value>
- The value of the XSLT parameter, or <see cref="F:System.String.Empty"/> if
- not set.
- </value>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.IfDefined">
- <summary>
- Indicates if the parameter should be added to the XSLT argument list.
- If <see langword="true" /> then the parameter will be added;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameter.UnlessDefined">
- <summary>
- Indicates if the parameter should not be added to the XSLT argument
- list. If <see langword="false" /> then the parameter will be
- added; otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.Core.Types.XsltParameterCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
- with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.#ctor(NAnt.Core.Types.XsltParameter[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Types.XsltParameter"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Add(NAnt.Core.Types.XsltParameter)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Types.XsltParameter"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameter[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameter"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Types.XsltParameter"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.AddRange(NAnt.Core.Types.XsltParameterCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Types.XsltParameterCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(NAnt.Core.Types.XsltParameter)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.Types.XsltParameter"/> with
- value <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.CopyTo(NAnt.Core.Types.XsltParameter[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.IndexOf(NAnt.Core.Types.XsltParameter)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Types.XsltParameter"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Types.XsltParameter"/>. If the <see cref="T:NAnt.Core.Types.XsltParameter"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Insert(System.Int32,NAnt.Core.Types.XsltParameter)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Types.XsltParameter"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterCollection.Remove(NAnt.Core.Types.XsltParameter)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Types.XsltParameter"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameterCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Types.XsltParameter"/> with the specified name.
- </summary>
- <param name="value">The name of the <see cref="T:NAnt.Core.Types.XsltParameter"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Types.XsltParameterEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Types.XsltParameter"/> elements of a <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterEnumerator.#ctor(NAnt.Core.Types.XsltParameterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Types.XsltParameterEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Types.XsltParameterCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Types.XsltParameterEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Types.XsltParameterEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.AssemblyResolver">
- <summary>
- Resolves assemblies by caching assemblies that were loaded.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor">
- <summary>
- Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.#ctor(NAnt.Core.Task)">
- <summary>
- Initializes an instanse of the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- class in the context of the given <see cref="T:NAnt.Core.Task"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.Attach">
- <summary>
- Installs the assembly resolver by hooking up to the
- <see cref="F:System.AppDomain.AssemblyResolve"/> event.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.Detach">
- <summary>
- Uninstalls the assembly resolver.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyResolve(System.Object,System.ResolveEventArgs)">
- <summary>
- Resolves an assembly not found by the system using the assembly
- cache.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="args">A <see cref="T:System.ResolveEventArgs"/> that contains the event data.</param>
- <returns>
- The loaded assembly, or <see langword="null"/> if not found.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.AssemblyLoad(System.Object,System.AssemblyLoadEventArgs)">
- <summary>
- Occurs when an assembly is loaded. The loaded assembly is added
- to the assembly cache.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="args">An <see cref="T:System.AssemblyLoadEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Util.AssemblyResolver.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- The actual logging is delegated to the <see cref="T:NAnt.Core.Task"/> in which
- the <see cref="T:NAnt.Core.Util.AssemblyResolver"/> is executing
- </remarks>
- </member>
- <member name="F:NAnt.Core.Util.AssemblyResolver._assemblyCache">
- <summary>
- Holds the loaded assemblies.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.AssemblyResolver._task">
- <summary>
- Holds the <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- is executing.
- </summary>
- <value>
- The <see cref="T:NAnt.Core.Task"/> in which the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- is executing or <see langword="null"/> if the <see cref="T:NAnt.Core.Util.AssemblyResolver"/>
- is not executing in the context of a <see cref="T:NAnt.Core.Task"/>.
- </value>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgument">
- <summary>
- Represents a valid command-line argument.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.Finish(System.Object)">
- <summary>
- Sets the value of the argument on the specified object.
- </summary>
- <param name="destination">The object on which the value of the argument should be set.</param>
- <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">The argument is required and no value was specified.</exception>
- <exception cref="T:System.NotSupportedException">
- <para>
- The matching property is collection-based, but is not initialized
- and cannot be written to.
- </para>
- <para>-or-</para>
- <para>
- The matching property is collection-based, but has no strongly-typed
- Add method.
- </para>
- <para>-or-</para>
- <para>
- The matching property is collection-based, but the signature of the
- Add method is not supported.
- </para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.SetValue(System.String)">
- <summary>
- Assigns the specified value to the argument.
- </summary>
- <param name="value">The value that should be assigned to the argument.</param>
- <exception cref="T:NAnt.Core.Util.CommandLineArgumentException">
- <para>Duplicate argument.</para>
- <para>-or-</para>
- <para>Invalid value.</para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.IsNameValueCollectionType(System.Type)">
- <summary>
- Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is a
- <see cref="T:System.Collections.Specialized.NameValueCollection"/>.
- </summary>
- <value>
- <see langword="true"/> if <paramref name="type"/> can be assigned
- to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.IsCollectionType(System.Type)">
- <summary>
- Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is collection-based.
- </summary>
- <value>
- <see langword="true"/> if <paramref name="type"/> can be assigned
- to <see cref="T:System.Collections.ICollection"/> and is not backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
- that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgument.IsArrayType(System.Type)">
- <summary>
- Indicates whether the specified <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> is an array.
- </summary>
- <value>
- <see langword="true"/> if <paramref name="type"/> is an array;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.Property">
- <summary>
- Gets the property that backs the argument.
- </summary>
- <value>
- The property that backs the arguments.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.ValueType">
- <summary>
- Gets the underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
- </summary>
- <value>
- The underlying <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument.
- </value>
- <remarks>
- If the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the argument is a collection type,
- this property will returns the underlying type of that collection.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.LongName">
- <summary>
- Gets the long name of the argument.
- </summary>
- <value>The long name of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.ShortName">
- <summary>
- Gets the short name of the argument.
- </summary>
- <value>The short name of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.Description">
- <summary>
- Gets the description of the argument.
- </summary>
- <value>The description of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsRequired">
- <summary>
- Gets a value indicating whether the argument is required.
- </summary>
- <value>
- <see langword="true" /> if the argument is required; otherwise,
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.SeenValue">
- <summary>
- Gets a value indicating whether a mathing command-line argument
- was already found.
- </summary>
- <value>
- <see langword="true" /> if a matching command-line argument was
- already found; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.AllowMultiple">
- <summary>
- Gets a value indicating whether the argument can be specified multiple
- times.
- </summary>
- <value>
- <see langword="true" /> if the argument may be specified multiple
- times; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.Unique">
- <summary>
- Gets a value indicating whether the argument can only be specified once
- with a certain value.
- </summary>
- <value>
- <see langword="true" /> if the argument should always have a unique
- value; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.Type">
- <summary>
- Gets the <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument
- is applied.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> of the property to which the argument is
- applied.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsCollection">
- <summary>
- Gets a value indicating whether the argument is collection-based.
- </summary>
- <value>
- <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
- that can be assigned to <see cref="T:System.Collections.ICollection"/> and is not backed
- by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/> that can be assigned to
- <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsNameValueCollection">
- <summary>
- Gets a value indicating whether the argument is a set of name/value
- pairs.
- </summary>
- <value>
- <see langword="true"/> if the argument is backed by a <see cref="P:NAnt.Core.Util.CommandLineArgument.Type"/>
- that can be assigned to <see cref="T:System.Collections.Specialized.NameValueCollection"/>; otherwise,
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsArray">
- <summary>
- Gets a value indicating whether the argument is array-based.
- </summary>
- <value>
- <see langword="true" /> if the argument is backed by an array;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsDefault">
- <summary>
- Gets a value indicating whether the argument is the default argument.
- </summary>
- <value>
- <see langword="true" /> if the argument is the default argument;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgument.IsExclusive">
- <summary>
- Gets a value indicating whether the argument cannot be combined with
- other arguments.
- </summary>
- <value>
- <see langword="true" /> if the argument cannot be combined with other
- arguments; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentAttribute">
- <summary>
- Allows control of command line parsing.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
- with the specified argument type.
- </summary>
- <param name="argumentType">Specifies the checking to be done on the argument.</param>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Type">
- <summary>
- Gets or sets the checking to be done on the argument.
- </summary>
- <value>The checking that should be done on the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Name">
- <summary>
- Gets or sets the long name of the argument.
- </summary>
- <value>The long name of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.ShortName">
- <summary>
- Gets or sets the short name of the argument.
- </summary>
- <value>The short name of the argument.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentAttribute.Description">
- <summary>
- Gets or sets the description of the argument.
- </summary>
- <value>The description of the argument.</value>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
- with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.#ctor(NAnt.Core.Util.CommandLineArgument[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Add(NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Adds a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgument[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.AddRange(NAnt.Core.Util.CommandLineArgumentCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Contains(NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.CopyTo(NAnt.Core.Util.CommandLineArgument[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.IndexOf(NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.Util.CommandLineArgument"/>. If the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Insert(System.Int32,NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.Util.CommandLineArgument"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentCollection.Remove(NAnt.Core.Util.CommandLineArgument)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> with the specified name.
- </summary>
- <param name="name">The name of the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> to get.</param>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.Util.CommandLineArgument"/> elements of a <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.#ctor(NAnt.Core.Util.CommandLineArgumentCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.Util.CommandLineArgumentCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineArgumentEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentException">
- <summary>
- The exception that is thrown when one of the command-line arguments provided
- is not valid.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
- with a descriptive message.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
- with a descriptive message and an inner exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineArgumentException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentException"/> class
- with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineArgumentTypes">
- <summary>
- Used to control parsing of command-line arguments.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Required">
- <summary>
- Indicates that this field is required. An error will be displayed
- if it is not present when parsing arguments.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Unique">
- <summary>
- Only valid in conjunction with Multiple.
- Duplicate values will result in an error.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Multiple">
- <summary>
- Inidicates that the argument may be specified more than once.
- Only valid if the argument is a collection
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.Exclusive">
- <summary>
- Inidicates that if this argument is specified, no other arguments may be specified.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.AtMostOnce">
- <summary>
- 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.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.CommandLineArgumentTypes.MultipleUnique">
- <summary>
- The default type for collection arguments.
- The argument is permitted to occur multiple times, but duplicate
- values will cause an error to be reported.
- </summary>
- </member>
- <member name="T:NAnt.Core.Util.CommandLineParser">
- <summary>
- Commandline parser.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.#ctor(System.Type,System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineParser"/> class
- using possible arguments deducted from the specific <see cref="T:System.Type"/>.
- </summary>
- <param name="argumentSpecification">The <see cref="T:System.Type"/> from which the possible command-line arguments should be retrieved.</param>
- <param name="supportsResponseFile">A <see cref="T:System.Boolean"/> value indicating whether or not a response file is able to be used. </param>
- <exception cref="T:System.ArgumentNullException"><paramref name="argumentSpecification"/> is a null reference.</exception>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.Parse(System.String[],System.Object)">
- <summary>
- Parses an argument list.
- </summary>
- <param name="args">The arguments to parse.</param>
- <param name="destination">The destination object on which properties will be set corresponding to the specified arguments.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="destination"/> is a null reference.</exception>
- <exception cref="T:System.ArgumentException">The <see cref="T:System.Type"/> of <paramref name="destination"/> does not match the argument specification that was used to initialize the parser.</exception>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.ParseArguments(System.String,System.Char[])">
- <summary>
- 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.
- </summary>
- <param name="sourceString"></param>
- <param name="delimiters"></param>
- <returns>the array of strings</returns>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.ProcessResponseFile(System.String)">
- <summary>
- Read a response file and parse the arguments as usual.
- </summary>
- <param name="file">The response file to load arguments</param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.ParseArgumentList(System.String[])">
- <summary>
- Parse the argument list using the
- </summary>
- <param name="args"></param>
- </member>
- <member name="M:NAnt.Core.Util.CommandLineParser.GetCommandLineAttribute(System.Reflection.PropertyInfo)">
- <summary>
- Returns the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied
- on the specified property.
- </summary>
- <param name="propertyInfo">The property of which applied <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> should be returned.</param>
- <returns>
- The <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> that's applied to the
- <paramref name="propertyInfo"/>, or a null reference if none was applied.
- </returns>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineParser.LogoBanner">
- <summary>
- Gets a logo banner using version and copyright attributes defined on the
- <see cref="M:System.Reflection.Assembly.GetEntryAssembly"/> or the
- <see cref="M:System.Reflection.Assembly.GetCallingAssembly"/>.
- </summary>
- <value>
- A logo banner.
- </value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineParser.Usage">
- <summary>
- Gets the usage instructions.
- </summary>
- <value>The usage instructions.</value>
- </member>
- <member name="P:NAnt.Core.Util.CommandLineParser.NoArgs">
- <summary>
- Gets a value indicating whether no arguments were specified on the
- command line.
- </summary>
- </member>
- <member name="T:NAnt.Core.Util.DefaultCommandLineArgumentAttribute">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.DefaultCommandLineArgumentAttribute.#ctor(NAnt.Core.Util.CommandLineArgumentTypes)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.CommandLineArgumentAttribute"/> class
- with the specified argument type.
- </summary>
- <param name="argumentType">Specifies the checking to be done on the argument.</param>
- </member>
- <member name="T:NAnt.Core.Util.FileUtils">
- <summary>
- Provides modified version for Copy and Move from the File class that
- allow for filter chain processing.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.CopyFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
- <summary>
- Copies a file filtering its content through the filter chain.
- </summary>
- <param name="sourceFileName">The file to copy</param>
- <param name="destFileName">The file to copy to</param>
- <param name="filterChain">Chain of filters to apply when copying, or <see langword="null" /> is no filters should be applied.</param>
- <param name="inputEncoding">The encoding used to read the soure file.</param>
- <param name="outputEncoding">The encoding used to write the destination file.</param>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.MoveFile(System.String,System.String,NAnt.Core.Filters.FilterChain,System.Text.Encoding,System.Text.Encoding)">
- <summary>
- Moves a file filtering its content through the filter chain.
- </summary>
- <param name="sourceFileName">The file to move</param>
- <param name="destFileName">The file to move move to</param>
- <param name="filterChain">Chain of filters to apply when moving, or <see langword="null" /> is no filters should be applied.</param>
- <param name="inputEncoding">The encoding used to read the soure file.</param>
- <param name="outputEncoding">The encoding used to write the destination file.</param>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.GetTempDirectory">
- <summary>
- Returns a uniquely named empty temporary directory on disk.
- </summary>
- <value>
- A <see cref="T:System.IO.DirectoryInfo"/> representing the temporary directory.
- </value>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.CombinePaths(System.String,System.String)">
- <summary>
- Combines two path strings.
- </summary>
- <param name="path1">The first path.</param>
- <param name="path2">The second path.</param>
- <returns>
- A string containing the combined paths. If one of the specified
- paths is a zero-length string, this method returns the other path.
- If <paramref name="path2"/> contains an absolute path, this method
- returns <paramref name="path2"/>.
- </returns>
- <remarks>
- <para>
- On *nix, processing is delegated to <see cref="M:System.IO.Path.Combine(System.String,System.String)"/>.
- </para>
- <para>
- On Windows, this method normalized the paths to avoid running into
- the 260 character limit of a path and converts forward slashes in
- both <paramref name="path1"/> and <paramref name="path2"/> to
- the platform's directory separator character.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.GetFullPath(System.String)">
- <summary>
- Returns Absolute Path (Fix for 260 Char Limit of Path.GetFullPath(...))
- </summary>
- <param name="path">The file or directory for which to obtain absolute path information.</param>
- <returns>Path Resolved</returns>
- <exception cref="T:System.ArgumentException">path is a zero-length string, contains only white space or contains one or more invalid characters as defined by <see cref="F:System.IO.Path.InvalidPathChars"/>.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="path"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:NAnt.Core.Util.FileUtils.GetHomeDirectory">
- <summary>
- Returns the home directory of the current user.
- </summary>
- <returns>
- The home directory of the current user.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.GacCache">
- <summary>
- Helper class for determining whether assemblies are located in the
- Global Assembly Cache.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.GacCache.#ctor(NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.GacCache"/> class in
- the context of the given <see cref="P:NAnt.Core.Util.GacCache.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.GacCache.IsAssemblyInGac(System.String)">
- <summary>
- Determines whether an assembly is installed in the Global
- Assembly Cache given its file name or path.
- </summary>
- <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
- <returns>
- <see langword="true"/> if <paramref name="assemblyFile"/> is
- installed in the Global Assembly Cache; otherwise,
- <see langword="false"/>.
- </returns>
- <remarks>
- <para>
- To determine whether the specified assembly is installed in the
- Global Assembly Cache, the assembly is loaded into a separate
- <see cref="T:System.AppDomain"/>.
- </para>
- <para>
- If the family of the current runtime framework does not match the
- family of the current target framework, this method will return
- <see langword="false"/> for all assemblies as there's no way to
- determine whether a given assembly is in the Global Assembly Cache
- for another framework family than the family of the current runtime
- framework.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Core.Util.GacCache._domain">
- <summary>
- Holds the <see cref="T:System.AppDomain"/> in which assemblies will be loaded
- to determine whether they are in the Global Assembly Cache.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.GacCache._project">
- <summary>
- Holds the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
- </summary>
- </member>
- <member name="F:NAnt.Core.Util.GacCache._gacQueryCache">
- <summary>
- Holds a list of assembly files for which already has been determined
- whether they are located in the Global Assembly Cache.
- </summary>
- <remarks>
- <para>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the full path to the
- assembly file and the value is a <see cref="T:System.Boolean"/> indicating
- whether the assembly is located in the Global Assembly Cache.
- </para>
- </remarks>
- </member>
- <member name="F:NAnt.Core.Util.GacCache._disposed">
- <summary>
- Holds a value indicating whether the object has been disposed.
- </summary>
- </member>
- <member name="P:NAnt.Core.Util.GacCache.Project">
- <summary>
- Gets the <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.Util.GacCache.Project"/> context of the <see cref="T:NAnt.Core.Util.GacCache"/>.
- </value>
- </member>
- <member name="M:NAnt.Core.Util.GacCache.GacResolver.InitializeLifetimeService">
- <summary>
- Obtains a lifetime service object to control the lifetime policy for
- this instance.
- </summary>
- <returns>
- An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
- policy for this instance. This is the current lifetime service object
- for this instance if one exists; otherwise, a new lifetime service
- object initialized with a lease that will never time out.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.GacCache.GacResolver.IsAssemblyInGac(System.String)">
- <summary>
- Determines whether an assembly is installed in the Global
- Assembly Cache given its file name or path.
- </summary>
- <param name="assemblyFile">The name or path of the file that contains the manifest of the assembly.</param>
- <returns>
- <see langword="true" /> if <paramref name="assemblyFile" /> is
- installed in the Global Assembly Cache; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.ReflectionUtils">
- <summary>
- Provides a set of helper methods related to reflection.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.ReflectionUtils.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.ReflectionUtils"/> class.
- </summary>
- <remarks>
- Uses a private access modifier to prevent instantiation of this class.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Util.ReflectionUtils.GetTypeFromString(System.String,System.Boolean)">
- <summary>
- Loads the type specified in the type string with assembly qualified name.
- </summary>
- <param name="typeName">The assembly qualified name of the type to load.</param>
- <param name="throwOnError">Flag set to <see langword="true"/> to throw an exception if the type cannot be loaded.</param>
- <exception cref="T:System.TypeLoadException">
- <paramref name="throwOnError"/> is <see langword="true"/> and
- an error is encountered while loading the <see cref="T:System.Type"/>, or
- <paramref name="typeName"/> is not an assembly qualified name.
- </exception>
- <remarks>
- If the <see cref="T:System.Type"/> cannot be instantiated from the assembly
- qualified type name, then we'll try to instantiate the type using its
- simple type name from an already loaded assembly with an assembly
- name mathing the assembly in the assembly qualified type name.
- </remarks>
- <returns>
- The type loaded or <see langword="null"/> if it could not be loaded.
- </returns>
- </member>
- <member name="T:NAnt.Core.Util.ResourceUtils">
- <summary>
- Provides resource support to NAnt assemblies. This class cannot
- be inherited from.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.#ctor">
- <summary>
- Prevents the <see cref="T:NAnt.Core.Util.ResourceUtils"/> class from being
- instantiated explicitly.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.RegisterSharedAssembly(System.Reflection.Assembly)">
- <summary>
- Registers the assembly to be used as the fallback if resources
- aren't found in the local satellite assembly.
- </summary>
- <param name="assembly">
- A <see cref="T:System.Reflection.Assembly"/> that represents the
- assembly to register.
- </param>
- <example>
- The following example shows how to register a shared satellite
- assembly.
- <code>
- <![CDATA[
- Assembly sharedAssembly = Assembly.Load("MyResources.dll");
- ResourceUtils.RegisterSharedAssembly(sharedAssembly);
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String)">
- <summary>
- Returns the value of the specified string resource.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that contains the name of the
- resource to get.
- </param>
- <returns>
- A <see cref="T:System.String"/> that contains the value of the
- resource localized for the current culture.
- </returns>
- <remarks>
- The returned resource is localized for the cultural settings of the
- current <see cref="T:System.Threading.Thread"/>.
- <note>
- The <c>GetString</c> method is thread-safe.
- </note>
- </remarks>
- <example>
- The following example demonstrates the <c>GetString</c> method using
- the cultural settings of the current <see cref="T:System.Threading.Thread"/>.
- <code>
- <![CDATA[
- string localizedString = ResourceUtils.GetString("String_HelloWorld");
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo)">
- <summary>
- Returns the value of the specified string resource localized for
- the specified culture.
- </summary>
- <param name="name"></param>
- <param name="culture"></param>
- <returns>
- A <see cref="T:System.String"/> that contains the value of the
- resource localized for the specified culture.
- </returns>
- <remarks>
- <note>
- The <c>GetString</c> method is thread-safe.
- </note>
- </remarks>
- <example>
- The following example demonstrates the <c>GetString</c> method using
- a specific culture.
- <code>
- <![CDATA[
- CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
- string localizedString = ResourceUtils.GetString("String_HelloWorld", culture);
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.GetString(System.String,System.Globalization.CultureInfo,System.Reflection.Assembly)">
- <summary>
- Returns the value of the specified string resource localized for
- the specified culture for the specified assembly.
- </summary>
- <param name="name">
- A <see cref="T:System.String"/> that contains the name of the
- resource to get.
- </param>
- <param name="culture">
- A <see cref="T:System.Globalization.CultureInfo"/> that represents
- the culture for which the resource is localized.
- </param>
- <param name="assembly">
- A <see cref="T:System.Reflection.Assembly"/>
- </param>
- <returns>
- A <see cref="T:System.String"/> that contains the value of the
- resource localized for the specified culture.
- </returns>
- <remarks>
- <note>
- The <c>GetString</c> method is thread-safe.
- </note>
- </remarks>
- <example>
- The following example demonstrates the <c>GetString</c> method using
- specific culture and assembly.
- <code>
- <![CDATA[
- CultureInfo culture = CultureInfo.CreateSpecificCulture("en-US");
- Assembly assembly = Assembly.GetCallingAssembly();
- string localizedString = ResourceUtils.GetString("String_HelloWorld", culture, assembly);
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.RegisterAssembly(System.Reflection.Assembly)">
- <summary>
- Registers the specified assembly.
- </summary>
- <param name="assembly">
- A <see cref="T:System.Reflection.Assembly"/> that represents the
- assembly to register.
- </param>
- </member>
- <member name="M:NAnt.Core.Util.ResourceUtils.GetResourceName(System.String)">
- <summary>
- Determines the manifest resource name of the resource holding the
- localized strings.
- </summary>
- <param name="assemblyName">The name of the assembly.</param>
- <returns>
- The manifest resource name of the resource holding the localized
- strings for the specified assembly.
- </returns>
- <remarks>
- The manifest resource name of the resource holding the localized
- strings should match the name of the assembly, minus <c>Tasks</c>
- suffix.
- </remarks>
- </member>
- <member name="T:NAnt.Core.Util.StringUtils">
- <summary>
- Groups a set of useful <see cref="T:System.String"/> manipulation and validation
- methods.
- </summary>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
- </summary>
- <remarks>
- Prevents instantiation of the <see cref="T:NAnt.Core.Util.StringUtils"/> class.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.EndsWith(System.String,System.Char)">
- <summary>
- Determines whether the last character of the given <see cref="T:System.String"/>
- matches the specified character.
- </summary>
- <param name="value">The string.</param>
- <param name="c">The character.</param>
- <returns>
- <see langword="true"/> if the last character of <paramref name="value"/>
- matches <paramref name="c"/>; otherwise, <see langword="false"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="value"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.IsNullOrEmpty(System.String)">
- <summary>
- Indicates whether or not the specified <see cref="T:System.String"/> is
- <see langword="null"/> or an <see cref="F:System.String.Empty"/> string.
- </summary>
- <param name="value">The value to check.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is <see langword="null"/>
- or an empty string (""); otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.ConvertEmptyToNull(System.String)">
- <summary>
- Converts an empty string ("") to <see langword="null" />.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>
- <see langword="null" /> if <paramref name="value" /> is an empty
- string ("") or <see langword="null" />; otherwise, <paramref name="value" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.ConvertNullToEmpty(System.String)">
- <summary>
- Converts <see langword="null" /> to an empty string.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>
- An empty string if <paramref name="value" /> is <see langword="null" />;
- otherwise, <paramref name="value" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)">
- <summary>
- Concatenates a specified separator <see cref="T:System.String"/> between each
- element of a specified <see cref="T:System.Collections.Specialized.StringCollection"/>, yielding a
- single concatenated string.
- </summary>
- <param name="separator">A <see cref="T:System.String"/>.</param>
- <param name="value">A <see cref="T:System.Collections.Specialized.StringCollection"/>.</param>
- <returns>
- A <see cref="T:System.String"/> consisting of the elements of <paramref name="value"/>
- interspersed with the separator string.
- </returns>
- <remarks>
- <para>
- For example if <paramref name="separator"/> is ", " and the elements
- of <paramref name="value"/> are "apple", "orange", "grape", and "pear",
- <see cref="M:NAnt.Core.Util.StringUtils.Join(System.String,System.Collections.Specialized.StringCollection)"/> returns "apple, orange,
- grape, pear".
- </para>
- <para>
- If <paramref name="separator"/> is <see langword="null"/>, an empty
- string (<see cref="F:System.String.Empty"/>) is used instead.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.Util.StringUtils.Clone(System.Collections.Specialized.StringCollection)">
- <summary>
- Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
- </summary>
- <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
- <returns>
- A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
- </returns>
- </member>
- <member name="T:NAnt.Core.BuildException">
- <summary>
- Thrown whenever an error occurs during the build.
- </summary>
- </member>
- <member name="F:NAnt.Core.BuildException._location">
- <summary>
- The location of the exception in the build document (xml file).
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with a descriptive message.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with the specified descriptive message and inner exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with a descriptive message and the location in the build file that
- caused the exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="location">The location in the build file where the exception occured.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with a descriptive message, the location in the build file and an
- instance of the exception that is the cause of the current exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="location">The location in the build file where the exception occured.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildException"/> class
- with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Serializes this object into the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> provided.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
- <param name="context">The destination for this serialization.</param>
- </member>
- <member name="M:NAnt.Core.BuildException.ToString">
- <summary>
- Creates and returns a string representation of the current
- exception.
- </summary>
- <returns>
- A string representation of the current exception.
- </returns>
- </member>
- <member name="P:NAnt.Core.BuildException.RawMessage">
- <summary>
- Gets the raw message as specified when the exception was
- constructed.
- </summary>
- <value>
- The raw message as specified when the exception was
- constructed.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildException.Location">
- <summary>
- Gets the location in the build file of the element from which the
- exception originated.
- </summary>
- <value>
- The location in the build file of the element from which the
- exception originated.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildException.Message">
- <summary>
- Gets a message that describes the current exception.
- </summary>
- <value>
- The error message that explains the reason for the exception.
- </value>
- <remarks>
- Adds location information to the message, if available.
- </remarks>
- </member>
- <member name="T:NAnt.Core.CommandLineOptions">
- <summary>
- Represents the set of command-line options supported by NAnt.
- </summary>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.TargetFramework">
- <summary>
- Gets or sets the target framework to use (overrides
- NAnt.exe.config settings)
- </summary>
- <value>
- The framework that should be used.
- </value>
- <remarks>
- For a list of possible frameworks, see NAnt.exe.config, possible
- values include "net-1.0", "net-1.1", etc.
- </remarks>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.DefaultFramework">
- <summary>
- Gets or sets the target framework to use (overrides
- NAnt.exe.config settings)
- </summary>
- <value>
- The framework that should be used.
- </value>
- <remarks>
- For a list of possible frameworks, see NAnt.exe.config, possible
- values include "net-1.0", "net-1.1", etc.
- </remarks>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.BuildFile">
- <summary>
- Gets or sets the buildfile that should be executed.
- </summary>
- <value>
- The buildfile that should be executed.
- </value>
- <remarks>
- Can be both a file or an URI.
- </remarks>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Verbose">
- <summary>
- Gets or sets a value indicating whether more information should be
- displayed during the build process.
- </summary>
- <value>
- <see langword="true" /> if more information should be displayed;
- otherwise, <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Debug">
- <summary>
- Gets or sets a value indicating whether debug information should be
- displayed during the build process.
- </summary>
- <value>
- <see langword="true" /> if debug information should be displayed;
- otherwise, <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Quiet">
- <summary>
- Gets or sets a value indicating whether only error and debug debug messages should be
- displayed during the build process.
- </summary>
- <value>
- <see langword="true" /> if only error or warning messages should be
- displayed; otherwise, <see langword="false" />. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="true" /> if output is to be unadorned so that emacs
- and other editors can parse files names, etc. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.FindInParent">
- <summary>
- Gets a value indicating whether parent directories should be searched
- for a buildfile.
- </summary>
- <value>
- <see langword="true" /> if parent directories should be searched for
- a build file; otherwise, <see langword="false" />. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.IndentationLevel">
- <summary>
- Gets or sets the indentation level of the build output.
- </summary>
- <value>
- The indentation level of the build output. The default is <c>0</c>.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Properties">
- <summary>
- Gets or sets the list of properties that should be set.
- </summary>
- <value>
- The list of properties that should be set.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.LoggerType">
- <summary>
- Gets or sets the <see cref="T:System.Type"/> of logger to add to the list
- of listeners.
- </summary>
- <value>
- The <see cref="T:System.Type"/> of logger to add to the list of
- listeners.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.CommandLineOptions.LoggerType"/> should derive from <see cref="T:NAnt.Core.IBuildLogger"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.LogFile">
- <summary>
- Gets or sets the name of the file to log output to.
- </summary>
- <value>
- The name of the file to log output to.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Listeners">
- <summary>
- Gets a collection containing fully qualified type names of classes
- implementating <see cref="T:NAnt.Core.IBuildListener"/> that should be added
- to the project as listeners.
- </summary>
- <value>
- A collection of fully qualified type names that should be added as
- listeners to the <see cref="T:NAnt.Core.Project"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.ExtensionAssemblies">
- <summary>
- Gets a collection of assemblies to load extensions from.
- </summary>
- <value>
- A collection of assemblies to load extensions from.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.ShowProjectHelp">
- <summary>
- Gets or sets a value indicating whether <see cref="T:NAnt.Core.Project"/> help
- should be printed.
- </summary>
- <value>
- <see langword="true"/> if <see cref="T:NAnt.Core.Project"/> help should be
- printed; otherwise, <see langword="false"/>. The default is
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.NoLogo">
- <summary>
- Gets or sets a value indicating whether the logo banner should be
- printed.
- </summary>
- <value>
- <see langword="true" /> if the logo banner should be printed; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.ShowHelp">
- <summary>
- Gets or sets a value indicating whether the NAnt help should be
- printed.
- </summary>
- <value>
- <see langword="true" /> if NAnt help should be printed; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.CommandLineOptions.Targets">
- <summary>
- Gets a collection containing the targets that should be executed.
- </summary>
- <value>
- A collection that contains the targets that should be executed.
- </value>
- </member>
- <member name="T:NAnt.Core.ConfigurationSection">
- <summary>
- Custom configuration section handler for the <nantsettings/> element.
- </summary>
- </member>
- <member name="M:NAnt.Core.ConfigurationSection.Create(System.Object,System.Object,System.Xml.XmlNode)">
- <summary>
- This just passed things through. Return the node read from the config file.
- </summary>
- </member>
- <member name="T:NAnt.Core.ConsoleDriver">
- <summary>
- Main entry point to NAnt that is called by the ConsoleStub.
- </summary>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.Main(System.String[])">
- <summary>
- Starts NAnt. This is the Main entry point.
- </summary>
- <param name="args">Command Line args, or whatever you want to pass it. They will treated as Command Line args.</param>
- <returns>
- The exit code.
- </returns>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.ShowProjectHelp(System.Xml.XmlDocument)">
- <summary>
- Prints the projecthelp to the console.
- </summary>
- <param name="buildDoc">The build file to show help for.</param>
- <remarks>
- <paramref name="buildDoc" /> is loaded and transformed with
- <c>ProjectHelp.xslt</c>, which is an embedded resource.
- </remarks>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.GetBuildFileName(System.String,System.String,System.Boolean)">
- <summary>
- Gets the file name for the build file in the specified directory.
- </summary>
- <param name="directory">The directory to look for a build file. When in doubt use Environment.CurrentDirectory for directory.</param>
- <param name="searchPattern">Look for a build file with this pattern or name. If null look for a file that matches the default build pattern (*.build).</param>
- <param name="findInParent">Whether or not to search the parent directories for a build file.</param>
- <returns>The path to the build file or <c>null</c> if no build file could be found.</returns>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.LoadExtensionAssemblies(System.Collections.Specialized.StringCollection,NAnt.Core.Project)">
- <summary>
- Loads the extension assemblies in the current <see cref="T:System.AppDomain"/>
- and scans them for extensions.
- </summary>
- <param name="extensionAssemblies">The extension assemblies to load.</param>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> which will be used to output messages to the build log.</param>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.CreateLogger(System.String)">
- <summary>
- Dynamically constructs an <see cref="T:NAnt.Core.IBuildLogger"/> instance of
- the class specified.
- </summary>
- <remarks>
- <para>
- At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildLogger"/>
- is defined.
- </para>
- </remarks>
- <param name="typeName">The fully qualified name of the logger that should be instantiated.</param>
- <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildLogger"/>.</exception>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.CreateListener(System.String)">
- <summary>
- Dynamically constructs an <see cref="T:NAnt.Core.IBuildListener"/> instance of
- the class specified.
- </summary>
- <remarks>
- <para>
- At this point, only looks in the assembly where <see cref="T:NAnt.Core.IBuildListener"/>
- is defined.
- </para>
- </remarks>
- <param name="typeName">The fully qualified name of the listener that should be instantiated.</param>
- <exception cref="T:System.TypeLoadException">Type <paramref name="typeName"/> could not be loaded.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="typeName"/> does not implement <see cref="T:NAnt.Core.IBuildListener"/>.</exception>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.AddBuildListeners(NAnt.Core.CommandLineOptions,NAnt.Core.Project)">
- <summary>
- Add the listeners specified in the command line arguments,
- along with the default listener, to the specified project.
- </summary>
- <param name="cmdlineOptions">The command-line options.</param>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> to add listeners to.</param>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.ShowHelp(NAnt.Core.Util.CommandLineParser)">
- <summary>
- Spits out generic help info to the console.
- </summary>
- </member>
- <member name="M:NAnt.Core.ConsoleDriver.WriteException(System.Exception)">
- <summary>
- Write the message of the specified <see cref="T:System.Exception"/> and
- the inner exceptions to <see cref="P:System.Console.Error"/>.
- </summary>
- <param name="cause">The <see cref="T:System.Exception"/> to write to <see cref="P:System.Console.Error"/>.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
- <summary>
- Creates a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
- class for the specified <see cref="T:NAnt.Core.DataTypeBase"/> class in the
- <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> specified.
- </summary>
- <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
- <param name="className">The class representing the <see cref="T:NAnt.Core.DataTypeBase"/>.</param>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilder.ClassName">
- <summary>
- Gets the name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be
- created using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
- </summary>
- <value>
- The name of the <see cref="T:NAnt.Core.DataTypeBase"/> class that can be created
- using this <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilder.DataTypeName">
- <summary>
- Gets the name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
- can create.
- </summary>
- <value>
- The name of the data type which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>
- can create.
- </value>
- </member>
- <member name="T:NAnt.Core.DataTypeBaseBuilderCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
- with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.#ctor(NAnt.Core.DataTypeBaseBuilder[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Add(NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Adds a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilder[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.AddRange(NAnt.Core.DataTypeBaseBuilderCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified
- task is in the collection.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for
- the specified task is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.CopyTo(NAnt.Core.DataTypeBaseBuilder[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.IndexOf(NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.DataTypeBaseBuilder"/>. If the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Insert(System.Int32,NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderCollection.Remove(NAnt.Core.DataTypeBaseBuilder)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilderCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> for the specified task.
- </summary>
- <param name="dataTypeName">The name of task for which the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> should be located in the collection.</param>
- </member>
- <member name="T:NAnt.Core.DataTypeBaseBuilderEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> elements of a <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.#ctor(NAnt.Core.DataTypeBaseBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseBuilderEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.DataTypeBaseBuilderCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseBuilderEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.DataTypeBaseBuilderEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseDictionary.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DataTypeBaseDictionary"/> class
- with the specified capacity.
- </summary>
- </member>
- <member name="M:NAnt.Core.DataTypeBaseDictionary.Inherit(NAnt.Core.DataTypeBaseDictionary)">
- <summary>
- Inherits Properties from an existing property
- dictionary Instance
- </summary>
- <param name="source">DataType list to inherit</param>
- </member>
- <member name="T:NAnt.Core.DirectoryScanner">
- <summary>
- Used for searching filesystem based on given include/exclude rules.
- </summary>
- <example>
- <para>Simple client code for testing the class.</para>
- <code>
- 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("");
- }
- </code>
- </example>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
- </summary>
- <remarks>
- On unix, patterns are matching case-sensitively; otherwise, they
- are matched case-insensitively.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DirectoryScanner"/>
- specifying whether patterns are to be match case-sensitively.
- </summary>
- <param name="caseSensitive">Specifies whether patterns are to be matched case-sensititely.</param>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.DirectoryScanner"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.Scan">
- <summary>
- Uses <see cref="P:NAnt.Core.DirectoryScanner.Includes"/> and <see cref="P:NAnt.Core.DirectoryScanner.Excludes"/> search criteria (relative to
- <see cref="P:NAnt.Core.DirectoryScanner.BaseDirectory"/> or absolute), to search for filesystem objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.ConvertPatterns(System.Collections.Specialized.StringCollection,System.Collections.ArrayList,System.Collections.Specialized.StringCollection,System.Boolean)">
- <summary>
- Parses specified NAnt search patterns for search directories and
- corresponding regex patterns.
- </summary>
- <param name="nantPatterns">In. NAnt patterns. Absolute or relative paths.</param>
- <param name="regexPatterns">Out. Regex patterns. Absolute canonical paths.</param>
- <param name="nonRegexFiles">Out. Non-regex files. Absolute canonical paths.</param>
- <param name="addSearchDirectories">In. Whether to allow a pattern to add search directories.</param>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.ParseSearchDirectoryAndPattern(System.Boolean,System.String,System.String@,System.Boolean@,System.Boolean@,System.String@)">
- <summary>
- Given a NAnt search pattern returns a search directory and an regex
- search pattern.
- </summary>
- <param name="isInclude">Whether this pattern is an include or exclude pattern</param>
- <param name="originalNAntPattern">NAnt searh pattern (relative to the Basedirectory OR absolute, relative paths refering to parent directories ( ../ ) also supported)</param>
- <param name="searchDirectory">Out. Absolute canonical path to the directory to be searched</param>
- <param name="recursive">Out. Whether the pattern is potentially recursive or not</param>
- <param name="isRegex">Out. Whether this is a regex pattern or not</param>
- <param name="regexPattern">Out. Regex search pattern (absolute canonical path)</param>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.ScanDirectory(System.String,System.Boolean)">
- <summary>
- Searches a directory recursively for files and directories matching
- the search criteria.
- </summary>
- <param name="path">Directory in which to search (absolute canonical path)</param>
- <param name="recursive">Whether to scan recursively or not</param>
- </member>
- <member name="M:NAnt.Core.DirectoryScanner.ToRegexPattern(System.String)">
- <summary>
- Converts search pattern to a regular expression pattern.
- </summary>
- <param name="nantPattern">Search pattern relative to the search directory.</param>
- <returns>Regular expresssion</returns>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.CaseSensitive">
- <summary>
- Gets or set a value indicating whether or not to use case-sensitive
- pattern matching.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.Includes">
- <summary>
- Gets the collection of include patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.Excludes">
- <summary>
- Gets the collection of exclude patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.BaseDirectory">
- <summary>
- The base directory to scan. The default is the
- <see cref="P:System.Environment.CurrentDirectory">current directory</see>.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.FileNames">
- <summary>
- Gets the list of files that match the given patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.DirectoryNames">
- <summary>
- Gets the list of directories that match the given patterns.
- </summary>
- </member>
- <member name="P:NAnt.Core.DirectoryScanner.ScannedDirectories">
- <summary>
- Gets the list of directories that were scanned for files.
- </summary>
- </member>
- <member name="M:NAnt.Core.StringCollectionWithGoodToString.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.StringCollectionWithGoodToString"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.StringCollectionWithGoodToString.ToString">
- <summary>
- Creates a string representing a list of the strings in the collection.
- </summary>
- <returns>
- A string that represents the contents.
- </returns>
- </member>
- <member name="M:NAnt.Core.DirScannerStringCollection.#ctor(System.Boolean)">
- <summary>
- Initialize a new instance of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
- class specifying whether or not string comparison should be
- case-sensitive.
- </summary>
- <param name="caseSensitive">Specifies whether or not string comparison should be case-sensitive.</param>
- </member>
- <member name="M:NAnt.Core.DirScannerStringCollection.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.DirScannerStringCollection.Contains(System.String)">
- <summary>
- Determines whether the specified string is in the
- <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
- </summary>
- <param name="value">The string to locate in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>. The value can be <see langword="null"/>.</param>
- <returns>
- <seee langword="true"/> if value is found in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>; otherwise, <see langword="false"/>.
- </returns>
- <remarks>
- String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
- are only case-sensitive if <see cref="P:NAnt.Core.DirScannerStringCollection.CaseSensitive"/> is
- <see langword="true"/>
- </remarks>
- </member>
- <member name="M:NAnt.Core.DirScannerStringCollection.IndexOf(System.String)">
- <summary>
- Searches for the specified string and returns the zero-based index
- of the first occurrence within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>.
- </summary>
- <param name="value">The string to locate. The value can be <see langword="null"/>.</param>
- <returns>
- The zero-based index of the first occurrence of <paramref name="value"/>
- in the <see cref="T:NAnt.Core.DirScannerStringCollection"/>, if found; otherwise, -1.
- </returns>
- <remarks>
- String comparisons within the <see cref="T:NAnt.Core.DirScannerStringCollection"/>
- are only case-sensitive if <see cref="P:NAnt.Core.DirScannerStringCollection.CaseSensitive"/> is
- <see langword="true"/>.
- </remarks>
- </member>
- <member name="P:NAnt.Core.DirScannerStringCollection.CaseSensitive">
- <summary>
- Gets a value indicating whether string comparison is case-sensitive.
- </summary>
- <value>
- A value indicating whether string comparison is case-sensitive.
- </value>
- </member>
- <member name="M:NAnt.Core.ExpressionEvaluator.GetPropertyValue(System.String)">
- <summary>
- Gets the value of the specified property.
- </summary>
- <param name="propertyName">The name of the property to get the value of.</param>
- <returns>
- The value of the specified property.
- </returns>
- </member>
- <member name="T:NAnt.Core.ExpressionTokenizer">
- <summary>
- Splits an input string into a sequence of tokens used during parsing.
- </summary>
- </member>
- <member name="T:NAnt.Core.ExpressionTokenizer.TokenType">
- <summary>
- Available tokens
- </summary>
- </member>
- <member name="T:NAnt.Core.FrameworkInfo">
- <summary>
- Encalsulates information about installed frameworks incuding version
- information and directory locations for finding tools.
- </summary>
- </member>
- <member name="M:NAnt.Core.FrameworkInfo.ResolveAssembly(System.String)">
- <summary>
- Resolves the specified assembly to a full path by matching it
- against the reference assemblies.
- </summary>
- <param name="fileName">The file name of the assembly to resolve (without path information).</param>
- <returns>
- An absolute path to the assembly, or <see langword="null" /> if the
- assembly could not be found.
- </returns>
- <remarks>
- Whether the file name is matched case-sensitive depends on the
- operating system.
- </remarks>
- </member>
- <member name="M:NAnt.Core.FrameworkInfo.GetToolPath(System.String)">
- <summary>
- Searches the list of tool paths of the current framework for the
- given file, and returns the absolute path if found.
- </summary>
- <param name="tool">The file name of the tool to search for.</param>
- <returns>
- The absolute path to <paramref name="tool"/> if found in one of the
- configured tool paths; otherwise, <see langword="null"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="tool"/> is <see langword="null"/>.</exception>
- <remarks>
- <para>
- The configured tool paths are scanned in the order in which they
- are defined in the framework configuration.
- </para>
- <para>
- The file name of the tool to search should include the extension.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.FrameworkInfo.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
- <summary>
- Gets the value of the specified attribute from the specified node.
- </summary>
- <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
- <param name="attributeName">The attribute of which the value should be returned.</param>
- <returns>
- The value of the attribute with the specified name or <see langword="null" />
- if the attribute does not exist or has no value.
- </returns>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Name">
- <summary>
- Gets the name of the framework.
- </summary>
- <value>
- The name of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Family">
- <summary>
- Gets the family of the framework.
- </summary>
- <value>
- The family of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Description">
- <summary>
- Gets the description of the framework.
- </summary>
- <value>
- The description of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Version">
- <summary>
- Gets the version of the framework.
- </summary>
- <value>
- The version of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.ClrVersion">
- <summary>
- Gets the Common Language Runtime version of the framework.
- </summary>
- <value>
- The Common Language Runtime version of the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.VisualStudioVersion">
- <summary>
- Gets the Visual Studio version that corresponds with this
- framework.
- </summary>
- <remarks>
- The Visual Studio version that corresponds with this framework.
- </remarks>
- <exception cref="T:NAnt.Core.BuildException">There is no version of Visual Studio .NET that corresponds with this framework.</exception>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.FrameworkDirectory">
- <summary>
- Gets the base directory of the framework tools for the framework.
- </summary>
- <value>
- The base directory of the framework tools for the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Runtime">
- <summary>
- Gets the runtime information for this framework.
- </summary>
- <value>
- The runtime information for the framework or <see langword="null" />
- if no runtime information is configured for the framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.FrameworkAssemblyDirectory">
- <summary>
- Gets the directory where the system assemblies for the framework
- are located.
- </summary>
- <value>
- The directory where the system assemblies for the framework are
- located.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.SdkDirectory">
- <summary>
- Gets the directory containing the SDK tools for the framework.
- </summary>
- <value>
- The directory containing the SDK tools for the framework or a null
- reference if the configured sdk directory does not exist, or is not
- valid.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.Project">
- <summary>
- Gets the <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.FrameworkInfo.Project"/> used to initialize this framework.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.TaskAssemblies">
- <summary>
- Gets the set of assemblies and directories that should scanned for
- NAnt tasks, types or functions.
- </summary>
- <value>
- The set of assemblies and directories that should be scanned for
- NAnt tasks, types or functions.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.IsValid">
- <summary>
- Returns a value indicating whether the current framework is valid.
- </summary>
- <value>
- <see langword="true" /> if the framework is installed and correctly
- configured; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.FrameworkInfo.NamespaceManager">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.FrameworkInfo.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.FrameworkInfoDictionary.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.FrameworkInfoDictionary"/> class
- with the specified capacity.
- </summary>
- </member>
- <member name="T:NAnt.Core.Location">
- <summary>
- Stores the file name, line number and column number to record a position
- in a text file.
- </summary>
- </member>
- <member name="M:NAnt.Core.Location.#ctor(System.String,System.Int32,System.Int32)">
- <summary>
- Creates a location consisting of a file name, line number and
- column number.
- </summary>
- <remarks>
- <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Location.#ctor(System.String)">
- <summary>
- Creates a location consisting of a file name.
- </summary>
- <remarks>
- <paramref name="fileName" /> can be a local URI resource, e.g., file:///C:/WINDOWS/setuplog.txt.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Location.#ctor">
- <summary>
- Creates an "unknown" location.
- </summary>
- </member>
- <member name="M:NAnt.Core.Location.Init(System.String,System.Int32,System.Int32)">
- <summary>Private Init function.</summary>
- </member>
- <member name="M:NAnt.Core.Location.ToString">
- <summary>
- Returns the file name, line number and a trailing space. An error
- message can be appended easily. For unknown locations, returns
- an empty string.
- </summary>
- </member>
- <member name="P:NAnt.Core.Location.FileName">
- <summary>
- Gets a string containing the file name for the location.
- </summary>
- <remarks>
- The file name includes both the file path and the extension.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Location.LineNumber">
- <summary>
- Gets the line number for the location.
- </summary>
- <remarks>
- Lines start at 1. Will be zero if not specified.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Location.ColumnNumber">
- <summary>
- Gets the column number for the location.
- </summary>
- <remarks>
- Columns start a 1. Will be zero if not specified.
- </remarks>
- </member>
- <member name="T:NAnt.Core.LocationMap">
- <summary>
- Maps XML nodes to the text positions from their original source.
- </summary>
- </member>
- <member name="M:NAnt.Core.LocationMap.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.LocationMap.FileIsMapped(System.String)">
- <summary>
- Determines if a file has been loaded by the current project.
- </summary>
- <param name="fileOrUri">The file to check.</param>
- <returns>
- <see langword="true" /> if the specified file has already been loaded
- by the current project; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.LocationMap.Add(System.Xml.XmlDocument)">
- <summary>
- Adds an <see cref="T:System.Xml.XmlDocument"/> to the map.
- </summary>
- <remarks>
- An <see cref="T:System.Xml.XmlDocument"/> can only be added to the map once.
- </remarks>
- </member>
- <member name="M:NAnt.Core.LocationMap.GetLocation(System.Xml.XmlNode)">
- <summary>
- Returns the <see cref="T:NAnt.Core.Location"/> in the XML file for the given node.
- </summary>
- <remarks>
- The <paramref name="node"/> must be from an <see cref="T:System.Xml.XmlDocument"/>
- that has been added to the map.
- </remarks>
- </member>
- <member name="T:NAnt.Core.LocationMap.TextPosition">
- <summary>
- Represents a position in the build file.
- </summary>
- </member>
- <member name="M:NAnt.Core.LocationMap.TextPosition.#ctor(System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.LocationMap.TextPosition"/>
- with the speified line and column.
- </summary>
- <param name="line">The line coordinate of the position.</param>
- <param name="column">The column coordinate of the position.</param>
- </member>
- <member name="F:NAnt.Core.LocationMap.TextPosition.Line">
- <summary>
- The line coordinate of the position.
- </summary>
- </member>
- <member name="F:NAnt.Core.LocationMap.TextPosition.Column">
- <summary>
- The column coordinate of the position.
- </summary>
- </member>
- <member name="T:NAnt.Core.Level">
- <summary>
- Defines the set of levels recognised by the NAnt logging system.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Debug">
- <summary>
- Designates fine-grained informational events that are most useful
- to debug a build process.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Verbose">
- <summary>
- Designates events that offer a more detailed view of the build
- process.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Info">
- <summary>
- Designates informational events that are useful for getting a
- high-level view of the build process.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Warning">
- <summary>
- Designates potentionally harmful events.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.Error">
- <summary>
- Designates error events.
- </summary>
- </member>
- <member name="F:NAnt.Core.Level.None">
- <summary>
- Can be used to suppress all messages.
- </summary>
- <remarks>
- No events should be logged with this <see cref="T:NAnt.Core.Level"/>.
- </remarks>
- </member>
- <member name="T:NAnt.Core.BuildEventArgs">
- <summary>
- Class representing an event occurring during a build.
- </summary>
- <remarks>
- <para>
- An event is built by specifying either a project, a task or a target.
- </para>
- <para>
- A <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event will only have a <see cref="P:NAnt.Core.BuildEventArgs.Project"/>
- reference.
- </para>
- <para>
- A <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/> and
- <see cref="P:NAnt.Core.BuildEventArgs.Target"/> references.
- </para>
- <para>
- A <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event will have <see cref="P:NAnt.Core.BuildEventArgs.Project"/>,
- <see cref="P:NAnt.Core.BuildEventArgs.Target"/> and <see cref="P:NAnt.Core.BuildEventArgs.Task"/> references.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.BuildEventArgs.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
- class for a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
- </summary>
- <param name="project">The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that emitted the event.</param>
- </member>
- <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Target)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
- class for a <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level event.
- </summary>
- <param name="target">The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that emitted the event.</param>
- </member>
- <member name="M:NAnt.Core.BuildEventArgs.#ctor(NAnt.Core.Task)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildEventArgs"/>
- class for a <see cref="P:NAnt.Core.BuildEventArgs.Task"/> level event.
- </summary>
- <param name="task">The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that emitted the event.</param>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Message">
- <summary>
- Gets or sets the message associated with this event.
- </summary>
- <value>
- The message associated with this event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.MessageLevel">
- <summary>
- Gets or sets the priority level associated with this event.
- </summary>
- <value>
- The priority level associated with this event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Exception">
- <summary>
- Gets or sets the <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.BuildEventArgs.Exception"/> associated with this event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Project">
- <summary>
- Gets the <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.BuildEventArgs.Project"/> that fired this event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Target">
- <summary>
- Gets the <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.BuildEventArgs.Target"/> that fired this event, or a null reference
- if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> level event.
- </value>
- </member>
- <member name="P:NAnt.Core.BuildEventArgs.Task">
- <summary>
- Gets the <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event.
- </summary>
- <value>
- The <see cref="P:NAnt.Core.BuildEventArgs.Task"/> that fired this event, or <see langword="null"/>
- if this is a <see cref="P:NAnt.Core.BuildEventArgs.Project"/> or <see cref="P:NAnt.Core.BuildEventArgs.Target"/> level
- event.
- </value>
- </member>
- <member name="T:NAnt.Core.BuildEventHandler">
- <summary>
- Represents the method that handles the build events.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="T:NAnt.Core.IBuildListener">
- <summary>
- Instances of classes that implement this interface can register to be
- notified when things happen during a build.
- </summary>
- </member>
- <member name="M:NAnt.Core.IBuildListener.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildListener.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildListener.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.IBuildListener.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildListener.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.IBuildListener.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildListener.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a message has been logged.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="T:NAnt.Core.IBuildLogger">
- <summary>
- Interface used by NAnt to log the build output.
- </summary>
- <remarks>
- Depending on the supplied command-line arguments, NAnt will set the
- <see cref="P:NAnt.Core.IBuildLogger.OutputWriter"/> to <see cref="P:System.Console.Out"/> or a
- <see cref="T:System.IO.StreamWriter"/> with a file as backend store.
- </remarks>
- </member>
- <member name="M:NAnt.Core.IBuildLogger.Flush">
- <summary>
- Flushes buffered build events or messages to the underlying storage.
- </summary>
- </member>
- <member name="P:NAnt.Core.IBuildLogger.Threshold">
- <summary>
- Gets or sets the highest level of message this logger should respond
- to.
- </summary>
- <value>The highest level of message this logger should respond to.</value>
- <remarks>
- Only messages with a message level higher than or equal to the given
- level should actually be written to the log.
- </remarks>
- </member>
- <member name="P:NAnt.Core.IBuildLogger.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="true" /> if output is to be unadorned so that emacs
- and other editors can parse files names, etc.
- </value>
- </member>
- <member name="P:NAnt.Core.IBuildLogger.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
- to send its output.
- </summary>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.DefaultLogger"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.Flush">
- <summary>
- Flushes buffered build events or messages to the underlying storage.
- </summary>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a message has been logged.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- Only messages with a priority higher or equal to the threshold of
- the logger will actually be output in the build log.
- </remarks>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.Log(System.String)">
- <summary>
- Empty implementation which allows derived classes to receive the
- output that is generated in this logger.
- </summary>
- <param name="message">The message being logged.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.Level,System.String,System.Int32)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
- logger.
- </summary>
- <param name="messageLevel">The priority of the message to output.</param>
- <param name="message">The message to output.</param>
- <param name="indentationLength">The number of characters that the message should be indented.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
- logger.
- </summary>
- <param name="e">The event to output.</param>
- </member>
- <member name="M:NAnt.Core.DefaultLogger.OutputMessage(NAnt.Core.BuildEventArgs,System.Int32)">
- <summary>
- Outputs an indented message to the build log if its priority is
- greather than or equal to the <see cref="P:NAnt.Core.DefaultLogger.Threshold"/> of the
- logger.
- </summary>
- <param name="e">The event to output.</param>
- <param name="indentationLength">The number of characters that the message should be indented.</param>
- </member>
- <member name="F:NAnt.Core.DefaultLogger._buildReports">
- <summary>
- Holds a stack of reports for all running builds.
- </summary>
- </member>
- <member name="P:NAnt.Core.DefaultLogger.Threshold">
- <summary>
- Gets or sets the highest level of message this logger should respond
- to.
- </summary>
- <value>
- The highest level of message this logger should respond to.
- </value>
- <remarks>
- Only messages with a message level higher than or equal to the given
- level should be written to the log.
- </remarks>
- </member>
- <member name="P:NAnt.Core.DefaultLogger.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="true" /> if output is to be unadorned so that emacs
- and other editors can parse files names, etc. The default is
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.DefaultLogger.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
- to send its output.
- </summary>
- <value>
- The <see cref="T:System.IO.TextWriter"/> to which the logger sends its output.
- </value>
- </member>
- <member name="T:NAnt.Core.BuildReport">
- <summary>
- Used to store information about a build, to allow better reporting to
- the user.
- </summary>
- </member>
- <member name="F:NAnt.Core.BuildReport.Errors">
- <summary>
- Errors encountered so far.
- </summary>
- </member>
- <member name="F:NAnt.Core.BuildReport.Warnings">
- <summary>
- Warnings encountered so far.
- </summary>
- </member>
- <member name="F:NAnt.Core.BuildReport.StartTime">
- <summary>
- The start time of the build process.
- </summary>
- </member>
- <member name="T:NAnt.Core.MailLogger">
- <summary>
- Buffers log messages from DefaultLogger, and sends an e-mail with the
- results.
- </summary>
- <remarks>
- The following properties are used to send the mail :
- <list type="table">
- <listheader>
- <term>Property</term>
- <description>Description</description>
- </listheader>
- <item>
- <term>MailLogger.mailhost</term>
- <description>Mail server to use. [default: localhost]</description>
- </item>
- <item>
- <term>MailLogger.from</term>
- <description>The address of the e-mail sender.</description>
- </item>
- <item>
- <term>MailLogger.failure.notify</term>
- <description>Send build failure e-mails ? [default: true]</description>
- </item>
- <item>
- <term>MailLogger.success.notify</term>
- <description>Send build success e-mails ? [default: true]</description>
- </item>
- <item>
- <term>MailLogger.failure.to</term>
- <description>The address to send build failure messages to.</description>
- </item>
- <item>
- <term>MailLogger.success.to</term>
- <description>The address to send build success messages to.</description>
- </item>
- <item>
- <term>MailLogger.failure.subject</term>
- <description>The subject of build failure messages. [default: "Build Failure"]</description>
- </item>
- <item>
- <term>MailLogger.success.subject</term>
- <description>The subject of build success messages. [default: "Build Success"]</description>
- </item>
- <item>
- <term>MailLogger.success.attachments</term>
- <description>The ID of a fileset holdng set of files to attach when the build is successful.</description>
- </item>
- <item>
- <term>MailLogger.failure.attachments</term>
- <description>The ID of a fileset holdng set of files to attach when the build fails.</description>
- </item>
- <item>
- <term>MailLogger.body.encoding</term>
- <description>The encoding type of the body of the e-mail message. [default: system's ANSI code page]</description>
- </item>
- <item>
- <term>MailLogger.smtp.username</term>
- <description>The name of the user to login to the SMTP server.</description>
- </item>
- <item>
- <term>MailLogger.smtp.password</term>
- <description>The password of the specified user.</description>
- </item>
- <item>
- <term>MailLogger.smtp.enablessl</term>
- <description>Specifies whether to use SSL to encrypt the connection. [default: false]</description>
- </item>
- <item>
- <term>MailLogger.smtp.port</term>
- <description>The SMTP server port to connect to. [default: 25]</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="M:NAnt.Core.MailLogger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.MailLogger"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.MailLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Core.MailLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished, and send an e-mail with
- the build results.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.MailLogger.Log(System.String)">
- <summary>
- Receives and buffers log messages.
- </summary>
- <param name="message">The message being logged.</param>
- </member>
- <member name="M:NAnt.Core.MailLogger.GetPropertyValue(NAnt.Core.PropertyDictionary,System.String,System.String,System.Boolean)">
- <summary>
- Gets the value of the specified property.
- </summary>
- <param name="properties">Properties to obtain value from.</param>
- <param name="name">Suffix of property name. "MailLogger" will be prepended internally.</param>
- <param name="defaultValue">Value returned if property is not present in <paramref name="properties"/>.</param>
- <param name="required">Value indicating whether the property should exist, or have a default value set.</param>
- <returns>
- The value of the specified property; or the default value if the
- property is not present in <paramref name="properties"/>.
- </returns>
- <exception cref="T:System.ArgumentNullException"><paramref name="required"/> is <see langword="true"/>, and the specified property is not present and no default value has been given.</exception>
- </member>
- <member name="F:NAnt.Core.MailLogger._buffer">
- <summary>
- Buffer in which the message is constructed prior to sending.
- </summary>
- </member>
- <member name="F:NAnt.Core.MailLogger._projectStack">
- <summary>
- Holds the stack of currently executing projects.
- </summary>
- </member>
- <member name="T:NAnt.Core.BuildListenerCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.IBuildListener"/>
- objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.BuildListenerCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
- class with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.#ctor(NAnt.Core.IBuildListener[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerCollection"/>
- class with the specified array of <see cref="T:NAnt.Core.IBuildListener"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.Add(NAnt.Core.IBuildListener)">
- <summary>
- Adds a <see cref="T:NAnt.Core.IBuildListener"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.IBuildListener[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.IBuildListener"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.IBuildListener"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.AddRange(NAnt.Core.BuildListenerCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.BuildListenerCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.Contains(NAnt.Core.IBuildListener)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.IBuildListener"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.CopyTo(NAnt.Core.IBuildListener[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.IndexOf(NAnt.Core.IBuildListener)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.IBuildListener"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.IBuildListener"/>. If the <see cref="T:NAnt.Core.IBuildListener"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.Insert(System.Int32,NAnt.Core.IBuildListener)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.IBuildListener"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.BuildListenerEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerCollection.Remove(NAnt.Core.IBuildListener)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.IBuildListener"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.BuildListenerCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.Core.BuildListenerEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.IBuildListener"/> elements of a <see cref="T:NAnt.Core.BuildListenerCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.BuildListenerEnumerator.#ctor(NAnt.Core.BuildListenerCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.BuildListenerEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.BuildListenerCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.BuildListenerEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.BuildListenerEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.BuildListenerEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.LogWriter">
- <summary>
- Implements a <see cref="T:System.IO.TextWriter"/> for writing information to
- the NAnt logging infrastructure.
- </summary>
- </member>
- <member name="M:NAnt.Core.LogWriter.#ctor(NAnt.Core.Task,NAnt.Core.Level,System.IFormatProvider)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.LogWriter"/> class
- for the specified <see cref="T:NAnt.Core.Task"/> with the specified output
- level and format provider.
- </summary>
- <param name="task">Determines the indentation level.</param>
- <param name="outputLevel">The <see cref="T:NAnt.Core.Level"/> with which messages will be output to the build log.</param>
- <param name="formatProvider">An <see cref="T:System.IFormatProvider"/> object that controls formatting.</param>
- </member>
- <member name="M:NAnt.Core.LogWriter.Write(System.Char[])">
- <summary>
- Writes a character array to the buffer.
- </summary>
- <param name="chars">The character array to write to the text stream.</param>
- </member>
- <member name="M:NAnt.Core.LogWriter.Write(System.String)">
- <summary>
- Writes a string to the buffer.
- </summary>
- <param name="value"></param>
- </member>
- <member name="M:NAnt.Core.LogWriter.WriteLine">
- <summary>
- Writes an empty string to the logging infrastructure.
- </summary>
- </member>
- <member name="M:NAnt.Core.LogWriter.WriteLine(System.String)">
- <summary>
- Writes a string to the logging infrastructure.
- </summary>
- <param name="value">The string to write. If <paramref name="value" /> is a null reference, only the line termination characters are written.</param>
- </member>
- <member name="M:NAnt.Core.LogWriter.WriteLine(System.String,System.Object[])">
- <summary>
- Writes out a formatted string using the same semantics as
- <see cref="M:System.String.Format(System.String,System.Object[])"/>.
- </summary>
- <param name="line">The formatting string.</param>
- <param name="args">The object array to write into format string.</param>
- </member>
- <member name="M:NAnt.Core.LogWriter.Flush">
- <summary>
- Causes any buffered data to be written to the logging infrastructure.
- </summary>
- </member>
- <member name="M:NAnt.Core.LogWriter.Close">
- <summary>
- Closes the current writer and releases any system resources
- associated with the writer.
- </summary>
- </member>
- <member name="M:NAnt.Core.LogWriter.InitializeLifetimeService">
- <summary>
- Obtains a lifetime service object to control the lifetime policy for
- this instance.
- </summary>
- <returns>
- An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
- policy for this instance. This is the current lifetime service object
- for this instance if one exists; otherwise, a new lifetime service
- object initialized with a lease that will never time out.
- </returns>
- </member>
- <member name="P:NAnt.Core.LogWriter.Encoding">
- <summary>
- Gets the <see cref="P:NAnt.Core.LogWriter.Encoding"/> in which the output is written.
- </summary>
- <value>
- The <see cref="T:NAnt.Core.LogWriter"/> always writes output in UTF8
- encoding.
- </value>
- </member>
- <member name="P:NAnt.Core.LogWriter.OutputLevel">
- <summary>
- Gets the <see cref="T:NAnt.Core.Level"/> with which messages will be output to
- the build log.
- </summary>
- </member>
- <member name="T:NAnt.Core.PathScanner">
- <summary>
- Used to search for files on the PATH.
- </summary>
- <remarks>
- <para>
- The local directory is not searched (since this would already be covered
- by normal use of the includes element).
- </para>
- <para>
- Also, advanced pattern matching isn't supported: you need to know the
- exact name of the file.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.Core.PathScanner.System#ICloneable#Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.PathScanner.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.PathScanner"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.PathScanner.Add(System.String)">
- <summary>
- Adds a file to the list of files to be scanned for.
- </summary>
- <param name="fileName">The filename or search pattern to add to the list.</param>
- </member>
- <member name="M:NAnt.Core.PathScanner.Scan">
- <summary>
- Scans all direcetories in the PATH environment variable for files.
- </summary>
- <returns>
- List of matching files found in the PATH.
- </returns>
- </member>
- <member name="M:NAnt.Core.PathScanner.Scan(System.String)">
- <summary>
- Scans all directories in the given environment variable for files.
- </summary>
- <param name="name">The environment variable of which the directories should be scanned.</param>
- <returns>
- List of matching files found in the directory of the given
- environment variable.
- </returns>
- </member>
- <member name="M:NAnt.Core.PathScanner.Clone(System.Collections.Specialized.StringCollection)">
- <summary>
- Creates a shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
- </summary>
- <param name="stringCollection">The <see cref="T:System.Collections.Specialized.StringCollection"/> that should be copied.</param>
- <returns>
- A shallow copy of the specified <see cref="T:System.Collections.Specialized.StringCollection"/>.
- </returns>
- </member>
- <member name="T:NAnt.Core.Project">
- <summary>
- Central representation of a NAnt project.
- </summary>
- <example>
- <para>
- The <see cref="M:NAnt.Core.Project.Run"/> method will initialize the project with the build
- file specified in the constructor and execute the default target.
- </para>
- <code>
- <![CDATA[
- Project p = new Project("foo.build", Level.Info);
- p.Run();
- ]]>
- </code>
- </example>
- <example>
- <para>
- If no target is given, the default target will be executed if specified
- in the project.
- </para>
- <code>
- <![CDATA[
- Project p = new Project("foo.build", Level.Info);
- p.Execute("build");
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.Core.Project.Visiting">
- <summary>
- Constant for the "visiting" state, used when traversing a DFS of
- target dependencies.
- </summary>
- </member>
- <member name="F:NAnt.Core.Project.Visited">
- <summary>
- Constant for the "visited" state, used when traversing a DFS of
- target dependencies.
- </summary>
- </member>
- <member name="F:NAnt.Core.Project.logger">
- <summary>
- Holds the logger for this class.
- </summary>
- </member>
- <member name="F:NAnt.Core.Project._threshold">
- <summary>
- Holds the default threshold for build loggers.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32)">
- <summary>
- Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
- document, message threshold and indentation level.
- </summary>
- <param name="doc">Any valid build format will do.</param>
- <param name="threshold">The message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
- <summary>
- Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
- document, message threshold and indentation level, and using
- the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
- settings.
- </summary>
- <param name="doc">Any valid build format will do.</param>
- <param name="threshold">The message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
- <remarks>
- This constructor is useful for developers using NAnt as a class
- library.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32)">
- <summary>
- Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
- source, message threshold and indentation level.
- </summary>
- <param name="uriOrFilePath">
- <para>The full path to the build file.</para>
- <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
- </param>
- <param name="threshold">The message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- <remarks>
- If the source is a uri of form 'file:///path' then use the path part.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Level,System.Int32,System.Xml.XmlNode)">
- <summary>
- Initializes a new <see cref="T:NAnt.Core.Project"/> class with the given
- source, message threshold and indentation level, and using
- the specified <see cref="T:System.Xml.XmlNode"/> to load internal configuration
- settings.
- </summary>
- <param name="uriOrFilePath">
- <para>The full path to the build file.</para>
- <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
- </param>
- <param name="threshold">The message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- <param name="configurationNode">The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize configuration settings.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="configurationNode"/> is <see langword="null"/>.</exception>
- <remarks>
- If the source is a uri of form 'file:///path' then use the path part.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.String,NAnt.Core.Project)">
- <summary>
- Initializes a <see cref="T:NAnt.Core.Project"/> as subproject of the specified
- <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="uriOrFilePath">
- <para>The full path to the build file.</para>
- <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
- </param>
- <param name="parent">The parent <see cref="T:NAnt.Core.Project"/>.</param>
- <remarks>
- Optimized for framework initialization projects, by skipping automatic
- discovery of extension assemblies and framework configuration.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.#ctor(System.Xml.XmlDocument)">
- <summary>
- Initializes a <see cref="T:NAnt.Core.Project"/> with <see cref="P:NAnt.Core.Project.Threshold"/>
- set to <see cref="F:NAnt.Core.Level.None"/>, and <see cref="P:NAnt.Core.Project.IndentationLevel"/>
- set to 0.
- </summary>
- <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> containing the build script.</param>
- <remarks>
- Optimized for framework initialization projects, by skipping automatic
- discovery of extension assemblies and framework configuration.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.OnBuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.BuildStarted"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnBuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.BuildFinished"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnTargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.TargetStarted"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnTargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.TargetFinished"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnTaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.TaskStarted"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnTaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches the <see cref="F:NAnt.Core.Project.TaskFinished"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.OnMessageLogged(NAnt.Core.BuildEventArgs)">
- <summary>
- Dispatches a <see cref="F:NAnt.Core.Project.MessageLogged"/> event to the build listeners
- for this <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String)">
- <summary>
- Writes a <see cref="T:NAnt.Core.Project"/> level message to the build log with
- the given <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
- <param name="message">The message to log.</param>
- </member>
- <member name="M:NAnt.Core.Project.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Writes a <see cref="T:NAnt.Core.Project"/> level formatted message to the build
- log with the given <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- </member>
- <member name="M:NAnt.Core.Project.Log(NAnt.Core.Task,NAnt.Core.Level,System.String)">
- <summary>
- Writes a <see cref="T:NAnt.Core.Task"/> task level message to the build log
- with the given <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> from which the message originated.</param>
- <param name="messageLevel">The <see cref="T:NAnt.Core.Level"/> to log at.</param>
- <param name="message">The message to log.</param>
- </member>
- <member name="M:NAnt.Core.Project.Log(NAnt.Core.Target,NAnt.Core.Level,System.String)">
- <summary>
- Writes a <see cref="T:NAnt.Core.Target"/> level message to the build log with
- the given <see cref="T:NAnt.Core.Level"/>.
- </summary>
- <param name="target">The <see cref="T:NAnt.Core.Target"/> from which the message orignated.</param>
- <param name="messageLevel">The level to log at.</param>
- <param name="message">The message to log.</param>
- </member>
- <member name="M:NAnt.Core.Project.Execute">
- <summary>
- Executes the default target.
- </summary>
- <remarks>
- No top level error handling is done. Any <see cref="T:NAnt.Core.BuildException"/>
- will be passed onto the caller.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.Execute(System.String)">
- <summary>
- Executes a specific target, and its dependencies.
- </summary>
- <param name="targetName">The name of the target to execute.</param>
- <remarks>
- Global tasks are not executed.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.Execute(System.String,System.Boolean)">
- <summary>
- Executes a specific target.
- </summary>
- <param name="targetName">The name of the target to execute.</param>
- <param name="forceDependencies">Whether dependencies should be forced to execute</param>
- <remarks>
- Global tasks are not executed.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.Run">
- <summary>
- Executes the default target and wraps in error handling and time
- stamping.
- </summary>
- <returns>
- <see langword="true" /> if the build was successful; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode)">
- <summary>
- Creates a new <see ref="Task"/> from the given <see cref="T:System.Xml.XmlNode"/>.
- </summary>
- <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
- <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
- </member>
- <member name="M:NAnt.Core.Project.CreateTask(System.Xml.XmlNode,NAnt.Core.Target)">
- <summary>
- Creates a new <see cref="T:NAnt.Core.Task"/> from the given <see cref="T:System.Xml.XmlNode"/>
- within a <see cref="T:NAnt.Core.Target"/>.
- </summary>
- <param name="taskNode">The <see cref="T:NAnt.Core.Task"/> definition.</param>
- <param name="target">The owner <see cref="T:NAnt.Core.Target"/>.</param>
- <returns>The new <see cref="T:NAnt.Core.Task"/> instance.</returns>
- </member>
- <member name="M:NAnt.Core.Project.ExpandProperties(System.String,NAnt.Core.Location)">
- <summary>
- Expands a <see cref="T:System.String"/> from known properties.
- </summary>
- <param name="input">The <see cref="T:System.String"/> with replacement tokens.</param>
- <param name="location">The location in the build file. Used to throw more accurate exceptions.</param>
- <returns>The expanded and replaced <see cref="T:System.String"/>.</returns>
- </member>
- <member name="M:NAnt.Core.Project.GetFullPath(System.String)">
- <summary>
- Combines the specified path with the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of
- the <see cref="T:NAnt.Core.Project"/> to form a full path to file or directory.
- </summary>
- <param name="path">The relative or absolute path.</param>
- <returns>
- A rooted path, or the <see cref="P:NAnt.Core.Project.BaseDirectory"/> of the <see cref="T:NAnt.Core.Project"/>
- if the <paramref name="path"/> parameter is a null reference.
- </returns>
- </member>
- <member name="M:NAnt.Core.Project.CreateDefaultLogger">
- <summary>
- Creates the default <see cref="T:NAnt.Core.IBuildLogger"/> and attaches it to
- the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.Indent">
- <summary>
- Increases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.Unindent">
- <summary>
- Decreases the <see cref="P:NAnt.Core.Project.IndentationLevel"/> of the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.DetachBuildListeners">
- <summary>
- Detaches the currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances
- from the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.AttachBuildListeners(NAnt.Core.BuildListenerCollection)">
- <summary>
- Attaches the specified build listeners to the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="listeners">The <see cref="T:NAnt.Core.IBuildListener"/> instances to attach to the <see cref="T:NAnt.Core.Project"/>.</param>
- <remarks>
- The currently attached <see cref="T:NAnt.Core.IBuildListener"/> instances will
- be detached before the new <see cref="T:NAnt.Core.IBuildListener"/> instances
- are attached.
- </remarks>
- </member>
- <member name="M:NAnt.Core.Project.CtorHelper(System.Xml.XmlDocument,NAnt.Core.Level,System.Int32,NAnt.Core.Optimizations)">
- <summary>
- Inits stuff:
- <para>TypeFactory: Calls Initialize and AddProject </para>
- <para>Log.IndentSize set to 12</para>
- <para>Project properties are initialized ("nant.* stuff set")</para>
- <list type="nant.items">
- <listheader>NAnt Props:</listheader>
- <item>nant.filename</item>
- <item>nant.version</item>
- <item>nant.location</item>
- <item>nant.project.name</item>
- <item>nant.project.buildfile (if doc has baseuri)</item>
- <item>nant.project.basedir</item>
- <item>nant.project.default = defaultTarget</item>
- </list>
- </summary>
- <param name="doc">An <see cref="T:System.Xml.XmlDocument"/> representing the project definition.</param>
- <param name="threshold">The project message threshold.</param>
- <param name="indentLevel">The project indentation level.</param>
- <param name="optimization">Optimization flags.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="doc"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:NAnt.Core.Project.InitializeProjectDocument(System.Xml.XmlDocument)">
- <summary>
- This method is only meant to be used by the <see cref="T:NAnt.Core.Project"/>
- class and <see cref="T:NAnt.Core.Tasks.IncludeTask"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.LoadBuildFile(System.String)">
- <summary>
- Creates a new <see cref="T:System.Xml.XmlDocument"/> based on the project
- definition.
- </summary>
- <param name="uriOrFilePath">
- <para>The full path to the build file.</para>
- <para>This can be of any form that <see cref="M:System.Xml.XmlDocument.Load(System.String)"/> accepts.</para>
- </param>
- <returns>
- An <see cref="T:System.Xml.XmlDocument"/> based on the specified project
- definition.
- </returns>
- </member>
- <member name="M:NAnt.Core.Project.ConfigurePlatformProperties">
- <summary>
- Configures the platform properties for the current platform.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
- </member>
- <member name="M:NAnt.Core.Project.UpdateTargetFrameworkProperties">
- <summary>
- Updates dependent properties when the <see cref="P:NAnt.Core.Project.TargetFramework"/>
- is set.
- </summary>
- </member>
- <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection)">
- <summary>
- Topologically sorts a set of targets.
- </summary>
- <param name="root">The name of the root target. The sort is created in such a way that the sequence of targets up to the root target is the minimum possible such sequence. Must not be <see langword="null"/>.</param>
- <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
- <returns>
- A collection of <see cref="T:NAnt.Core.Target"/> instances in sorted order.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">There is a cyclic dependecy among the targets, or a named target does not exist.</exception>
- </member>
- <member name="M:NAnt.Core.Project.TopologicalTargetSort(System.String,NAnt.Core.TargetCollection,System.Collections.Hashtable,System.Collections.Stack,NAnt.Core.TargetCollection)">
- <summary>
- <para>
- Performs a single step in a recursive depth-first-search traversal
- of the target dependency tree.
- </para>
- <para>
- The current target is first set to the "visiting" state, and pushed
- onto the "visiting" stack.
- </para>
- <para>
- An exception is then thrown if any child of the current node is in
- the visiting state, as that implies a circular dependency. The
- exception contains details of the cycle, using elements of the
- "visiting" stack.
- </para>
- <para>
- If any child has not already been "visited", this method is called
- recursively on it.
- </para>
- <para>
- The current target is then added to the ordered list of targets.
- Note that this is performed after the children have been visited in
- order to get the correct order. The current target is set to the
- "visited" state.
- </para>
- <para>
- By the time this method returns, the ordered list contains the
- sequence of targets up to and including the current target.
- </para>
- </summary>
- <param name="root">The current target to inspect. Must not be <see langword="null"/>.</param>
- <param name="targets">A collection of <see cref="T:NAnt.Core.Target"/> instances.</param>
- <param name="state">A mapping from targets to states The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
- <param name="visiting">A stack of targets which are currently being visited. Must not be <see langword="null"/>.</param>
- <param name="executeTargets">The list to add target names to. This will end up containing the complete list of depenencies in dependency order. Must not be <see langword="null"/>.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>A non-existent target is specified</para>
- <para>-or-</para>
- <para>A circular dependency is detected.</para>
- </exception>
- </member>
- <member name="M:NAnt.Core.Project.CreateCircularException(System.String,System.Collections.Stack)">
- <summary>
- Builds an appropriate exception detailing a specified circular
- dependency.
- </summary>
- <param name="end">The dependency to stop at. Must not be <see langword="null"/>.</param>
- <param name="stack">A stack of dependencies. Must not be <see langword="null"/>.</param>
- <returns>
- A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
- dependency.
- </returns>
- </member>
- <member name="P:NAnt.Core.Project.IndentationLevel">
- <summary>
- Gets or sets the indendation level of the build output.
- </summary>
- <value>
- The indentation level of the build output.
- </value>
- <remarks>
- To change the <see cref="P:NAnt.Core.Project.IndentationLevel"/>, the <see cref="M:NAnt.Core.Project.Indent"/>
- and <see cref="M:NAnt.Core.Project.Unindent"/> methods should be used.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.IndentationSize">
- <summary>
- Gets or sets the indentation size of the build output.
- </summary>
- <value>
- The indendation size of the build output.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.Threshold">
- <summary>
- Gets or sets the default threshold level for build loggers.
- </summary>
- <value>
- The default threshold level for build loggers.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.ProjectName">
- <summary>
- Gets the name of the <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <value>
- The name of the <see cref="T:NAnt.Core.Project"/> or an empty <see cref="T:System.String"/>
- if no name is specified.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.BaseDirectory">
- <summary>
- Gets or sets the base directory used for relative references.
- </summary>
- <value>
- The base directory used for relative references.
- </value>
- <exception cref="T:NAnt.Core.BuildException">The directory is not rooted.</exception>
- <remarks>
- <para>
- The <see cref="P:NAnt.Core.Project.BaseDirectory"/> gets and sets the built-in property
- named "nant.project.basedir".
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.NamespaceManager">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.Project.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.BuildFileUri">
- <summary>
- Gets the <see cref="T:System.Uri"/> form of the current project definition.
- </summary>
- <value>
- The <see cref="T:System.Uri"/> form of the current project definition.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.Frameworks">
- <summary>
- Gets a collection of available .NET frameworks.
- </summary>
- <value>
- A collection of available .NET frameworks.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.RuntimeFramework">
- <summary>
- Gets the framework in which NAnt is currently running.
- </summary>
- <value>
- The framework in which NAnt is currently running.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.TargetFramework">
- <summary>
- Gets or sets the framework to use for compilation.
- </summary>
- <value>
- The framework to use for compilation.
- </value>
- <remarks>
- We will use compiler tools and system assemblies for this framework
- in framework-related tasks.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.PlatformName">
- <summary>
- Gets the name of the platform on which NAnt is currently running.
- </summary>
- <value>
- The name of the platform on which NAnt is currently running.
- </value>
- <remarks>
- <para>
- Possible values are:
- </para>
- <list type="bullet">
- <item>
- <description>win32</description>
- </item>
- <item>
- <description>unix</description>
- </item>
- </list>
- </remarks>
- <exception cref="T:NAnt.Core.BuildException">NAnt does not support the current platform.</exception>
- </member>
- <member name="P:NAnt.Core.Project.CurrentTarget">
- <summary>
- Gets the current target.
- </summary>
- <value>
- The current target, or <see langword="null" /> if no target is
- executing.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.BuildFileLocalName">
- <summary>
- Gets the path to the build file.
- </summary>
- <value>
- The path to the build file, or <see langword="null" /> if the build
- document is not file backed.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.Document">
- <summary>
- Gets the active <see cref="T:NAnt.Core.Project"/> definition.
- </summary>
- <value>
- The active <see cref="T:NAnt.Core.Project"/> definition.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.ConfigurationNode">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
- configuration settings.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNode"/> NAnt should use to initialize
- configuration settings.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.DefaultTargetName">
- <remarks>
- Gets the name of the target that will be executed when no other
- build targets are specified.
- </remarks>
- <value>
- The name of the target that will be executed when no other
- build targets are specified, or <see langword="null" /> if no
- default target is specified in the build file.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.Verbose">
- <summary>
- Gets a value indicating whether tasks should output more build log
- messages.
- </summary>
- <value>
- <see langword="true" /> if tasks should output more build log message;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.BuildTargets">
- <summary>
- The list of targets to build.
- </summary>
- <remarks>
- Targets are built in the order they appear in the collection. If
- the collection is empty the default target will be built.
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.Properties">
- <summary>
- Gets the properties defined in this project.
- </summary>
- <value>The properties defined in this project.</value>
- <remarks>
- <para>
- This is the collection of properties that are defined by the system
- and property task statements.
- </para>
- <para>
- These properties can be used in expansion.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.FrameworkNeutralProperties">
- <summary>
- Gets the framework-neutral properties defined in the NAnt
- configuration file.
- </summary>
- <value>
- The framework-neutral properties defined in the NAnt configuration
- file.
- </value>
- <remarks>
- <para>
- This is the collection of read-only properties that are defined in
- the NAnt configuration file.
- </para>
- <para>
- 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.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.DataTypeReferences">
- <summary>
- Gets the <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
- </summary>
- <value>
- The <see cref="T:NAnt.Core.DataTypeBase"/> instances defined in this project.
- </value>
- <remarks>
- <para>
- This is the collection of <see cref="T:NAnt.Core.DataTypeBase"/> instances that
- are defined by <see cref="T:NAnt.Core.DataTypeBase"/> (eg fileset) declarations.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Project.Targets">
- <summary>
- Gets the targets defined in this project.
- </summary>
- <value>
- The targets defined in this project.
- </value>
- </member>
- <member name="P:NAnt.Core.Project.BuildListeners">
- <summary>
- Gets the build listeners for this project.
- </summary>
- <value>
- The build listeners for this project.
- </value>
- </member>
- <member name="T:NAnt.Core.Optimizations">
- <summary>
- Allow the project construction to be optimized.
- </summary>
- <remarks>
- Use this with care!
- </remarks>
- </member>
- <member name="F:NAnt.Core.Optimizations.None">
- <summary>
- Do not perform any optimizations.
- </summary>
- </member>
- <member name="F:NAnt.Core.Optimizations.SkipAutomaticDiscovery">
- <summary>
- The project base directory must not be automatically scanned
- for extension assemblies.
- </summary>
- </member>
- <member name="F:NAnt.Core.Optimizations.SkipFrameworkConfiguration">
- <summary>
- Do not scan the project configuration for frameworks, and
- do not configure the runtime and target framework.
- </summary>
- </member>
- <member name="F:NAnt.Core.ProjectSettingsLoader.ScannedTasks">
- <summary>
- Holds a value indicating whether a scan for tasks, types and functions
- has already been performed for the current runtime framework.
- </summary>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.#ctor(NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ProjectSettingsLoader"/>
- class for the given <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/>.
- </summary>
- <param name="project">The <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> that should be configured.</param>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessSettings">
- <summary>
- Loads and processes settings from the specified <see cref="T:System.Xml.XmlNode"/>
- of the configuration file.
- </summary>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessFrameworks(System.Xml.XmlNode)">
- <summary>
- Processes the framework nodes of the given platform node.
- </summary>
- <param name="platformNode">An <see cref="T:System.Xml.XmlNode"/> representing the platform on which NAnt is running.</param>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.ProcessGlobalProperties(System.Xml.XmlNodeList)">
- <summary>
- Reads the list of global properties specified in the NAnt configuration
- file.
- </summary>
- <param name="propertyNodes">An <see cref="T:System.Xml.XmlNodeList"/> representing global properties.</param>
- </member>
- <member name="M:NAnt.Core.ProjectSettingsLoader.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
- <summary>
- Gets the value of the specified attribute from the specified node.
- </summary>
- <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
- <param name="attributeName">The attribute of which the value should be returned.</param>
- <returns>
- The value of the attribute with the specified name or <see langword="null" />
- if the attribute does not exist or has no value.
- </returns>
- </member>
- <member name="P:NAnt.Core.ProjectSettingsLoader.Project">
- <summary>
- Gets the underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
- </summary>
- <value>
- The underlying <see cref="P:NAnt.Core.ProjectSettingsLoader.Project"/> instance.
- </value>
- </member>
- <member name="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager">
- <summary>
- Gets the <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </summary>
- <value>
- The <see cref="T:System.Xml.XmlNamespaceManager"/>.
- </value>
- <remarks>
- The <see cref="P:NAnt.Core.ProjectSettingsLoader.NamespaceManager"/> defines the current namespace
- scope and provides methods for looking up namespace information.
- </remarks>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary.Visiting">
- <summary>
- Constant for the "visiting" state, used when traversing a DFS of
- property references.
- </summary>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary.Visited">
- <summary>
- Constant for the "visited" state, used when travesing a DFS of
- property references.
- </summary>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.#ctor(NAnt.Core.Project)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.PropertyDictionary"/>
- class holding properties for the given <see cref="P:NAnt.Core.PropertyDictionary.Project"/>
- instance.
- </summary>
- <param name="project">The project for which the dictionary will hold properties.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.OnInsert(System.Object,System.Object)">
- <summary>
- Performs additional custom processes before inserting a new element
- into the <see cref="T:System.Collections.DictionaryBase"/> instance.
- </summary>
- <param name="key">The key of the element to insert.</param>
- <param name="value">The value of the element to insert.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.OnRemove(System.Object,System.Object)">
- <summary>
- Performs additional custom processes before removing an element
- from the <see cref="T:System.Collections.DictionaryBase"/> instance.
- </summary>
- <param name="key">The key of the element to remove.</param>
- <param name="value">The value of the element to remove.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.OnValidate(System.Object,System.Object)">
- <summary>
- Performs additional custom processes when validating the element
- with the specified key and value.
- </summary>
- <param name="key">The key of the element to validate.</param>
- <param name="value">The value of the element to validate.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.AddReadOnly(System.String,System.String)">
- <summary>
- Adds a property that cannot be changed.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value to assign to the property.</param>
- <remarks>
- Properties added with this method can never be changed. Note that
- they are removed if the <see cref="M:System.Collections.DictionaryBase.Clear"/> method is called.
- </remarks>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.MarkDynamic(System.String)">
- <summary>
- Marks a property as a property of which the value is expanded at
- execution time.
- </summary>
- <param name="name">The name of the property to mark as dynamic.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.Add(System.String,System.String)">
- <summary>
- Adds a property to the collection.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="value">The value to assign to the property.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.IsReadOnlyProperty(System.String)">
- <summary>
- Determines whether the specified property is listed as read-only.
- </summary>
- <param name="name">The name of the property to check.</param>
- <returns>
- <see langword="true" /> if the property is listed as read-only;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.IsDynamicProperty(System.String)">
- <summary>
- Determines whether the specified property is listed as dynamic.
- </summary>
- <param name="name">The name of the property to check.</param>
- <returns>
- <see langword="true" /> if the property is listed as dynamic;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.Inherit(NAnt.Core.PropertyDictionary,System.Collections.Specialized.StringCollection)">
- <summary>
- Inherits properties from an existing property dictionary Instance.
- </summary>
- <param name="source">Property list to inherit.</param>
- <param name="excludes">The list of properties to exclude during inheritance.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location)">
- <summary>
- Expands a <see cref="T:System.String"/> from known properties.
- </summary>
- <param name="input">The replacement tokens.</param>
- <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
- <returns>The expanded and replaced string.</returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.Contains(System.String)">
- <summary>
- Determines whether a property already exists.
- </summary>
- <param name="name">The name of the property to check.</param>
- <returns>
- <see langword="true" /> if the specified property already exists;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.Remove(System.String)">
- <summary>
- Removes the property with the specified name.
- </summary>
- <param name="name">The name of the property to remove.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.ExpandProperties(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
- <summary>
- Expands a <see cref="T:System.String"/> from known properties.
- </summary>
- <param name="input">The replacement tokens.</param>
- <param name="location">The <see cref="T:NAnt.Core.Location"/> to pass through for any exceptions.</param>
- <param name="state">A mapping from properties to states. The states in question are "VISITING" and "VISITED". Must not be <see langword="null"/>.</param>
- <param name="visiting">A stack of properties which are currently being visited. Must not be <see langword="null"/>.</param>
- <returns>The expanded and replaced string.</returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.EvaluateEmbeddedExpressions(System.String,NAnt.Core.Location,System.Collections.Hashtable,System.Collections.Stack)">
- <summary>
- Evaluates the given expression string and returns the result
- </summary>
- <param name="input"></param>
- <param name="location"></param>
- <param name="state"></param>
- <param name="visiting"></param>
- <returns></returns>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.CheckDeprecation(System.String)">
- <summary>
- Checks whether the specified property is deprecated.
- </summary>
- <param name="name">The property to check.</param>
- </member>
- <member name="M:NAnt.Core.PropertyDictionary.CreateCircularException(System.String,System.Collections.Stack)">
- <summary>
- Builds an appropriate exception detailing a specified circular
- reference.
- </summary>
- <param name="end">The property reference to stop at. Must not be <see langword="null"/>.</param>
- <param name="stack">A stack of property references. Must not be <see langword="null"/>.</param>
- <returns>
- A <see cref="T:NAnt.Core.BuildException"/> detailing the specified circular
- dependency.
- </returns>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary._readOnlyProperties">
- <summary>
- Maintains a list of the property names that are readonly.
- </summary>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary._dynamicProperties">
- <summary>
- Maintains a list of the property names of which the value is expanded
- on usage, not at initalization.
- </summary>
- </member>
- <member name="F:NAnt.Core.PropertyDictionary._project">
- <summary>
- The project for which the dictionary holds properties.
- </summary>
- </member>
- <member name="P:NAnt.Core.PropertyDictionary.Item(System.String)">
- <summary>
- Indexer property.
- </summary>
- </member>
- <member name="P:NAnt.Core.PropertyDictionary.Project">
- <summary>
- Gets the project for which the dictionary holds properties.
- </summary>
- <value>
- The project for which the dictionary holds properties.
- </value>
- </member>
- <member name="M:NAnt.Core.Target.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.Target"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.Target.System#ICloneable#Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Target.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.Core.Target"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.Core.Target"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.Target.Execute">
- <summary>
- Executes dependent targets first, then the target.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.Executed">
- <summary>
- This indicates whether the target has already executed.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.Name">
- <summary>
- The name of the target.
- </summary>
- <remarks>
- <para>
- Hides <see cref="P:NAnt.Core.Element.Name"/> to have <see cref="T:NAnt.Core.Target"/>
- return the name of target, not the name of XML element - which
- would always be <c>target</c>.
- </para>
- <para>
- Note: Properties are not allowed in the name.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Core.Target.IfCondition">
- <summary>
- If <see langword="true" /> then the target will be executed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.IfDefined">
- <summary>
- Gets a value indicating whether the target should be executed.
- </summary>
- <value>
- <see langword="true" /> if the target should be executed; otherwise,
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Target.UnlessCondition">
- <summary>
- Opposite of <see cref="P:NAnt.Core.Target.IfDefined"/>. If <see langword="false"/>
- then the target will be executed; otherwise, skipped. The default
- is <see langword="false"/>.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.UnlessDefined">
- <summary>
- Gets a value indicating whether the target should NOT be executed.
- </summary>
- <value>
- <see langword="true" /> if the target should NOT be executed;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.Core.Target.Description">
- <summary>
- The description of the target.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.DependsListString">
- <summary>
- Space separated list of targets that this target depends on.
- </summary>
- </member>
- <member name="P:NAnt.Core.Target.Dependencies">
- <summary>
- A collection of target names that must be executed before this
- target.
- </summary>
- </member>
- <member name="M:NAnt.Core.TargetCollection.Find(System.String)">
- <summary>
- Finds a target by name.
- </summary>
- <param name="targetName">The name of the target to find.</param>
- <returns>
- The <see cref="T:NAnt.Core.Target"/> with the specified name, or
- <see langword="null"/> if no <see cref="T:NAnt.Core.Target"/> exists with
- the given name.
- </returns>
- </member>
- <member name="M:NAnt.Core.TargetCollection.ToString(System.String)">
- <summary>
- Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
- combined into one list separated by the given <see cref="T:System.String"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that contains a list of the names of the
- targets in the <see cref="T:NAnt.Core.TargetCollection"/>, separated by
- the specified <paramref name="separator"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TargetCollection.ToString">
- <summary>
- Gets the names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>
- combined into one comma-separated list.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that contains a comma-separated list of the
- names of the targets in the <see cref="T:NAnt.Core.TargetCollection"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilder.#ctor(NAnt.Core.Extensibility.ExtensionAssembly,System.String)">
- <summary>
- Creates a new instance of the <see cref="T:NAnt.Core.TaskBuilder"/> class
- for the specified <see cref="T:NAnt.Core.Task"/> class in the specified
- <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/>.
- </summary>
- <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:NAnt.Core.Task"/>.</param>
- <param name="className">The class representing the <see cref="T:NAnt.Core.Task"/>.</param>
- </member>
- <member name="P:NAnt.Core.TaskBuilder.ClassName">
- <summary>
- Gets the name of the <see cref="T:NAnt.Core.Task"/> class that can be created
- using this <see cref="T:NAnt.Core.TaskBuilder"/>.
- </summary>
- <value>
- The name of the <see cref="T:NAnt.Core.Task"/> class that can be created using
- this <see cref="T:NAnt.Core.TaskBuilder"/>.
- </value>
- </member>
- <member name="P:NAnt.Core.TaskBuilder.TaskName">
- <summary>
- Gets the name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/>
- can create.
- </summary>
- <value>
- The name of the task which the <see cref="T:NAnt.Core.TaskBuilder"/> can
- create.
- </value>
- </member>
- <member name="T:NAnt.Core.TaskBuilderCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.Core.TaskBuilder"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
- with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.#ctor(NAnt.Core.TaskBuilder[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderCollection"/> class
- with the specified array of <see cref="T:NAnt.Core.TaskBuilder"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Add(NAnt.Core.TaskBuilder)">
- <summary>
- Adds a <see cref="T:NAnt.Core.TaskBuilder"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilder[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.TaskBuilder"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.Core.TaskBuilder"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.AddRange(NAnt.Core.TaskBuilderCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.Core.TaskBuilderCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Contains(NAnt.Core.TaskBuilder)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.Core.TaskBuilder"/> for the specified
- task is in the collection.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.Core.TaskBuilder"/> for the
- specified task is found in the collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.CopyTo(NAnt.Core.TaskBuilder[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.IndexOf(NAnt.Core.TaskBuilder)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.Core.TaskBuilder"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.Core.TaskBuilder"/>. If the <see cref="T:NAnt.Core.TaskBuilder"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Insert(System.Int32,NAnt.Core.TaskBuilder)">
- <summary>
- Inserts a <see cref="T:NAnt.Core.TaskBuilder"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to insert.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderCollection.Remove(NAnt.Core.TaskBuilder)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.Core.TaskBuilder"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.Core.TaskBuilderCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.Core.TaskBuilder"/> for the specified task.
- </summary>
- <param name="taskName">The name of task for which the <see cref="T:NAnt.Core.TaskBuilder"/> should be located in the collection.</param>
- </member>
- <member name="T:NAnt.Core.TaskBuilderEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.Core.TaskBuilder"/> elements of a <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.Core.TaskBuilderEnumerator.#ctor(NAnt.Core.TaskBuilderCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.TaskBuilderEnumerator"/> class
- with the specified <see cref="T:NAnt.Core.TaskBuilderCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.Core.TaskBuilderEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.Core.TaskBuilderEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.Core.TaskBuilderEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.Core.TypeFactory">
- <summary>
- Comprises all of the loaded, and available, tasks.
- Use these static methods to register, initialize and create a task.
- </summary>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.String,NAnt.Core.Task)">
- <summary>
- Scans the given assembly for tasks, types, functions and filters.
- </summary>
- <param name="assemblyFile">The assembly to scan for tasks, types, functions and filters.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanAssembly(System.Reflection.Assembly,NAnt.Core.Task)">
- <summary>
- Scans the given assembly for tasks, types, functions and filters.
- </summary>
- <param name="assembly">The assembly to scan for tasks, types, functions and filters.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="assembly"/> contains at
- least one "extension"; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanDir(System.String,NAnt.Core.Task,System.Boolean)">
- <summary>
- Scans the path for any task assemblies and adds them.
- </summary>
- <param name="path">The directory to scan in.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <param name="failOnError"><see cref="T:System.Boolean"/> indicating whether scanning of the directory should halt on first error.</param>
- </member>
- <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project)">
- <summary>
- Adds any task assemblies in the project base directory
- and its <c>tasks</c> subdirectory.
- </summary>
- <param name="project">The project to work from.</param>
- </member>
- <member name="M:NAnt.Core.TypeFactory.AddProject(NAnt.Core.Project,System.Boolean)">
- <summary>
- Registers the project with <see cref="T:NAnt.Core.TypeFactory"/>, and optionally
- scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.
- </summary>
- <param name="project">The project to work from.</param>
- <param name="scan">Specified whether to scan the <see cref="P:NAnt.Core.Project.BaseDirectory"/> for extension assemblies.</param>
- </member>
- <member name="M:NAnt.Core.TypeFactory.LookupFunction(System.String,NAnt.Core.Project)">
- <summary>
- Looks up a function by name.
- </summary>
- <param name="methodName">The name of the function to lookup, including namespace prefix.</param>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> in which the function is invoked.</param>
- <returns>
- A <see cref="T:System.Reflection.MethodInfo"/> representing the function, or
- <see langword="null"/> if a function with the given name does not
- exist.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.CreateTask(System.Xml.XmlNode,NAnt.Core.Project)">
- <summary>
- Creates a new <see cref="T:NAnt.Core.Task"/> instance for the given XML and
- <see cref="T:NAnt.Core.Project"/>.
- </summary>
- <param name="taskNode">The XML to initialize the task with.</param>
- <param name="proj">The <see cref="T:NAnt.Core.Project"/> that the <see cref="T:NAnt.Core.Task"/> belongs to.</param>
- <returns>
- The new <see cref="T:NAnt.Core.Task"/> instance.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanTypeForTasks(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for tasks.
- </summary>
- <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- <see cref="T:NAnt.Core.Task"/>; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanTypeForDataTypes(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for data type.
- </summary>
- <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- data type; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanTypeForFunctions(System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for functions.
- </summary>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- valid set of funtions; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.Core.TypeFactory.ScanTypeForFilters(NAnt.Core.Extensibility.ExtensionAssembly,System.Type,NAnt.Core.Task)">
- <summary>
- Scans a given <see cref="T:System.Type"/> for filters.
- </summary>
- <param name="extensionAssembly">The <see cref="T:NAnt.Core.Extensibility.ExtensionAssembly"/> containing the <see cref="T:System.Type"/> to scan.</param>
- <param name="type">The <see cref="T:System.Type"/> to scan.</param>
- <param name="task">The <see cref="T:NAnt.Core.Task"/> which will be used to output messages to the build log.</param>
- <returns>
- <see langword="true"/> if <paramref name="type"/> represents a
- <see cref="T:NAnt.Core.Filters.Filter"/>; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="P:NAnt.Core.TypeFactory.TaskBuilders">
- <summary>
- Gets the list of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
- </summary>
- <value>
- List of loaded <see cref="T:NAnt.Core.TaskBuilder"/> instances.
- </value>
- </member>
- <member name="P:NAnt.Core.TypeFactory.DataTypeBuilders">
- <summary>
- Gets the list of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
- </summary>
- <value>
- List of loaded <see cref="T:NAnt.Core.DataTypeBaseBuilder"/> instances.
- </value>
- </member>
- <member name="P:NAnt.Core.TypeFactory.FilterBuilders">
- <summary>
- Gets the list of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
- </summary>
- <value>
- List of loaded <see cref="T:NAnt.Core.Filters.FilterBuilder"/> instances.
- </value>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with a descriptive message.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with the specified descriptive message and inner exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with a descriptive message and the location in the build file
- that caused the exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="location">The location in the build file where the exception occured.</param>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.String,NAnt.Core.Location,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with a descriptive message, the location in the build file and
- an instance of the exception that is the cause of the current
- exception.
- </summary>
- <param name="message">A descriptive message to include with the exception.</param>
- <param name="location">The location in the build file where the exception occured.</param>
- <param name="innerException">A nested exception that is the cause of the current exception.</param>
- </member>
- <member name="M:NAnt.Core.ValidationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.ValidationException"/>
- class with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:NAnt.Core.XmlLogger">
- <summary>
- Used to wrap log messages in xml <message/> elements.
- </summary>
- </member>
- <member name="F:NAnt.Core.XmlLogger._projectStack">
- <summary>
- Holds the stack of currently executing projects.
- </summary>
- </member>
- <member name="M:NAnt.Core.XmlLogger.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class.
- </summary>
- </member>
- <member name="M:NAnt.Core.XmlLogger.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Core.XmlLogger"/> class
- with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="M:NAnt.Core.XmlLogger.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Populates <paramref name="info"/> with the data needed to serialize
- the <see cref="T:NAnt.Core.XmlLogger"/> instance.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> to populate with data.</param>
- <param name="context">The destination for this serialization.</param>
- </member>
- <member name="M:NAnt.Core.XmlLogger.ToString">
- <summary>
- Returns the contents of log captured.
- </summary>
- </member>
- <member name="M:NAnt.Core.XmlLogger.BuildStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a build has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event is fired before any targets have started.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.BuildFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that the last target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.TargetStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.XmlLogger.TargetFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a target has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.TaskStarted(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has started.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- </member>
- <member name="M:NAnt.Core.XmlLogger.TaskFinished(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a task has finished.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- This event will still be fired if an error occurred during the build.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.MessageLogged(System.Object,NAnt.Core.BuildEventArgs)">
- <summary>
- Signals that a message has been logged.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NAnt.Core.BuildEventArgs"/> object that contains the event data.</param>
- <remarks>
- Only messages with a priority higher or equal to the threshold of
- the logger will actually be output in the build log.
- </remarks>
- </member>
- <member name="M:NAnt.Core.XmlLogger.Flush">
- <summary>
- Flushes buffered build events or messages to the underlying storage.
- </summary>
- </member>
- <member name="P:NAnt.Core.XmlLogger.Threshold">
- <summary>
- Gets or sets the highest level of message this logger should respond
- to.
- </summary>
- <value>
- The highest level of message this logger should respond to.
- </value>
- <remarks>
- Only messages with a message level higher than or equal to the given
- level should be written to the log.
- </remarks>
- </member>
- <member name="P:NAnt.Core.XmlLogger.EmacsMode">
- <summary>
- Gets or sets a value indicating whether to produce emacs (and other
- editor) friendly output.
- </summary>
- <value>
- <see langword="false" /> as it has no meaning in XML format.
- </value>
- </member>
- <member name="P:NAnt.Core.XmlLogger.OutputWriter">
- <summary>
- Gets or sets the <see cref="T:System.IO.TextWriter"/> to which the logger is
- to send its output.
- </summary>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.DotNetTasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.DotNetTasks.xml
@@ -1,5318 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.DotNetTasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.DotNet.Tasks.AssemblyInfoTask">
- <summary>
- Generates an AssemblyInfo file using the attributes given.
- </summary>
- <example>
- <para>
- Create a C# AssemblyInfo file containing the specified assembly-level
- attributes.
- </para>
- <code>
- <![CDATA[
- <asminfo output="AssemblyInfo.cs" language="CSharp">
- <imports>
- <import namespace="System" />
- <import namespace="System.Reflection" />
- <import namespace="System.EnterpriseServices" />
- <import namespace="System.Runtime.InteropServices" />
- </imports>
- <attributes>
- <attribute type="ComVisibleAttribute" value="false" />
- <attribute type="CLSCompliantAttribute" value="true" />
- <attribute type="AssemblyVersionAttribute" value="1.0.0.0" />
- <attribute type="AssemblyTitleAttribute" value="My fun assembly" />
- <attribute type="AssemblyDescriptionAttribute" value="More fun than a barrel of monkeys" />
- <attribute type="AssemblyCopyrightAttribute" value="Copyright (c) 2002, Monkeyboy, Inc." />
- <attribute type="ApplicationNameAttribute" value="FunAssembly" />
- </attributes>
- <references>
- <include name="System.EnterpriseServices.dll" />
- </references>
- </asminfo>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Create a C# AssemblyInfo file containing an attribute with multiple
- named properties by setting the <see cref="P:NAnt.DotNet.Types.AssemblyAttribute.AsIs"/>
- attribute on the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> element to
- <see langword="true"/>.
- </para>
- <code>
- <![CDATA[
- <asminfo output="AssemblyInfo.cs" language="CSharp">
- <imports>
- <import namespace="log4net.Config" />
- </imports>
- <attributes>
- <attribute type="DOMConfiguratorAttribute" value="ConfigFile="config.log4net",Watch=true" asis="true" />
- </attributes>
- <references>
- <include name="log4net.dll" />
- </references>
- </asminfo>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.ExecuteTask">
- <summary>
- Generates an AssemblyInfo file.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.NeedsPersisting(System.IO.Stream)">
- <summary>
- Determines whether the specified AssemblyInfo file in the given
- <see cref="T:System.IO.Stream"/> needs to be persisted.
- </summary>
- <param name="generatedAsmInfoStream"><see cref="T:System.IO.Stream"/> holding the newly generated AssemblyInfo source.</param>
- <returns>
- <see langword="true"/> if the generated AssemblyInfo source needs
- to be persisted; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.Output">
- <summary>
- Name of the AssemblyInfo file to generate.
- </summary>
- <value>
- The name of the AssemblyInfo file to generate.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.Language">
- <summary>
- The code language in which the AssemblyInfo file should be
- generated.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.AssemblyAttributes">
- <summary>
- The assembly-level attributes to generate.
- </summary>
- <value>
- The assembly-level attributes to generate.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.Imports">
- <summary>
- The namespaces to import.
- </summary>
- <value>
- The namespaces to import.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.References">
- <summary>
- Assembly files used to locate the types of the specified attributes.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage">
- <summary>
- Defines the supported code languages for generating an AssemblyInfo
- file.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage.CSharp">
- <summary>
- A value for generating C# code.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage.JScript">
- <summary>
- A value for generating JScript code.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage.VB">
- <summary>
- A value for generating Visual Basic code.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider">
- <summary>
- Encapsulates functionality to generate a code file with imports
- and assembly-level attributes.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.#ctor(NAnt.DotNet.Tasks.AssemblyInfoTask,NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider"/>
- for the specified <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage"/>.
- </summary>
- <param name="assemblyInfoTask">The <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask"/> for which an instance of the <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider"/> class should be initialized.</param>
- <param name="codeLanguage">The <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage"/> for which an instance of the <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider"/> class should be initialized.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.GenerateImportCode(System.Collections.Specialized.StringCollection,System.IO.TextWriter)">
- <summary>
- Generates code for the specified imports.
- </summary>
- <param name="imports">The imports for which code should be generated.</param>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the generated code will be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.GenerateAssemblyAttributesCode(NAnt.DotNet.Types.AssemblyAttributeCollection,System.Collections.Specialized.StringCollection,System.Collections.Specialized.StringCollection,System.IO.TextWriter)">
- <summary>
- Generates code for the specified assembly attributes.
- </summary>
- <param name="assemblyAttributes">The assembly attributes for which code should be generated.</param>
- <param name="imports">Imports used to resolve the assembly attribute names to fully qualified type names.</param>
- <param name="assemblies">Assembly that will be used to resolve the attribute names to <see cref="T:System.Type"/> instances.</param>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the generated code will be written.</param>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.Language">
- <summary>
- Gets the <see cref="T:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeLanguage"/> in which the AssemblyInfo
- code will be generated.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyInfoTask.CodeProvider.Generator">
- <summary>
- Gets the <see cref="T:System.CodeDom.Compiler.ICodeGenerator"/> that will be used to
- generate the AssemblyInfo code.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Tasks.AssemblyInfoTask.TypedValueGatherer">
- <summary>
- Responsible for returning the specified value converted to a
- <see cref="T:System.Type"/> accepted by a constructor for a given
- <see cref="T:System.Type"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.TypedValueGatherer.InitializeLifetimeService">
- <summary>
- Obtains a lifetime service object to control the lifetime policy for
- this instance.
- </summary>
- <returns>
- An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
- policy for this instance. This is the current lifetime service object
- for this instance if one exists; otherwise, a new lifetime service
- object initialized with a lease that will never time out.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyInfoTask.TypedValueGatherer.GetTypedValue(System.Collections.Specialized.StringCollection,System.Collections.Specialized.StringCollection,System.String,System.String)">
- <summary>
- Retrieves the specified <see cref="T:System.Type"/> corresponding with the specified
- type name from a list of assemblies.
- </summary>
- <param name="assemblies">The collection of assemblies that the type should tried to be instantiated from.</param>
- <param name="imports">The list of imports that can be used to resolve the typename to a full typename.</param>
- <param name="typename">The typename that should be used to determine the type to which the specified value should be converted.</param>
- <param name="value">The <see cref="T:System.String"/> value that should be converted to a typed value.</param>
- <returns></returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para><paramref name="value"/> is <see langword="null"/> and the <see cref="T:System.Type"/> identified by <paramref name="typename"/> has no default public constructor.</para>
- <para>-or-</para>
- <para><paramref name="value"/> cannot be converted to a value that's suitable for one of the constructors of the <see cref="T:System.Type"/> identified by <paramref name="typename"/>.</para>
- <para>-or-</para>
- <para>The <see cref="T:System.Type"/> identified by <paramref name="typename"/> has no suitable constructor.</para>
- <para>-or-</para>
- <para>A <see cref="T:System.Type"/> identified by <paramref name="typename"/> could not be located or loaded.</para>
- </exception>
- </member>
- <member name="T:NAnt.DotNet.Tasks.AssemblyLinkerTask">
- <summary>
- Wraps <c>al.exe</c>, the assembly linker for the .NET Framework.
- </summary>
- <remarks>
- <para>
- All specified sources will be embedded using the <c>/embed</c> flag.
- Other source types are not supported.
- </para>
- </remarks>
- <example>
- <para>
- Create a library containing all icon files in the current directory.
- </para>
- <code>
- <![CDATA[
- <al output="MyIcons.dll" target="lib">
- <sources>
- <include name="*.ico" />
- </sources>
- </al>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Create an executable assembly manifest from modules.
- </para>
- <code>
- <![CDATA[
- <al output="Client.exe" target="exe" main="Program.Main">
- <modules>
- <include name="Client.netmodule" />
- <include name="Common.netmodule" />
- </modules>
- </al>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyLinkerTask.ExecuteTask">
- <summary>
- Generates an assembly manifest.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.AssemblyLinkerTask.NeedsCompiling">
- <summary>
- Determines whether the assembly manifest needs compiling or is
- uptodate.
- </summary>
- <returns>
- <see langword="true" /> if the assembly manifest needs compiling;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.AlgorithmID">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Company">
- <summary>
- Specifies a string for the <b>Company</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>Company</b> field in the assembly.
- </value>
- <remarks>
- If <see cref="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Company"/> is an empty string (""), the Win32
- <b>Company</b> resource appears as a single space.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Configuration">
- <summary>
- Specifies a string for the <b>Configuration</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>Configuration</b> field in the assembly.
- </value>
- <remarks>
- If <see cref="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Configuration"/> is an empty string (""), the Win32
- <b>Configuration</b> resource appears as a single space.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Copyright">
- <summary>
- Specifies a string for the <b>Copyright</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>Copyright</b> field in the assembly.
- </value>
- <remarks>
- If <see cref="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Copyright"/> is an empty string (""), the Win32
- <b>Copyright</b> resource appears as a single space.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Culture">
- <summary>
- The culture string associated with the output assembly.
- The string must be in RFC 1766 format, such as "en-US".
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/c[ulture]:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.DelaySign">
- <summary>
- Specifies whether the assembly should be partially signed. The default
- is <see langword="NAnt.DotNet.Types.DelaySign.NotSet" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Description">
- <summary>
- Specifies a string for the <b>Description</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>Description</b> field in the assembly.
- </value>
- <remarks>
- If <see cref="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Description"/> is an empty string (""), the Win32
- <b>Description</b> resource appears as a single space.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.EvidenceFile">
- <summary>
- Security evidence file to embed.
- </summary>
- <value>
- The security evidence file to embed.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/e[vidence]</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.FileVersion">
- <summary>
- Specifies a string for the <b>File Version</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>File Version</b> field in the assembly.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Flags">
- <summary>
- Specifies a value (in hexadecimal) for the <b>Flags</b> field in
- the assembly.
- </summary>
- <value>
- A value (in hexadecimal) for the <b>Flags</b> field in the assembly.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.KeyContainer">
- <summary>
- Specifies a container that holds a key pair.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.KeyFile">
- <summary>
- Specifies a file (filename) that contains a key pair or
- just a public key to sign an assembly.
- </summary>
- <value>
- The complete path to the key file.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/keyf[ile]:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.MainMethod">
- <summary>
- Specifies the fully-qualified name (class.method) of the method to
- use as an entry point when converting a module to an executable file.
- </summary>
- <value>
- The fully-qualified name (class.method) of the method to use as an
- entry point when converting a module to an executable file.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.ModuleSet">
- <summary>
- One or more modules to be compiled into an assembly.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.OutputFile">
- <summary>
- The name of the output file for the assembly manifest.
- </summary>
- <value>
- The complete output path for the assembly manifest.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/out</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.OutputTarget">
- <summary>
- The target type (one of <c>lib</c>, <c>exe</c>, or <c>winexe</c>).
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/t[arget]:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Product">
- <summary>
- Specifies a string for the <b>Product</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>Product</b> field in the assembly.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.ProductVersion">
- <summary>
- Specifies a string for the <b>Product Version</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>Product Version</b> field in the assembly.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Resources">
- <summary>
- The set of resources to embed.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.EmbeddedResources">
- <summary>
- The set of compiled resources to embed.
- </summary>
- <remarks>
- Do not yet expose this to build authors.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.SupportsTemplate">
- <summary>
- 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 <see langword="true" />.
- </summary>
- <remarks>
- TODO: remove this once Mono bug #74814 is fixed.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.TemplateFile">
- <summary>
- Specifies an assembly from which to get all options except the
- culture field.
- </summary>
- <value>
- The complete path to the assembly template.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/template:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Title">
- <summary>
- Specifies a string for the <b>Title</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>Title</b> field in the assembly.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Trademark">
- <summary>
- Specifies a string for the <b>Trademark</b> field in the assembly.
- </summary>
- <value>
- A string for the <b>Trademark</b> field in the assembly.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Version">
- <summary>
- Specifies version information for the assembly. The format of the
- version string is <c>major</c>.<c>minor</c>.<c>build</c>.<c>revision</c>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Win32Icon">
- <summary>
- Icon to associate with the assembly.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.Win32Res">
- <summary>
- Inserts a Win32 resource (.res file) in the output file.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.AssemblyLinkerTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program or
- <see langword="null" /> if the task is not being executed.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.CompilerBase">
- <summary>
- Provides the abstract base class for compiler tasks.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Tasks.CompilerBase.CodebehindExtensions">
- <summary>
- 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.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Tasks.CompilerBase.CultureNames">
- <summary>
- Case-insensitive list of valid culture names for this platform.
- </summary>
- <remarks>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the culture name and
- the value is <see langword="null"/>.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.#cctor">
- <summary>
- Class constructor for <see cref="T:NAnt.DotNet.Tasks.CompilerBase"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.ExecuteTask">
- <summary>
- Compiles the sources and resources.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.GetManifestResourceName(NAnt.DotNet.Types.ResourceFileSet,System.String,System.String,System.String)">
- <summary>
- Determines the manifest resource name of the given resource file.
- </summary>
- <param name="resources">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> containing information that will used to assemble the manifest resource name.</param>
- <param name="resourcePhysicalFile">The resource file of which the manifest resource name should be determined.</param>
- <param name="resourceLogicalFile">The logical location of the resource file.</param>
- <param name="dependentFile">The source file on which the resource file depends.</param>
- <returns>
- The manifest resource name of the specified resource file.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.GetManifestResourceName(NAnt.DotNet.Types.ResourceFileSet,System.String)">
- <summary>
- Determines the manifest resource name of the given resource file.
- </summary>
- <param name="resources">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> containing information that will used to assemble the manifest resource name.</param>
- <param name="resourceFile">The resource file of which the manifest resource name should be determined.</param>
- <returns>
- The manifest resource name of the specified resource file.
- </returns>
- <remarks>
- For .resx resources, the name of the dependent is determined by
- replacing the extension of the file with the extension of the
- source files for the compiler, and removing the culture name from
- the file name for localized resources.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.PerformSearchForResourceLinkage(System.IO.TextReader)">
- <summary>
- Extracts the associated namespace/classname linkage found in the
- given stream.
- </summary>
- <param name="sr">The read-only stream of the source file to search.</param>
- <returns>
- The namespace/classname of the source file matching the resource.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.WritePackageReferences(System.IO.TextWriter)">
- <summary>
- Writes package references to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the package references should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteWarningsAsError(System.IO.TextWriter)">
- <summary>
- Writes list of warnings to (not) treat as errors to the specified
- <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the list of warnings should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteNoWarnList(System.IO.TextWriter)">
- <summary>
- Writes list of warnings to suppress to the specified
- <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the list of warnings to suppress should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteConditionalCompilationConstants(System.IO.TextWriter)">
- <summary>
- Writes conditional compilation constants to the specified
- <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the conditional compilation constants should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteModuleReferences(System.IO.TextWriter)">
- <summary>
- Writes module references to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the module references should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteOptions(System.IO.TextWriter)">
- <summary>
- Allows derived classes to provide compiler-specific options.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteOption(System.IO.TextWriter,System.String)">
- <summary>
- Writes an option using the default output format.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
- <param name="name">The name of the option which should be passed to the compiler.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.WriteOption(System.IO.TextWriter,System.String,System.String)">
- <summary>
- Writes an option and its value using the default output format.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
- <param name="name">The name of the option which should be passed to the compiler.</param>
- <param name="value">The value of the option which should be passed to the compiler.</param>
- <remarks>
- The combination of <paramref name="option"/> and
- <paramref name="value"/> (separated by a colon) is quoted
- unless <paramref name="value"/> is already surrounded by quotes.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.NeedsCompiling">
- <summary>
- Determines whether compilation is needed.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.GetResourceLinkage(System.String,System.Globalization.CultureInfo)">
- <summary>
- Finds the correct namespace/classname for a resource file from the
- given dependent source file.
- </summary>
- <param name="dependentFile">The file from which the resource linkage of the resource file should be determined.</param>
- <param name="resourceCulture">The culture of the resource file for which the resource linkage should be determined.</param>
- <returns>
- The namespace/classname of the source file matching the resource or
- <see langword="null" /> if the dependent source file does not exist.
- </returns>
- <remarks>
- This behaviour may be overidden by each particular compiler to
- support the namespace/classname syntax for that language.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.LinkResourceAssembly(System.Collections.Hashtable,System.IO.FileInfo,System.String)">
- <summary>
- Link a list of files into a resource assembly.
- </summary>
- <param name="resourceFiles">The collection of resources.</param>
- <param name="resourceAssemblyFile">Resource assembly to generate</param>
- <param name="culture">Culture of the generated assembly.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.CompileResxResources(System.Collections.Specialized.StringCollection)">
- <summary>
- Compiles a set of resx files to a .resources files.
- </summary>
- <param name="resxFiles">The set of resx files to compile.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.GetResourceCulture(System.String,System.String)">
- <summary>
- Determines the culture associated with a given resource file by
- scanning the filename for valid culture names.
- </summary>
- <param name="resourceFile">The resource file path to check for culture info.</param>
- <param name="dependentFile">The file on which the resource file depends.</param>
- <returns>
- A valid <see cref="T:System.Globalization.CultureInfo"/> instance if the resource is
- associated with a specific culture; otherwise, <see langword="null"/>.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.Debug">
- <summary>
- Generate debug output. The default is <see langword="false" />.
- </summary>
- <remarks>
- Only used for <jsc> tasks, but retained for backward
- compatibility (Clover.NET).
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.OutputFile">
- <summary>
- The output file created by the compiler.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.OutputTarget">
- <summary>
- Output type. Possible values are <c>exe</c>, <c>winexe</c>,
- <c>library</c> or <c>module</c>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.Define">
- <summary>
- Define conditional compilation symbol(s).
- </summary>
- <remarks>
- <para>
- Corresponds to <c>/d[efine]:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.Win32Icon">
- <summary>
- Icon to associate with the application.
- </summary>
- <remarks>
- <para>
- Corresponds to <c>/win32icon:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.WarnAsError">
- <summary>
- Instructs the compiler to treat all warnings as errors. The default
- is <see langword="false" />.
- </summary>
- <remarks>
- <para>
- Corresponds to the <c>/warnaserror[+|-]</c> flag of the compiler.
- </para>
- <para>
- When this property is set to <see langword="true" />, any messages
- that would ordinarily be reported as warnings will instead be
- reported as errors.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.WarningAsError">
- <summary>
- Controls which warnings should be reported as errors.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.NoWarn">
- <summary>
- Specifies a comma-separated list of warnings that should be suppressed
- by the compiler.
- </summary>
- <value>
- Comma-separated list of warnings that should be suppressed by the
- compiler.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/nowarn</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.SuppressWarnings">
- <summary>
- Specifies a list of warnings that you want the compiler to suppress.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ForceRebuild">
- <summary>
- Instructs NAnt to recompile the output file regardless of the file timestamps.
- </summary>
- <remarks>
- When this parameter is to <see langword="true" />, NAnt will always
- run the compiler to rebuild the output file, regardless of the file timestamps.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.MainType">
- <summary>
- Specifies which type contains the Main method that you want to use
- as the entry point into the program.
- </summary>
- <remarks>
- <para>
- Corresponds to the <c>/m[ain]:</c> flag of the compiler.
- </para>
- <para>
- 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.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.KeyContainer">
- <summary>
- Specifies the key pair container used to strongname the assembly.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.KeyFile">
- <summary>
- Specifies a strong name key file.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.DelaySign">
- <summary>
- Specifies whether to delay sign the assembly using only the public
- portion of the strong name key. The default is
- <see cref="F:NAnt.DotNet.Types.DelaySign.NotSet"/>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.Lib">
- <summary>
- Additional directories to search in for assembly references.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/lib[path]:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.References">
- <summary>
- Reference metadata from the specified assembly files.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.Packages">
- <summary>
- Specifies list of packages to reference.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourcesList">
- <summary>
- Resources to embed.
- </summary>
- <remarks>
- <para>
- This can be a combination of resx files and file resources.
- </para>
- <para>
- .resx files will be compiled by <see cref="T:NAnt.DotNet.Tasks.ResGenTask"/> and then
- embedded into the resulting executable.
- </para>
- <para>
- The <see cref="P:NAnt.DotNet.Types.ResourceFileSet.Prefix"/> property is used to make
- up the resource name added to the assembly manifest for non-resx
- files.
- </para>
- <para>
- For .resx files the namespace from the matching source file is used
- as prefix. This matches the behaviour of Visual Studio.
- </para>
- <para>
- Multiple resources tags with different namespace prefixes may be
- specified.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.Modules">
- <summary>
- Link the specified modules into this assembly.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.Sources">
- <summary>
- The set of source files for compilation.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsPackageReferences">
- <summary>
- Indicates whether package references are supported by compiler for
- a given target framework. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsWarnAsErrorList">
- <summary>
- Indicates whether the compiler for a given target framework supports
- the "warnaserror" option that takes a list of warnings. The default
- is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsNoWarnList">
- <summary>
- 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 <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsKeyContainer">
- <summary>
- Indicates whether the compiler for a given target framework supports
- the "keycontainer" option. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsKeyFile">
- <summary>
- Indicates whether the compiler for a given target framework supports
- the "keyfile" option. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.SupportsDelaySign">
- <summary>
- Indicates whether the compiler for a given target framework supports
- the "delaysign" option. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.Extension">
- <summary>
- Gets the file extension required by the current compiler.
- </summary>
- <value>
- The file extension required by the current compiler.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ClassNameRegex">
- <summary>
- Gets the class name regular expression for the language of the current compiler.
- </summary>
- <value> class name regular expression for the language of the current compiler</value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.NamespaceRegex">
- <summary>
- Gets the namespace regular expression for the language of the current compiler.
- </summary>
- <value> namespace regular expression for the language of the current compiler</value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage">
- <summary>
- Holds class and namespace information for resource (*.resx) linkage.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/>
- class.
- </summary>
- <param name="namespaceName">The namespace the resource is under.</param>
- <param name="className">The class name the resource is associated with.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.ToString">
- <summary>
- Returns the resource linkage as a string.
- </summary>
- <returns>
- A string representation of the resource linkage.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.IsValid">
- <summary>
- Gets a value indicating whether the <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/>
- instances contains valid data.
- </summary>
- <value>
- <see langword="true"/> if the <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/>
- instance contains valid data; otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.HasNamespaceName">
- <summary>
- Gets a value indicating whether a namespace name is available
- for this <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/> instance.
- </summary>
- <value>
- <see langword="true"/> if a namespace name is available for
- this <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/> instance; otherwise,
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.HasClassName">
- <summary>
- Gets a value indicating whether a class name is available
- for this <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/> instance.
- </summary>
- <value>
- <see langword="true"/> if a class name is available for
- this <see cref="T:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage"/> instance; otherwise,
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.NamespaceName">
- <summary>
- Gets the name of namespace the resource is under.
- </summary>
- <value>
- The name of namespace the resource is under.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.ClassName">
- <summary>
- Gets the name of the class (most likely a form) that the resource
- is associated with.
- </summary>
- <value>
- The name of the class the resource is associated with.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CompilerBase.ResourceLinkage.Culture">
- <summary>
- Gets the culture that the resource is associated with.
- </summary>
- <value>
- The culture that the resource is associated with.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.CscTask">
- <summary>
- Compiles C# programs.
- </summary>
- <remarks>
- <note>
- In order to have <see cref="T:NAnt.DotNet.Tasks.CscTask"/> generate manifest resource names
- that match those generated by Microsoft Visual Studio.NET, the value of
- the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.Prefix"/> attribute of the <<see cref="P:NAnt.DotNet.Tasks.CompilerBase.ResourcesList"/>>
- element should match the "Default Namespace" of the C# project, and the
- value of the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.DynamicPrefix"/> attribute
- should be set to "<see langword="true"/>".
- </note>
- </remarks>
- <example>
- <para>Compile a "HelloWorld" application, including embedded resources.</para>
- <code>
- <![CDATA[
- <csc target="exe" output="HelloWorld.exe" debug="true">
- <nowarn>
- <!-- do not report warnings for missing XML comments -->
- <warning number="0519" />
- </nowarn>
- <sources>
- <include name="**/*.cs" />
- </sources>
- <resources dynamicprefix="true" prefix="HelloWorld">
- <include name="**/*.resx" />
- </resources>
- <references>
- <include name="System.dll" />
- <include name="System.Data.dll" />
- </references>
- </csc>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CscTask.WriteOptions(System.IO.TextWriter)">
- <summary>
- Writes the compiler options to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.CscTask.NeedsCompiling">
- <summary>
- Determines whether compilation is needed.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.BaseAddress">
- <summary>
- 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.
- </summary>
- <value>
- The preferred base address at which to load a DLL.
- </value>
- <remarks>
- This address can be specified as a decimal, hexadecimal, or octal
- number.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.DebugOutput">
- <summary>
- Specifies the type of debugging information generated by the
- compiler. The default is <see cref="F:NAnt.DotNet.Types.DebugOutput.None"/>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.Debug">
- <summary>
- No longer expose this to build authors. Use <see cref="P:NAnt.DotNet.Tasks.CscTask.DebugOutput"/>
- instead.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.DocFile">
- <summary>
- The name of the XML documentation file to generate.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/doc:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.FileAlign">
- <summary>
- Specifies the size of sections in the output file. Valid values are
- 512, 1024, 2048, 4096, and 8192.
- </summary>
- <value>
- The size of sections in the output file.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.NoStdLib">
- <summary>
- Instructs the compiler not to import mscorlib.dll. The default is
- <see langword="false" />.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/nostdlib[+|-]</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.NoConfig">
- <summary>
- Instructs the compiler not to use implicit references to assemblies.
- The default is <see langword="false" />.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/noconfig</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.Checked">
- <summary>
- Specifies whether an integer arithmetic statement that is not in
- the scope of the <c>checked</c> or <c>unchecked</c> keywords and
- that results in a value outside the range of the data type should
- cause a run-time exception. The default is <see langword="false" />.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/checked[+|-]</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.Unsafe">
- <summary>
- Instructs the compiler to allow code that uses the <c>unsafe</c>
- keyword. The default is <see langword="false" />.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/unsafe[+|-]</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.LangVersion">
- <summary>
- Causes the compiler to only accept syntax that is included in a
- given specification.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/langversion</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.Optimize">
- <summary>
- Specifies whether the compiler should perform optimizations to the
- make output files smaller, faster, and more effecient. The default
- is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the compiler should perform optimizations;
- otherwise, <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/optimize[+|-]</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.Platform">
- <summary>
- Specifies which platform version of common language runtime (CLR)
- can run the output file.
- </summary>
- <value>
- The platform version of common language runtime (CLR) that can run
- the output file.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/platform</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.WarningLevel">
- <summary>
- Specifies the warning level for the compiler to display. Valid values
- are <c>0</c>-<c>4</c>. The default is <c>4</c>.
- </summary>
- <value>
- The warning level for the compiler to display.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/warn</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.Codepage">
- <summary>
- Specifies the code page to use for all source code files in the
- compilation.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/codepage</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.SupportsDocGeneration">
- <summary>
- Specifies whether the compiler for the active target framework
- supports generation of XML Documentation file. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.SupportsPlatform">
- <summary>
- Specifies whether the compiler for the active target framework
- supports limiting the platform on which the compiled code can run.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.SupportsLangVersion">
- <summary>
- Specifies whether the compiler for the active target framework
- supports accepting only a specific language syntax.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.Extension">
- <summary>
- Gets the file extension required by the current compiler.
- </summary>
- <value>
- For the C# compiler, the file extension is always <c>cs</c>.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.ClassNameRegex">
- <summary>
- Gets the class name regular expression for the language of the
- current compiler.
- </summary>
- <value>
- Class name regular expression for the language of the current
- compiler.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.CscTask.NamespaceRegex">
- <summary>
- Gets the namespace regular expression for the language of the current compiler.
- </summary>
- <value>
- Namespace regular expression for the language of the current
- compiler.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.DelaySignTask">
- <summary>
- Signs delay-signed .NET Assemblies, or re-signs existing assemblies.
- </summary>
- <remarks>
- <para>
- The delay-signing mechanism takes a fileset (named targets)
- and either a <see cref="P:NAnt.DotNet.Tasks.DelaySignTask.KeyFile"/> attribute for a file containing the
- public and private keys, or <see cref="P:NAnt.DotNet.Tasks.DelaySignTask.KeyContainer"/> to name a key
- container.
- </para>
- </remarks>
- <example>
- <para>Sign partially-signed <c>foo.dll</c> with <c>bar.snk</c>.</para>
- <code>
- <![CDATA[
- <delay-sign keyfile="bar.snk" verbose="false">
- <targets>
- <include name="foo.dll" />
- </targets>
- </delay-sign>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.DelaySignTask.ExecuteTask">
- <summary>
- Converts a single file or group of files.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.DelaySignTask.Targets">
- <summary>
- List of assemblies/executables to sign.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.DelaySignTask.KeyFile">
- <summary>
- Specifies the filesystem path to the signing key.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.DelaySignTask.KeyContainer">
- <summary>
- Specifies the key container.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.DelaySignTask.ProgramArguments">
- <summary>
- Gets the command line arguments for the external program.
- </summary>
- <value>
- The command line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.IlasmTask">
- <summary>
- Compiles ILASM programs.
- </summary>
- <example>
- <para>
- Compiles <c>helloworld.il</c> to <c>helloworld.exe</c>.
- </para>
- <code>
- <![CDATA[
- <ilasm target="exe" output="helloworld.exe" debug="true">
- <sources>
- <include name="helloworld.il" />
- </sources>
- </ilasm>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.IlasmTask.ExecuteTask">
- <summary>
- Compiles the sources.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.IlasmTask.WriteOptions">
- <summary>
- Writes the compiler options.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.IlasmTask.WriteOption(System.IO.StringWriter,System.String)">
- <summary>
- Writes an option using the default output format.
- </summary>
- <param name="writer">
- The <see cref="T:System.IO.StringWriter"/> to which the compiler options should
- be written.
- </param>
- <param name="name">
- A <see cref="T:System.String"/> that contains the name of the
- option which should be passed to the compiler.
- </param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.IlasmTask.WriteOption(System.IO.StringWriter,System.String,System.String)">
- <summary>
- Writes an option and its value using the default output format.
- </summary>
- <param name="writer">
- The <see cref="T:System.IO.StringWriter"/> to which the compiler options should
- be written.
- </param>
- <param name="name">
- A <see cref="T:System.String"/> that contains the name of the
- option which should be passed to the compiler.
- </param>
- <param name="arg">
- A <see cref="T:System.String"/> that contains the value of the
- option which should be passed to the compiler.
- </param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.IlasmTask.NeedsCompiling">
- <summary>
- Determines whether or not compilation is needed.
- </summary>
- <returns>
- <see langword="true" /> if compilation is needed; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Clock">
- <summary>
- Specifies whether or not the compiler should measure and report
- the compilation times.
- </summary>
- <value>
- <see langword="true" /> if the compilation times should be
- measured and reported; otherwise, <see langword="false" />. The
- default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/CLOCK</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Debug">
- <summary>
- Specifies whether or not the compiler should generate debug
- information.
- </summary>
- <value>
- <see langword="true" /> if debug information should be generated;
- otherwise, <see langword="false" />. The default is
- <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/DEBUG</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Error">
- <summary>
- Specifies whether or not the compiler should attempt to create a
- PE file even if compilation errors have been reported.
- </summary>
- <value>
- <see langword="true" /> if a PE file has to be created even if
- compilation errors have been reported; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/ERROR</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.ForceRebuild">
- <summary>
- Instructs NAnt to recompile the output file regardless of the file
- timestamps.
- </summary>
- <value>
- <see langword="true" /> if the output file should be recompiled
- regardless of its timestamps; otherwise <see langword="false" />.
- The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Listing">
- <summary>
- Specifies whether or not the compiler should type a formatted
- listing of the compilation result.
- </summary>
- <value>
- <see langword="true" /> if a formatted listing of the compilation
- result should be typed; otherwise, <see langword="false" />. The
- default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/LISTING</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Alignment">
- <summary>
- Instructs the compiler to set the <i>FileAlignment</i> value in
- the PE header.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the <i>FileAlignment</i>
- value to set in the PE header. The value must be a power of 2, in
- range from 512 to 65536.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/ALIGNMENT</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Base">
- <summary>
- Instructs the compiler to set the <i>ImageBase</i> value in
- the PE header.
- </summary>
- <value>
- A <see cref="T:System.Int32"/> that represents the <i>ImageBase</i>
- value to set in the PE header.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/BASE</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Flags">
- <summary>
- Instructs the compiler to set the <i>Flags</i> value in the CLR
- header.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the <i>Flags</i>
- 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.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/FLAGS</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Subsystem">
- <summary>
- Instructs the compiler to set the <i>Subsystem</i> value in the PE
- header.
- </summary>
- <value>
- An <see cref="T:System.Int32"/> that represents the <i>Subsystem</i>
- value to set in the PE header. The most frequently value are 3
- (console application) and 2 (GUI application).
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/SUBSYSTEM</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Target">
- <summary>
- Specifies which output type should be generated.
- </summary>
- <value>
- A <see cref="T:System.String"/> that contains the target type.
- Possible values are <c>dll</c> and <c>exe</c>.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/OUTPUT</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.KeySource">
- <summary>
- Instructs the compiler to generate a strong signature of the PE
- file.
- </summary>
- <value>
- A <see cref="T:System.String"/> that contains the private
- encryption key.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/KEY=<![CDATA[@<]]>keysource<![CDATA[>]]></c>
- flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.KeyFile">
- <summary>
- Instructs the compiler to generate a strong signature of the PE
- file.
- </summary>
- <value>
- A <see cref="T:System.IO.FileInfo"/> that represents the file
- containing the private encryption key.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/KEY=<![CDATA[<]]>keyfile<![CDATA[>]]></c>
- flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.OutputFile">
- <summary>
- Specifies the name of the output file created by the compiler.
- </summary>
- <value>
- A <see cref="T:System.IO.FileInfo"/> that represents the name of
- the output file.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/OUTPUT</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.ResourceFile">
- <summary>
- Instructs the compiler to link the specified unmanaged resource
- file into the resulting PE file.
- </summary>
- <value>
- A <see cref="T:System.IO.FileInfo"/> that represents the unmanaged
- resource file to link.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/RESOURCE</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.Sources">
- <summary>
- Specifies the set of source files to compile.
- </summary>
- <value>
- A <see cref="T:NAnt.Core.Types.FileSet"/> that represents the set
- of source files to compile.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.IlasmTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- A <see cref="T:System.String"/> that contains the command-line
- arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.JscTask">
- <summary>
- Compiles JScript.NET programs.
- </summary>
- <example>
- <para>Compile <c>helloworld.js</c> to <c>helloworld.exe</c>.</para>
- <code>
- <![CDATA[
- <jsc target="exe" output="helloworld.exe" debug="true">
- <sources>
- <include name="helloworld.js" />
- </sources>
- </jsc>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.JscTask.WriteModuleReferences(System.IO.TextWriter)">
- <summary>
- Writes module references to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the module references should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.JscTask.WriteOptions(System.IO.TextWriter)">
- <summary>
- Writes the compiler options to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.AutoRef">
- <summary>
- 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 <see langword="false" />.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/autoref</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.NoStdLib">
- <summary>
- Instructs the compiler not to import standard library, and changes
- <see cref="P:NAnt.DotNet.Tasks.JscTask.AutoRef"/> to <see langword="false"/>. The default is
- <see langword="false"/>.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/noconfig</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.Platform">
- <summary>
- Specifies which platform version of common language runtime (CLR)
- can run the output file.
- </summary>
- <value>
- The platform version of common language runtime (CLR) that can run
- the output file.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/platform</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.VersionSafe">
- <summary>
- Causes the compiler to generate errors for implicit method
- overrides. The default is <see langword="false" />.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/versionsafe</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.WarningLevel">
- <summary>
- Specifies the warning level for the compiler to display. Valid
- values are <c>0</c>-<c>4</c>. The default is <c>4</c>.
- </summary>
- <value>
- The warning level for the compiler to display.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/warn</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.WarningAsError">
- <summary>
- Controls which warnings should be reported as errors.
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.NoWarn">
- <summary>
- Specifies a comma-separated list of warnings that should be suppressed
- by the compiler.
- </summary>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- compiler does not support package references.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.SuppressWarnings">
- <summary>
- Specifies a list of warnings that you want the compiler to suppress.
- </summary>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- compiler does not support suppressing warnings.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.Codepage">
- <summary>
- Specifies the code page to use for all source code files in the
- compilation.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/codepage</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.KeyContainer">
- <summary>
- Specifies the key pair container used to strongname the assembly.
- </summary>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- does not support this.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.KeyFile">
- <summary>
- Specifies a strong name key file.
- </summary>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- does not support this.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.DelaySign">
- <summary>
- Specifies whether to delay sign the assembly using only the public
- portion of the strong name key.
- </summary>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- does not support this.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.SupportsKeyContainer">
- <summary>
- Indicates whether the compiler for a given target framework supports
- the "keycontainer" option. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="false" />.
- </value>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- does not support this.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.SupportsKeyFile">
- <summary>
- Indicates whether the compiler for a given target framework supports
- the "keyfile" option. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="false" />.
- </value>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- does not support this.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.SupportsDelaySign">
- <summary>
- Indicates whether the compiler for a given target framework supports
- the "delaysign" option. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="false" />.
- </value>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- does not support this.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.SupportsPlatform">
- <summary>
- Specifies whether the compiler for the active target framework
- supports limiting the platform on which the compiled code can run.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.Modules">
- <summary>
- Link the specified modules into this assembly.
- </summary>
- <remarks>
- Override to avoid exposing this to build authors, as the JScript.NET
- compiler does not support linking modules.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.Extension">
- <summary>
- Gets the file extension required by the current compiler.
- </summary>
- <value>
- For the JScript.NET compiler, the file extension is always <c>js</c>.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.ClassNameRegex">
- <summary>
- Gets the class name regular expression for the language of the
- current compiler.
- </summary>
- <value>
- Class name regular expression for the language of the current
- compiler.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.JscTask.NamespaceRegex">
- <summary>
- Gets the namespace regular expression for the language of the
- current compiler.
- </summary>
- <value>
- Namespace regular expression for the language of the current
- compiler.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.LicenseTask">
- <summary>
- Generates a <c>.licence</c> file from a <c>.licx</c> file.
- </summary>
- <remarks>
- <para>
- If no output file is specified, the default filename is the name of the
- target file with the extension <c>.licenses</c> appended.
- </para>
- </remarks>
- <example>
- <para>
- Generate the file <c>component.exe.licenses</c> file from <c>component.licx</c>.
- </para>
- <code>
- <![CDATA[
- <license input="component.licx" licensetarget="component.exe" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.LicenseTask.Initialize">
- <summary>
- Initializes the <see cref="T:NAnt.DotNet.Tasks.LicenseTask"/> class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.LicenseTask.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
- <see cref="T:System.Diagnostics.Process"/>.
- </summary>
- <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.LicenseTask.ExecuteTask">
- <summary>
- Generates the license file.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.LicenseTask.NeedsCompiling(System.IO.FileInfo)">
- <summary>
- Determines whether the <c>.licenses</c> file needs to be recompiled
- or is uptodate.
- </summary>
- <param name="licensesFile">The <c>.licenses</c> file.</param>
- <returns>
- <see langword="true" /> if the <c>.licenses</c> file needs compiling;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.InputFile">
- <summary>
- Input file to process.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.OutputFile">
- <summary>
- Name of the license file to output.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.Assemblies">
- <summary>
- Names of the references to scan for the licensed component.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.LicenseTarget">
- <summary>
- Specifies the executable for which the .licenses file is generated.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.Target">
- <summary>
- Specifies the executable for which the .licenses file is generated.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.SupportsAssemblyReferences">
- <summary>
- Indicates whether assembly references are supported by the current
- target framework. The default is <see langword="false" />.
- </summary>
- <remarks>
- Applies only to frameworks having a command line tool for compiling
- licenses files.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.HasCommandLineCompiler">
- <summary>
- Indicates whether the current target framework has a command line
- tool for compiling licenses files. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.BaseDirectory">
- <summary>
- Gets the working directory for the application.
- </summary>
- <value>
- The working directory for the application.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.Arguments">
- <summary>
- The command-line arguments for the external program.
- </summary>
- <remarks>
- Override to avoid exposing these elements in build file.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.LicenseTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- <remarks>
- Override in derived classes to explicitly set the location of the
- external tool.
- </remarks>
- </member>
- <member name="T:NAnt.DotNet.Tasks.LicenseTask.LicenseGatherer">
- <summary>
- Responsible for reading the license and writing them to a license
- file.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.LicenseTask.LicenseGatherer.InitializeLifetimeService">
- <summary>
- Obtains a lifetime service object to control the lifetime policy for
- this instance.
- </summary>
- <returns>
- An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
- policy for this instance. This is the current lifetime service object
- for this instance if one exists; otherwise, a new lifetime service
- object initialized with a lease that will never time out.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Tasks.LicenseTask.LicenseGatherer.CreateLicenseFile(NAnt.DotNet.Tasks.LicenseTask,System.String)">
- <summary>
- Creates the whole license file.
- </summary>
- <param name="licenseTask">The <see cref="T:NAnt.DotNet.Tasks.LicenseTask"/> instance for which the license file should be created.</param>
- <param name="licensesFile">The .licenses file to create.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.LicenseTask.LicenseGatherer.IsSerializable(System.Object)">
- <summary>
- Determines whether the given object is serializable in binary
- format.
- </summary>
- <param name="value">The object to check.</param>
- <returns>
- <see langword="true" /> if <paramref name="value" /> is
- serializable in binary format; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Tasks.NDocTask">
- <summary>
- Runs NDoc V1.3.1 to create documentation.
- </summary>
- <remarks>
- <para>
- See the <see href="http://ndoc.sourceforge.net/">NDoc home page</see> for more
- information.
- </para>
- <note>
- By default, only the NDoc MSDN documenter ships as part of the NAnt
- distribution. To make another NDoc documenter from the NDoc V1.3.1
- distribution available to the <see cref="T:NAnt.DotNet.Tasks.NDocTask"/>, copy the
- documenter assembly (and possible dependencies) to the "lib"
- directory corresponding with the CLR you're running NAnt on
- (eg. <nant root>/bin/lib/net/1.1).
- </note>
- </remarks>
- <example>
- <para>
- Document two assemblies using the MSDN documenter. The namespaces are
- documented in <c>NamespaceSummary.xml</c>.
- </para>
- <code>
- <![CDATA[
- <ndoc>
- <assemblies basedir="${build.dir}">
- <include name="NAnt.exe" />
- <include name="NAnt.Core.dll" />
- </assemblies>
- <summaries basedir="${build.dir}">
- <include name="NamespaceSummary.xml" />
- </summaries>
- <documenters>
- <documenter name="MSDN">
- <property name="OutputDirectory" value="doc\MSDN" />
- <property name="HtmlHelpName" value="NAnt" />
- <property name="HtmlHelpCompilerFilename" value="hhc.exe" />
- <property name="IncludeFavorites" value="False" />
- <property name="Title" value="An NDoc Documented Class Library" />
- <property name="SplitTOCs" value="False" />
- <property name="DefaulTOC" value="" />
- <property name="ShowVisualBasic" value="True" />
- <property name="ShowMissingSummaries" value="True" />
- <property name="ShowMissingRemarks" value="True" />
- <property name="ShowMissingParams" value="True" />
- <property name="ShowMissingReturns" value="True" />
- <property name="ShowMissingValues" value="True" />
- <property name="DocumentInternals" value="False" />
- <property name="DocumentProtected" value="True" />
- <property name="DocumentPrivates" value="False" />
- <property name="DocumentEmptyNamespaces" value="False" />
- <property name="IncludeAssemblyVersion" value="False" />
- <property name="CopyrightText" value="" />
- <property name="CopyrightHref" value="" />
- </documenter>
- </documenters>
- </ndoc>
- ]]>
- </code>
- <para>Content of <c>NamespaceSummary.xml</c> :</para>
- <code>
- <![CDATA[
- <namespaces>
- <namespace name="Foo.Bar">
- The <b>Foo.Bar</b> namespace reinvents the wheel.
- </namespace>
- <namespace name="Foo.Bar.Tests">
- The <b>Foo.Bar.Tests</b> namespace ensures that the Foo.Bar namespace reinvents the wheel correctly.
- </namespace>
- </namespaces>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.NDocTask.Initialize">
- <summary>
- Initializes the taks and verifies the parameters.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.NDocTask.ExecuteTask">
- <summary>
- Generates an NDoc project and builds the documentation.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.NDocTask.OnDocBuildingStep(System.Object,NDoc.Core.ProgressArgs)">
- <summary>
- Represents the method that will be called to update the overall
- percent complete value and the current step name.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NDoc.Core.ProgressArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.NDocTask.OnDocBuildingProgress(System.Object,NDoc.Core.ProgressArgs)">
- <summary>
- Represents the method that will be called to update the current
- step's precent complete value.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="e">A <see cref="T:NDoc.Core.ProgressArgs"/> that contains the event data.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.NDocTask.CheckAndGetDocumenter(NDoc.Core.Project,System.String)">
- <summary>
- Returns the documenter for the given project.
- </summary>
- <exception cref="T:NAnt.Core.BuildException">
- Documenter <paramref name="documenterName"/> is not found.
- </exception>
- <exception cref="T:System.ArgumentNullException">
- <paramref name="project"/> is <see langword="null"/>.
- </exception>
- </member>
- <member name="M:NAnt.DotNet.Tasks.NDocTask.ExpandPropertiesInNodes(System.Xml.XmlNodeList)">
- <summary>
- Performs macro expansion for the given nodes.
- </summary>
- <param name="nodes"><see cref="T:System.Xml.XmlNodeList"/> for which expansion should be performed.</param>
- </member>
- <member name="P:NAnt.DotNet.Tasks.NDocTask.Assemblies">
- <summary>
- The set of assemblies to document.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.NDocTask.Summaries">
- <summary>
- The set of namespace summary files.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.NDocTask.Documenters">
- <summary>
- Specifies the formats in which the documentation should be generated.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.NDocTask.ReferencePaths">
- <summary>
- Collection of additional directories to search for referenced
- assemblies.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Tasks.RegsvcsTask">
- <summary>
- Installs or removes .NET Services.
- </summary>
- <remarks>
- <para>
- This tasks provides the same functionality as the <c>regsvcs</c> tool
- provided in the .NET SDK.
- </para>
- <para>
- It performs the following actions:
- </para>
- <list type="bullet">
- <item>
- <description>Loads and registers an assembly.</description>
- </item>
- <item>
- <description>Generates, registers, and installs a type library into a specified COM+ application.</description>
- </item>
- <item>
- <description>Configures services that are added programmatically to your class.</description>
- </item>
- </list>
- <para>
- Refer to the <see href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrfnetservicesinstallationutilityregsvcsexe.htm">.NET Services Installation Tool (Regsvcs.exe)</see> for more information.
- </para>
- </remarks>
- <example>
- <para>
- Adds all public classes contained in <c>myTest.dll</c> to a COM+
- application and produces the <c>myTest.tlb</c> type library. If the
- application already exists, it is overwritten.
- </para>
- <code>
- <![CDATA[
- <regsvcs action="FindOrCreate" assembly="myTest.dll" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Adds all public classes contained in <c>myTest.dll</c> to <c>myTargetApp</c>
- and produces the <c>myTest.tlb</c> type library. If the application already
- exists, it is overwritten.
- </para>
- <code>
- <![CDATA[
- <regsvcs action="FindOrCreate" assembly="myTest.dll" application="myTargetApp" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Adds all public classes contained in <c>myTest.dll</c> to a COM+
- application and produces the <c>myTest.tlb</c> type library. A new
- application is always created.
- </para>
- <code>
- <![CDATA[
- <regsvcs action="Create" assembly="myTest.dll" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Uninstalls the COM+ application contained in <c>myTest.dll</c>.
- </para>
- <code>
- <![CDATA[
- <regsvcs action="Uninstall" assembly="myTest.dll" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.RegsvcsTask.ExecuteTask">
- <summary>
- Performs the specified action.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.Action">
- <summary>
- Defines the action to take with the assembly. The default is
- <see cref="F:NAnt.DotNet.Tasks.RegsvcsTask.ActionType.FindOrCreate"/>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.AssemblyFile">
- <summary>
- The source assembly file.
- </summary>
- <remarks>
- The assembly must be signed with a strong name.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.TypeLibrary">
- <summary>
- Specifies the type library file to install.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ExistingTypeLibrary">
- <summary>
- Uses an existing type library. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.NoReconfig">
- <summary>
- Do not reconfigure an existing target application.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ComponentsOnly">
- <summary>
- Configures components only; ignores methods and interfaces.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ExistingApplication">
- <summary>
- Expect an existing application. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ApplicationName">
- <summary>
- Specifies the name of the COM+ application to either find or create.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.PartitionName">
- <summary>
- Specifies the name or id of the COM+ application to either find or
- create.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.RegsvcsTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.RegsvcsTask.ActionType">
- <summary>
- Defines the possible actions for a .NET Service.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Tasks.RegsvcsTask.ActionType.FindOrCreate">
- <summary>
- Finds or creates the target application.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Tasks.RegsvcsTask.ActionType.Create">
- <summary>
- Creates the target application.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Tasks.RegsvcsTask.ActionType.Uninstall">
- <summary>
- Uninstalls the target application.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Tasks.ResGenTask">
- <summary>
- Converts files from one resource format to another.
- </summary>
- <remarks>
- <note>
- If no <see cref="P:NAnt.DotNet.Tasks.ResGenTask.ToDirectory"/> is specified, the resource file will
- be created next to the input file.
- </note>
- </remarks>
- <example>
- <para>
- Convert a resource file from the <c>.resx</c> to the <c>.resources</c>
- format.
- </para>
- <code>
- <![CDATA[
- <resgen input="translations.resx" output="translations.resources" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Convert a set of <c>.resx</c> files to the <c>.resources</c> format.
- </para>
- <code>
- <![CDATA[
- <resgen todir=".">
- <resources>
- <include name="*.resx" />
- </resources>
- </resgen>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ResGenTask.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
- <see cref="T:System.Diagnostics.Process"/>.
- </summary>
- <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ResGenTask.ExecuteTask">
- <summary>
- Converts a single file or group of files.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ResGenTask.RemoveOutputs">
- <summary>
- Cleans up generated files.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ResGenTask.NeedsCompiling(System.IO.FileInfo,System.IO.FileInfo)">
- <summary>
- Determines whether the specified input file needs to be compiled.
- </summary>
- <param name="inputFile">The input file.</param>
- <param name="outputFile">The output file.</param>
- <returns>
- <see langword="true" /> if the input file need to be compiled;
- otherwise <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ResGenTask.GetOutputFile(System.IO.FileInfo)">
- <summary>
- Determines the full path and extension for the output file.
- </summary>
- <param name="file">The output file for which the full path and extension should be determined.</param>
- <returns>
- The full path (with extensions) for the specified file.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ResGenTask.ReferencesThirdPartyAssemblies(System.String)">
- <summary>
- 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.".
- </summary>
- <param name="resourceFile">The resource file to check.</param>
- <returns>
- <see langword="true" /> if the resource file references third party
- assemblies, or an error occurred; otherwise, <see langword="false" />.
- </returns>
- <remarks>
- 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 supported
- assembly references, so this method will not be used anyway.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ResGenTask.GetExternalFileReferences(System.IO.FileInfo)">
- <summary>
- Returns a list of external file references for the specified file.
- </summary>
- <param name="resxFile">The resx file for which a list of external file references should be returned.</param>
- <returns>
- A list of external file references for the specified file, or
- <see langword="null" /> if <paramref name="resxFile" /> does not
- exist or does not support external file references.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.InputFile">
- <summary>
- Input file to process.
- </summary>
- <value>
- The full path to the input file.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.OutputFile">
- <summary>
- The resource file to output.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.TargetExt">
- <summary>
- The target type. The default is <c>resources</c>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.ToDirectory">
- <summary>
- The directory to which outputs will be stored.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.UseSourcePath">
- <summary>
- Use each source file's directory as the current directory for
- resolving relative file paths. The default is <see langword="false" />.
- Only supported when targeting .NET 2.0 (or higher).
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.Resources">
- <summary>
- Takes a list of <c>.resx</c> or <c>.txt</c> files to convert to <c>.resources</c> files.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.Assemblies">
- <summary>
- Reference metadata from the specified assembly files.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.SupportsAssemblyReferences">
- <summary>
- Indicates whether assembly references are supported by the
- <c>resgen</c> tool for the current target framework. The default
- is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.SupportsExternalFileReferences">
- <summary>
- Indicates whether external file references are supported by the
- <c>resgen</c> tool for the current target framework. The default
- is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.QualifiedResources">
- <summary>
- For internal use only !
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.BaseDirectory">
- <summary>
- Gets the working directory for the application.
- </summary>
- <value>
- The working directory for the application.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.ProgramArguments">
- <summary>
- Gets the command line arguments for the external program.
- </summary>
- <value>
- The command line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ResGenTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- <remarks>
- Override in derived classes to explicitly set the location of the
- external tool.
- </remarks>
- </member>
- <member name="T:NAnt.DotNet.Tasks.QualifiedResource">
- <summary>
- For internal use only !
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.QualifiedResource.#ctor(System.IO.FileInfo,System.IO.FileInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Tasks.QualifiedResource"/>
- class for a given input and output file.
- </summary>
- <param name="input">The resource to compile.</param>
- <param name="output">The compiled resource.</param>
- </member>
- <member name="P:NAnt.DotNet.Tasks.QualifiedResource.Input">
- <summary>
- Gets the resource file to compile.
- </summary>
- <value>
- The resource file to compile.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.QualifiedResource.Output">
- <summary>
- Gets the compiled resource file.
- </summary>
- <value>
- The compiled resource file.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.ScriptTask">
- <summary>
- Executes the code contained within the task. This code can include custom extension function definitions.
- Once the script task has executed those custom functions will be available for use in the buildfile.
- </summary>
- <remarks>
- <para>
- The <see cref="T:NAnt.DotNet.Tasks.ScriptTask"/> must contain a single <c>code</c>
- element, which in turn contains the script code.
- </para>
- <para>
- A static entry point named <c>ScriptMain</c> is required if no custom functions have been defined. It must
- have a single <see cref="T:NAnt.Core.Project"/> parameter.
- </para>
- <para>
- The following namespaces are loaded by default:
- </para>
- <list type="bullet">
- <item>
- <description>System</description>
- </item>
- <item>
- <description>System.Collections</description>
- </item>
- <item>
- <description>System.Collections.Specialized</description>
- </item>
- <item>
- <description>System.IO</description>
- </item>
- <item>
- <description>System.Text</description>
- </item>
- <item>
- <description>System.Text.RegularExpressions</description>
- </item>
- <item>
- <description>NAnt.Core</description>
- </item>
- </list>
- </remarks>
- <example>
- <para>Run C# code that writes a message to the build log.</para>
- <code>
- <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>
- </code>
- </example>
- <example>
- <para>Define a custom function and call it using C#.</para>
- <code>
- <script language="C#" prefix="test" >
- <code>
- <![CDATA[
- [Function("test-func")]
- public static string Testfunc( ) {
- return "some result !!!!!!!!";
- }
- ]]>
- </code>
- </script>
- <echo message='${test::test-func()}'/>
- </code>
- </example>
- <example>
- <para>Use a custom namespace in C# to create a database</para>
- <code>
- <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>
- </code>
- </example>
- <example>
- <para>
- Run Visual Basic.NET code that writes a message to the build log.
- </para>
- <code>
- <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>
- </code>
- </example>
- <example>
- <para>Define a custom task and call it using C#.</para>
- <code>
- <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'/>
- </code>
- </example>
- <example>
- <para>
- Define a custom function and call it using <see href="http://boo.codehaus.org/">Boo</see>.
- </para>
- <code>
- <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()}'/>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ScriptTask.Initialize">
- <summary>
- Initializes the task.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Tasks.ScriptTask.ExecuteTask">
- <summary>
- Executes the script block.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ScriptTask.Language">
- <summary>
- 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
- <see cref="T:System.CodeDom.Compiler.CodeDomProvider"/>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ScriptTask.References">
- <summary>
- Any required references.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ScriptTask.MainClass">
- <summary>
- The name of the main class containing the static <c>ScriptMain</c>
- entry point.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ScriptTask.Prefix">
- <summary>
- The namespace prefix for any custom functions defined in the script.
- If ommitted the prefix will default to 'script'
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ScriptTask.Imports">
- <summary>
- The namespaces to import.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.ScriptTask.Code">
- <summary>
- The code to execute.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Tasks.VbcTask">
- <summary>
- Compiles Visual Basic.NET programs.
- </summary>
- <remarks>
- <note>
- In order to have <see cref="T:NAnt.DotNet.Tasks.VbcTask"/> generate manifest resource names
- that match those generated by Microsoft Visual Studio.NET, the value of
- the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.Prefix"/> attribute of the <<see cref="P:NAnt.DotNet.Tasks.CompilerBase.ResourcesList"/>>
- element should match the "Root namespace" of the VB.NET project, and the
- value of the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.DynamicPrefix"/> attribute
- should be set to "<see langword="false"/>".
- </note>
- </remarks>
- <example>
- <para>Example build file using this task.</para>
- <code>
- <![CDATA[
- <project name="Hello World" default="build" basedir=".">
- <property name="basename" value="HelloWorld" />
- <target name="clean">
- <delete file="${basename}-vb.exe" failonerror="false" />
- <delete file="${basename}-vb.pdb" failonerror="false" />
- </target>
- <target name="build">
- <vbc target="exe" output="${basename}-vb.exe" rootnamespace="${basename}">
- <imports>
- <import namespace="System" />
- <import namespace="System.Data" />
- </imports>
- <sources>
- <include name="${basename}.vb" />
- </sources>
- <resources prefix="${basename}" dynamicprefix="true">
- <include name="**/*.resx" />
- </resources>
- <references>
- <include name="System.dll" />
- <include name="System.Data.dll" />
- </references>
- </vbc>
- </target>
- <target name="rebuild" depends="clean, build" />
- </project>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.VbcTask.GetResourceLinkage(System.String,System.Globalization.CultureInfo)">
- <summary>
- Finds the correct namespace/classname for a resource file from the
- given dependent source file, and ensure the <see cref="P:NAnt.DotNet.Tasks.VbcTask.RootNamespace"/>
- is prefixed.
- </summary>
- <param name="dependentFile">The file from which the resource linkage of the resource file should be determined.</param>
- <param name="resourceCulture">The culture of the resource file for which the resource linkage should be determined.</param>
- <returns>
- The namespace/classname of the source file matching the resource or
- <see langword="null"/> if the dependent source file does not exist.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Tasks.VbcTask.WriteConditionalCompilationConstants(System.IO.TextWriter)">
- <summary>
- Writes conditional compilation constants to the specified
- <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the conditional compilation constants should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.VbcTask.WriteOptions(System.IO.TextWriter)">
- <summary>
- Writes the compiler options to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.VbcTask.NeedsCompiling">
- <summary>
- Determines whether compilation is needed.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.BaseAddress">
- <summary>
- 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.
- </summary>
- <value>
- The preferred base address at which to load a DLL.
- </value>
- <remarks>
- This address must be specified as a hexadecimal number.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.DebugOutput">
- <summary>
- Specifies the type of debugging information generated by the
- compiler. The default is <see cref="F:NAnt.DotNet.Types.DebugOutput.None"/>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.Debug">
- <summary>
- No longer expose this to build authors. Use <see cref="P:NAnt.DotNet.Tasks.VbcTask.DebugOutput"/>
- instead.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.DocFile">
- <summary>
- The name of the XML documentation file to generate. Only supported
- when targeting .NET 2.0 (or higher).
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/doc:</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.ImportsString">
- <summary>
- Specifies whether the <c>/imports</c> option gets passed to the
- compiler.
- </summary>
- <value>
- The value of this attribute is a string that contains one or more
- namespaces separated by commas.
- </value>
- <remarks>
- <a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfImportImportNamespaceFromSpecifiedAssembly.htm">See the Microsoft.NET Framework SDK documentation for details.</a>
- </remarks>
- <example>Example of an imports attribute
- <code><![CDATA[imports="Microsoft.VisualBasic, System, System.Collections, System.Data, System.Diagnostics"]]></code>
- </example>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.Imports">
- <summary>
- The namespaces to import.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.NoStdLib">
- <summary>
- Instructs the compiler not to reference standard libraries
- (system.dll and VBC.RSP). The default is <see langword="false" />.
- Only supported when targeting .NET 2.0 (or higher).
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/nostdlib</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.OptionCompare">
- <summary>
- Specifies whether <c>/optioncompare</c> option gets passed to the
- compiler.
- </summary>
- <value>
- <c>text</c>, <c>binary</c>, or an empty string. If the value is
- <see langword="false" /> or an empty string, the option will not be
- passed to the compiler.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfOptioncompareSpecifyHowStringsAreCompared.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.OptionExplicit">
- <summary>
- Specifies whether the <c>/optionexplicit</c> option gets passed to
- the compiler. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the option should be passed to the compiler;
- otherwise, <see langword="false" />.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfOptionexplicitRequireExplicitDeclarationOfVariables.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.OptionOptimize">
- <summary>
- Specifies whether the <c>/optimize</c> option gets passed to the
- compiler. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the option should be passed to the compiler;
- otherwise, <see langword="false" />.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfoptimizeenabledisableoptimizations.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.OptionStrict">
- <summary>
- Specifies whether the <c>/optionstrict</c> option gets passed to
- the compiler. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the option should be passed to the compiler;
- otherwise, <see langword="false" />.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfOptionstrictEnforceStrictTypeSemantics.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.Platform">
- <summary>
- Specifies which platform version of common language runtime (CLR)
- can run the output file.
- </summary>
- <value>
- The platform version of common language runtime (CLR) that can run
- the output file.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/platform</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.RemoveIntChecks">
- <summary>
- Specifies whether the <c>/removeintchecks</c> option gets passed to
- the compiler. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the option should be passed to the compiler;
- otherwise, <see langword="false" />.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfRemoveintchecksRemoveInteger-OverflowChecks.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.RootNamespace">
- <summary>
- Specifies whether the <c>/rootnamespace</c> option gets passed to
- the compiler.
- </summary>
- <value>
- The value of this attribute is a string that contains the root
- namespace of the project.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/vblr7net/html/valrfRootnamespace.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.SupportsDocGeneration">
- <summary>
- Specifies whether the compiler for the active target framework
- supports generation of XML Documentation file. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.SupportsNoStdLib">
- <summary>
- Specifies whether the compiler for the active target framework
- supports NOT referencing standard libraries (system.dll and VBC.RSP).
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.SupportsPlatform">
- <summary>
- Specifies whether the compiler for the active target framework
- supports limiting the platform on which the compiled code can run.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.Extension">
- <summary>
- Gets the file extension required by the current compiler.
- </summary>
- <value>
- For the VB.NET compiler, the file extension is always <c>vb</c>.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.ClassNameRegex">
- <summary>
- Gets the class name regular expression for the language of the
- current compiler.
- </summary>
- <value>
- Class name regular expression for the language of the current
- compiler.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VbcTask.NamespaceRegex">
- <summary>
- Gets the namespace regular expression for the language of the
- current compiler.
- </summary>
- <value>
- Namespace regular expression for the language of the current
- compiler.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Tasks.VjcTask">
- <summary>
- Compiles Visual J# programs using vjc, Microsoft's J# compiler.
- </summary>
- <remarks>
- <note>
- In order to have <see cref="T:NAnt.DotNet.Tasks.VjcTask"/> generate manifest resource names
- that match those generated by Microsoft Visual Studio.NET, the value of
- the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.Prefix"/> attribute of the <<see cref="P:NAnt.DotNet.Tasks.CompilerBase.ResourcesList"/>>
- element should match the "Default Package" of the J#.NET project, and
- the value of the <see cref="P:NAnt.DotNet.Types.ResourceFileSet.DynamicPrefix"/> attribute
- should be set to "<see langword="true"/>".
- </note>
- </remarks>
- <example>
- <para>Compile a "HelloWorld" application, including embedded resources.</para>
- <code>
- <![CDATA[
- <vjc target="exe" output="helloworld.exe" debug="true">
- <sources>
- <include name="helloworld.jsl" />
- </sources>
- <resources prefix="HelloWorld" dynamicprefix="true">
- <include name="**/*.resx" />
- </resources>
- <references>
- <include name="System.dll" />
- <include name="System.Data.dll" />
- <include name="System.Drawing.dll" />
- <include name="System.Windows.Forms.dll" />
- <include name="System.Xml.dll" />
- </references>
- </vjc>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Tasks.VjcTask.WriteModuleReferences(System.IO.TextWriter)">
- <summary>
- Writes module references to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer">The <see cref="T:System.IO.TextWriter"/> to which the module references should be written.</param>
- </member>
- <member name="M:NAnt.DotNet.Tasks.VjcTask.WriteOptions(System.IO.TextWriter)">
- <summary>
- Writes the compiler options to the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="writer"><see cref="T:System.IO.TextWriter"/> to which the compiler options should be written.</param>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.BaseAddress">
- <summary>
- 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.
- </summary>
- <value>
- The preferred base address at which to load a DLL.
- </value>
- <remarks>
- This address can be specified as a decimal, hexadecimal, or octal
- number.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.DebugOutput">
- <summary>
- Specifies the type of debugging information generated by the
- compiler. The default is <see cref="F:NAnt.DotNet.Types.DebugOutput.None"/>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.Debug">
- <summary>
- No longer expose this to build authors. Use <see cref="P:NAnt.DotNet.Tasks.VjcTask.DebugOutput"/>
- instead.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.SecureScoping">
- <summary>
- 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 <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the option should be passed to the compiler;
- otherwise, <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/securescoping</c> flag.
- </para>
- <para>
- <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjgrfsecurescopingmakepackage-scopedmembersinaccessibleoutsideassembly.htm">See the Visual J# Reference for details.</a>
- </para>
- </remarks>
- <example>
- <code><![CDATA[<vjc securescoping='true'/>]]></code>
- </example>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.X">
- <summary>
- Specifies whether to disable language extensions.
- </summary>
- <value>
- The value of this property must be either <c>all</c>, <c>net</c>,
- or an empty string.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/x</c> flag.
- </para>
- <para>
- <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjgrfxdisablelanguageextensions.htm">See the Visual J# Reference for details.</a>
- </para>
- </remarks>
- <example>
- <para>To disable only the .NET Framework extensions:<c><![CDATA[
- <vjc x='net'/>
- ]]></c></para>
- <para>To disable the .NET Framework extensions and the VJ++ 6.0 extensions:<c><![CDATA[
- <vjc x='all'/>
- ]]></c></para>
- </example>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.LibPath">
- <summary>
- Specifies the location of assemblies referenced by way of the <c>/reference</c> flag.
- </summary>
- <remarks>
- <para>
- Corresponds to the <c>/libpath:dir[;dir2]</c> flag.
- </para>
- <para>
- <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjgrflibpathspecifyassemblyreferencelocations.htm">See the Visual J# Reference for details.</a>
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.Jcpa">
- <summary>
- Associate Java-language/COM package names.
- </summary>
- <value>
- The value of this propery. must be <c>package=namespace</c>, <c>@filename</c>,
- or an empty string.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/jcpa:package=namespace</c> and <c>/jcpa:@filename</c> flags.
- </para>
- <para>
- <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjgrfjcpaassociatejava-compackages.htm">See the Visual J# Reference for details.</a>
- </para>
- </remarks>
- <example>
- <para>Map package 'x' to namespace 'y':<c><![CDATA[
- <vjc jcpa='x=y'/>
- ]]></c></para>
- </example>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.Codepage">
- <summary>
- Specifies the code page to use for all source code files in the
- compilation.
- </summary>
- <remarks>
- <para>
- Corresponds with the <c>/codepage</c> flag.
- </para>
- <para>
- <a href="ms-help://MS.VSCC/MS.VJSharp/dv_vjsharp/html/vjlrfcodepagespecifycodepageforsourcecodefiles.htm">See the Visual J# Reference for details.</a>
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.WarningLevel">
- <summary>
- Specifies the warning level for the compiler to display. Valid values
- are <c>0</c>-<c>4</c>. The default is <c>4</c>.
- </summary>
- <value>
- The warning level for the compiler to display.
- </value>
- <remarks>
- <para>
- Corresponds with the <c>/warn</c> option.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.WarningAsError">
- <summary>
- Controls which warnings should be reported as errors.
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.Packages">
- <summary>
- Reference packages
- </summary>
- <remarks>
- Override to avoid exposing this to build authors, as the Visual J#
- compiler does not support package references.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.Modules">
- <summary>
- Link the specified modules into this assembly.
- </summary>
- <remarks>
- Override to avoid exposing this to build authors, as the Visual J#
- compiler does not support linking modules.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.Extension">
- <summary>
- Gets the file extension required by the current compiler.
- </summary>
- <value>
- For the J# compiler, the file extension is always <c>jsl</c>.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.ClassNameRegex">
- <summary>
- Gets the class name regular expression for the language of the
- current compiler.
- </summary>
- <value>
- Class name regular expression for the language of the current
- compiler.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.NamespaceRegex">
- <summary>
- Gets the namespace regular expression for the language of the
- current compiler.
- </summary>
- <value>
- Namespace regular expression for the language of the current
- compiler.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Tasks.VjcTask.SupportsPackageReferences">
- <summary>
- Override to avoid exposing the configuration setting for this
- task as Visual J# will never support package references.
- </summary>
- <value>
- <see langword="false" />, as the Visual J# compiler will never
- support package references.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Types.AssemblyAttribute">
- <summary>
- Represents an assembly-level attribute.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/>
- class.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyAttribute.TypeName">
- <summary>
- Typename of the assembly-level attribute.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyAttribute.Value">
- <summary>
- Value of the attribute.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyAttribute.AsIs">
- <summary>
- If <see langword="true" /> then the value of the attribute will be
- set as is, without actually looking for a matching constructor or
- named properties. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the value of the attribute should be set
- as is; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyAttribute.IfDefined">
- <summary>
- Indicates if the attribute should be generated.
- </summary>
- <value>
- <see langword="true" /> if the attribute should be generated;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyAttribute.UnlessDefined">
- <summary>
- Indicates if the attribute should be not generated.
- </summary>
- <value>
- <see langword="true" /> if the attribute should be not generated;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Types.AssemblyAttributeCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/>
- objects.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.#ctor(NAnt.DotNet.Types.AssemblyAttributeCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.#ctor(NAnt.DotNet.Types.AssemblyAttribute[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> class
- with the specified array of <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Add(NAnt.DotNet.Types.AssemblyAttribute)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.AddRange(NAnt.DotNet.Types.AssemblyAttribute[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.AddRange(NAnt.DotNet.Types.AssemblyAttributeCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Contains(NAnt.DotNet.Types.AssemblyAttribute)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> with
- value <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.CopyTo(NAnt.DotNet.Types.AssemblyAttribute[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.IndexOf(NAnt.DotNet.Types.AssemblyAttribute)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/>. If the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Insert(System.Int32,NAnt.DotNet.Types.AssemblyAttribute)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.DotNet.Types.AssemblyAttributeEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeCollection.Remove(NAnt.DotNet.Types.AssemblyAttribute)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyAttributeCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyAttributeCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> with the specified value.
- </summary>
- <param name="value">The value of the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> to get.</param>
- </member>
- <member name="T:NAnt.DotNet.Types.AssemblyAttributeEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.DotNet.Types.AssemblyAttribute"/> elements of a <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeEnumerator.#ctor(NAnt.DotNet.Types.AssemblyAttributeCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyAttributeEnumerator"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.AssemblyAttributeCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyAttributeEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyAttributeEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.LibDirectorySet">
- <summary>
- A specialized <see cref="T:NAnt.Core.Types.FileSet"/> used for setting the lib directories.
- </summary>
- <remarks>
- The primary reason for this class is to allow the <see cref="P:NAnt.DotNet.Types.LibDirectorySet.BaseDirectory"/>
- to always be the same value as the parent <see cref="T:NAnt.DotNet.Types.AssemblyFileSet"/>
- </remarks>
- <seealso cref="T:NAnt.Core.Types.FileSet"/>
- </member>
- <member name="M:NAnt.DotNet.Types.LibDirectorySet.#ctor(NAnt.DotNet.Types.AssemblyFileSet)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.LibDirectorySet"/> class.
- </summary>
- <param name="parent"></param>
- </member>
- <member name="P:NAnt.DotNet.Types.LibDirectorySet.BaseDirectory">
- <summary>
- 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
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Types.AssemblyFileSet">
- <summary>
- Specialized <see cref="T:NAnt.Core.Types.FileSet"/> class for managing assembly files.
- </summary>
- <remarks>
- <para>
- If an include pattern does not contain any wildcard characters then
- the assembly will be searched for in following locations (in the order listed):
- </para>
- <list type="bullet">
- <item>
- <description>
- The base directory of the fileset.
- </description>
- </item>
- <item>
- <description>
- The directories specified using the nested <lib> element.
- </description>
- </item>
- <item>
- <description>
- The list of reference assemblies of the current target framework.
- </description>
- </item>
- </list>
- <para>
- The reference assemblies of a given target framework are defined using
- <reference-assemblies> filesets in the <framework> node
- of the NAnt configuration file.
- </para>
- </remarks>
- <example>
- <para>
- Define a reference with name "sys.assemblies", holding
- a set of system assemblies.
- </para>
- <code>
- <![CDATA[
- <assemblyfileset id="sys.assemblies">
- <include name="System.dll" />
- <include name="System.Data.dll" />
- <include name="System.Xml.dll" />
- </assemblyfileset>
- ]]>
- </code>
- <para>
- Use the predefined set of assemblies to compile a C# assembly.
- </para>
- <code>
- <![CDATA[
- <csc target="exe" output="HelloWorld.exe">
- <sources>
- <include name="**/*.cs" />
- </sources>
- <references refid="sys.assemblies" />
- </csc>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Compile a C# assembly using assembly references that are searched for
- in the "Third Party Assemblies" and "Company Assemblies"
- directories.
- </para>
- <code>
- <![CDATA[
- <csc target="exe" output="HelloWorld.exe">
- <sources>
- <include name="**/*.cs" />
- </sources>
- <references>
- <lib>
- <include name="Third Party Assemblies" />
- <include name="Company Assemblies" />
- </lib>
- <include name="log4net.dll" />
- <include name="Company.Business.dll" />
- </references>
- </csc>
- ]]>
- </code>
- </example>
- <seealso cref="T:NAnt.Core.Types.FileSet"/>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyFileSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.AssemblyFileSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyFileSet.#ctor(NAnt.Core.Types.FileSet)">
- <summary>
- copy constructor for FileSet. Required in order to
- assign references of FileSet type where
- AssemblyFileSets are used
- </summary>
- <param name="fs"></param>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyFileSet.Scan">
- <summary>
- Do a normal scan and then resolve assemblies.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.AssemblyFileSet.ResolveReferences">
- <summary>
- Resolves references to system assemblies and assemblies that can be
- resolved using directories specified in <see cref="P:NAnt.DotNet.Types.AssemblyFileSet.Lib"/>.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.AssemblyFileSet.Lib">
- <summary>
- Additional directories to search in for assembly references.
- </summary>
- <remarks>
- <para>
- loosely Corresponds with the <c>/lib[path]:</c> flag of the various compiler tasks.
- </para>
- </remarks>
- </member>
- <member name="T:NAnt.DotNet.Types.CompilerWarning">
- <summary>
- Represents a compiler warning.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.CompilerWarning.Number">
- <summary>
- A warning number, or comma-separated list of warnings, that you want
- the compiler to suppress or report.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.CompilerWarning.IfDefined">
- <summary>
- If <see langword="true" /> then the element will be processed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.CompilerWarning.UnlessDefined">
- <summary>
- If <see langword="true" /> then the element will be skipped;
- otherwise, processed. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Types.CompilerWarningCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.#ctor(NAnt.DotNet.Types.CompilerWarningCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.#ctor(NAnt.DotNet.Types.CompilerWarning[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> class
- with the specified array of <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.Add(NAnt.DotNet.Types.CompilerWarning)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.AddRange(NAnt.DotNet.Types.CompilerWarning[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.AddRange(NAnt.DotNet.Types.CompilerWarningCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.Contains(NAnt.DotNet.Types.CompilerWarning)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.CopyTo(NAnt.DotNet.Types.CompilerWarning[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.IndexOf(NAnt.DotNet.Types.CompilerWarning)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.DotNet.Types.CompilerWarning"/>. If the <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.Insert(System.Int32,NAnt.DotNet.Types.CompilerWarning)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.DotNet.Types.CompilerWarningEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningCollection.Remove(NAnt.DotNet.Types.CompilerWarning)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.CompilerWarningCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.DotNet.Types.CompilerWarningEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.DotNet.Types.CompilerWarning"/> elements of a <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningEnumerator.#ctor(NAnt.DotNet.Types.CompilerWarningCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.CompilerWarningEnumerator"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.CompilerWarningCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.CompilerWarningEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.CompilerWarningEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.DebugOutput">
- <summary>
- Specifies the type of debugging information generated by the compiler.
- </summary>
- <remarks>
- <para>
- For backward compatibility, the following string values can also be
- used in build files:
- </para>
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Corresponding field</description>
- </listheader>
- <item>
- <term>"true"</term>
- <description><see cref="F:NAnt.DotNet.Types.DebugOutput.Enable"/></description>
- </item>
- <item>
- <term>"false"</term>
- <description><see cref="F:NAnt.DotNet.Types.DebugOutput.None"/></description>
- </item>
- </list>
- <para>
- When set to <see langword="Enabled"/> then the following conditional
- compilation symbols will also be defined:
- </para>
- <list type="bullet">
- <item>
- <description>DEBUG</description>
- </item>
- <item>
- <description>TRACE</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="F:NAnt.DotNet.Types.DebugOutput.None">
- <summary>
- Create no debug information.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Types.DebugOutput.Enable">
- <summary>
- Enable attaching a debugger to the running program.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Types.DebugOutput.Full">
- <summary>
- Enable attaching a debugger to the running program.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Types.DebugOutput.PdbOnly">
- <summary>
- Only display assembler when the running program is attached to the
- debugger.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Types.DebugOutputConverter">
- <summary>
- Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
- case-insensitive conversion of "true" to
- <see cref="F:NAnt.DotNet.Types.DebugOutput.Enable"/> and "false" to
- <see cref="F:NAnt.DotNet.Types.DebugOutput.None"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.DebugOutputConverter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.DebugOutputConverter"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.DebugOutputConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <summary>
- Converts the given object to the type of this converter, using the
- specified context and culture information.
- </summary>
- <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
- <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
- <param name="value">The <see cref="T:System.Object"/> to convert.</param>
- <returns>
- An <see cref="T:System.Object"/> that represents the converted value.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.DelaySign">
- <summary>
- Specifies whether the generated assembly is strongly named and will
- be signed later.
- </summary>
- <remarks>
- <para>
- For backward compatibility, the following string values can also be
- used in build files:
- </para>
- <list type="table">
- <listheader>
- <term>Value</term>
- <description>Corresponding field</description>
- </listheader>
- <item>
- <term>"true"</term>
- <description><see cref="F:NAnt.DotNet.Types.DelaySign.Yes"/></description>
- </item>
- <item>
- <term>"false"</term>
- <description><see cref="F:NAnt.DotNet.Types.DelaySign.No"/></description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="F:NAnt.DotNet.Types.DelaySign.NotSet">
- <summary>
- Not specified.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Types.DelaySign.No">
- <summary>
- Fully sign the assembly.
- </summary>
- </member>
- <member name="F:NAnt.DotNet.Types.DelaySign.Yes">
- <summary>
- Only place the public key in the assembly, allowing the signature
- to be added later.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Types.DelaySignConverter">
- <summary>
- Specialized <see cref="T:System.ComponentModel.EnumConverter"/> that also supports
- case-insensitive conversion of "true" to
- <see cref="F:NAnt.DotNet.Types.DelaySign.Yes"/> and "false" to
- <see cref="F:NAnt.DotNet.Types.DelaySign.No"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.DelaySignConverter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.DelaySignConverter"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.DelaySignConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)">
- <summary>
- Converts the given object to the type of this converter, using the
- specified context and culture information.
- </summary>
- <param name="context">An <see cref="T:System.ComponentModel.ITypeDescriptorContext"/> that provides a format context.</param>
- <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/> object. If a <see langword="null"/> is passed, the current culture is assumed.</param>
- <param name="value">The <see cref="T:System.Object"/> to convert.</param>
- <returns>
- An <see cref="T:System.Object"/> that represents the converted value.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.EmbeddedResource">
- <summary>
- Represents an embedded resource.
- </summary>
- <remarks>
- Do not yet expose this to build authors.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResource.#ctor(System.String,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/>
- with the specified file name and manifest resource name.
- </summary>
- <param name="file">The path of the compiled resource.</param>
- <param name="manifestResourceName">The manifest resource name of the embedded resource.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.EmbeddedResource.File">
- <summary>
- Gets the physical location of the resource to embed.
- </summary>
- <value>
- The physical location of the resource to embed.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.EmbeddedResource.ManifestResourceName">
- <summary>
- Gets the manifest resource name to use when embedding the resource.
- </summary>
- <value>
- The manifest resource name to use when embedding the resource.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Types.EmbeddedResourceCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> items.
- </summary>
- <remarks>
- Do not yet expose this to build authors.
- </remarks>
- </member>
- <member name="T:NAnt.DotNet.Types.DataTypeCollectionBase">
- <summary>
- Base class for collections that needs to be globally referencable.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.DataTypeCollectionBase"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.CopyTo(System.Array,System.Int32)">
- <summary>
- Copies the items of the collection to an <see cref="T:System.Array"/>,
- starting at a particular index.
- </summary>
- <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the items copied from the collection. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through a collection.
- </summary>
- <returns>
- An <see cref="T:System.Collections.IEnumerator"/> that can be used to iterate through
- the collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.RemoveAt(System.Int32)">
- <summary>
- Removes an item at a specific index.
- </summary>
- <param name="index">The zero-based index of the item to remove.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.Clear">
- <summary>
- Removes all items from the collection.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.ValidateType(System.Object)">
- <summary>
- Used by methods that take <see cref="T:System.Object"/> instances as argument
- to verify whether the instance is valid for the collection class.
- </summary>
- <param name="value">The instance to verify.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.DataTypeCollectionBase.RangeCheck(System.Int32)">
- <summary>
- Checks whether the specified index is within the range of this
- collection.
- </summary>
- <param name="index">The index to check.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.System#Collections#ICollection#IsSynchronized">
- <summary>
- Gets a value indicating whether access to the collection is
- synchronized (thread-safe).
- </summary>
- <value>
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.Count">
- <summary>
- Gets the number of items in the collection.
- </summary>
- <value>
- The number of items in the collection.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.System#Collections#ICollection#SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the
- collection.
- </summary>
- <value>
- An object that can be used to synchronize access to the collection.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.IsFixedSize">
- <summary>
- Gets a value indicating whether the collection has a fixed size.
- </summary>
- <value>
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.IsReadOnly">
- <summary>
- Gets a value indicating whether the collection has a fixed size.
- </summary>
- <value>
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.List">
- <summary>
- Gets the list of elements contained in the
- <see cref="T:NAnt.DotNet.Types.DataTypeCollectionBase"/> instance.
- </summary>
- <value>
- An <see cref="T:System.Collections.ArrayList"/> containing the elements of the
- collection.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.DataTypeCollectionBase.ItemType">
- <summary>
- Gets the <see cref="T:System.Type"/> of the items in this collection.
- </summary>
- <value>
- The <see cref="T:System.Type"/> of the items in this collection.
- </value>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.DotNet.Types.EmbeddedResourceEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#Insert(System.Int32,System.Object)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> into the collection at the
- specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#Remove(System.Object)">
- <summary>
- Removes the specified <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> from the
- collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to remove from the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#Contains(System.Object)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> is in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#IndexOf(System.Object)">
- <summary>
- Gets the location of a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> object to locate.</param>
- <returns>
- The zero-based location of the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> in the
- collection.
- </returns>
- <remarks>
- If the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> is not currently a member of
- the collection, -1 is returned.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#Add(System.Object)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to the end of the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to be added to the end of the collection.</param>
- <returns>
- The position into which the new item was inserted.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.AddRange(NAnt.DotNet.Types.EmbeddedResourceCollection)">
- <summary>
- Adds the items of a <see cref="T:NAnt.DotNet.Types.EmbeddedResourceCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.DotNet.Types.EmbeddedResourceCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.Add(NAnt.DotNet.Types.EmbeddedResource)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to the end of the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to be added to the end of the collection.</param>
- <returns>
- The position into which the new item was inserted.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.Insert(System.Int32,NAnt.DotNet.Types.EmbeddedResource)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> into the collection at the
- specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.Remove(NAnt.DotNet.Types.EmbeddedResource)">
- <summary>
- Removes the specified <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> from the
- collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to remove from the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.Contains(NAnt.DotNet.Types.EmbeddedResource)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> is in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceCollection.IndexOf(NAnt.DotNet.Types.EmbeddedResource)">
- <summary>
- Gets the location of a <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> object to locate.</param>
- <returns>
- The zero-based location of the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> in the
- collection.
- </returns>
- <remarks>
- If the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> is not currently a member of
- the collection, -1 is returned.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Types.EmbeddedResourceCollection.Item(System.Int32)">
- <summary>
- Gets or sets the item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to get or set.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.EmbeddedResourceCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> with the specified manifest
- resource name.
- </summary>
- <param name="value">The manifest resource name of the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> to get.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.EmbeddedResourceCollection.ItemType">
- <summary>
- Gets the <see cref="T:System.Type"/> of the items in this collection.
- </summary>
- <value>
- The <see cref="T:System.Type"/> of the items in this collection.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.EmbeddedResourceCollection.System#Collections#IList#$Item$(System.Int32)">
- <summary>
- Gets or sets the item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to get or set.</param>
- </member>
- <member name="T:NAnt.DotNet.Types.EmbeddedResourceEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.DotNet.Types.EmbeddedResource"/> items of a <see cref="T:NAnt.DotNet.Types.EmbeddedResourceCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceEnumerator.#ctor(NAnt.DotNet.Types.EmbeddedResourceCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.EmbeddedResourceEnumerator"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.EmbeddedResourceCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next item of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next item; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.EmbeddedResourceEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first item in the collection.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.EmbeddedResourceEnumerator.Current">
- <summary>
- Gets the current item in the collection.
- </summary>
- <returns>
- The current item in the collection.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Types.EmbeddedResourceEnumerator.System#Collections#IEnumerator#Current">
- <summary>
- Gets the current item in the collection.
- </summary>
- <returns>
- The current item in the collection.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.Module">
- <summary>
- Represents a metadata file without assembly manifest.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.Module.ToString">
- <summary>
- Returns a textual representation of the module, which can be used as
- argument for command-line tools.
- </summary>
- <returns>
- A textual representation of the path, file[,target].
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Types.Module.File">
- <summary>
- The path of the module.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.Module.Target">
- <summary>
- File name where the module should be copied to before it is compiled
- into an assembly.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.Module.ModuleSet">
- <summary>
- Gets or sets the <see cref="P:NAnt.DotNet.Types.Module.ModuleSet"/> that contains the module.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Types.ModuleCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.DotNet.Types.Module"/> items.
- </summary>
- <remarks>
- Do not yet expose this to build authors.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.#ctor(NAnt.DotNet.Types.ModuleSet)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>
- for the specified <see cref="T:NAnt.DotNet.Types.ModuleSet"/>.
- </summary>
- <param name="moduleSet">The <see cref="T:NAnt.DotNet.Types.ModuleSet"/> containing the collection.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="moduleSet"/> is <see langword="true"/>.</exception>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.DotNet.Types.ModuleEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.CopyTo(System.Array,System.Int32)">
- <summary>
- Copies the items of the collection to an <see cref="T:System.Array"/>,
- starting at a particular index.
- </summary>
- <param name="array">The one-dimensional <see cref="T:System.Array"/> that is the destination of the items copied from the collection. The <see cref="T:System.Array"/> must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.Clear">
- <summary>
- Removes all items from the collection.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#Insert(System.Int32,System.Object)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.Module"/> into the collection at the
- specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#Remove(System.Object)">
- <summary>
- Removes the specified <see cref="T:NAnt.DotNet.Types.Module"/> from the
- collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to remove from the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.RemoveAt(System.Int32)">
- <summary>
- Removes an item at a specific index.
- </summary>
- <param name="index">The zero-based index of the item to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index"/> parameter is less than 0 or greater than or equal to the value of the <see cref="P:NAnt.DotNet.Types.ModuleCollection.Count"/> property of the <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.</exception>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#Contains(System.Object)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.Module"/> is in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#IndexOf(System.Object)">
- <summary>
- Gets the location of a <see cref="T:NAnt.DotNet.Types.Module"/> in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> object to locate.</param>
- <returns>
- The zero-based location of the <see cref="T:NAnt.DotNet.Types.Module"/> in the
- collection.
- </returns>
- <remarks>
- If the <see cref="T:NAnt.DotNet.Types.Module"/> is not currently a member of
- the collection, -1 is returned.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#Add(System.Object)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.Module"/> to the end of the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to be added to the end of the collection.</param>
- <returns>
- The position into which the new item was inserted.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.AddRange(NAnt.DotNet.Types.ModuleCollection)">
- <summary>
- Adds the items of a <see cref="T:NAnt.DotNet.Types.ModuleCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.DotNet.Types.ModuleCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.Add(NAnt.DotNet.Types.Module)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.Module"/> to the end of the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to be added to the end of the collection.</param>
- <returns>
- The position into which the new item was inserted.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.DotNet.Types.ModuleEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.Insert(System.Int32,NAnt.DotNet.Types.Module)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.Module"/> into the collection at the
- specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.Remove(NAnt.DotNet.Types.Module)">
- <summary>
- Removes the specified <see cref="T:NAnt.DotNet.Types.Module"/> from the
- collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to remove from the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.Contains(NAnt.DotNet.Types.Module)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.Module"/> is in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleCollection.IndexOf(NAnt.DotNet.Types.Module)">
- <summary>
- Gets the location of a <see cref="T:NAnt.DotNet.Types.Module"/> in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.Module"/> object to locate.</param>
- <returns>
- The zero-based location of the <see cref="T:NAnt.DotNet.Types.Module"/> in the
- collection.
- </returns>
- <remarks>
- If the <see cref="T:NAnt.DotNet.Types.Module"/> is not currently a member of
- the collection, -1 is returned.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleCollection.Item(System.Int32)">
- <summary>
- Gets or sets the item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to get or set.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index"/> parameter is less than 0 or greater than or equal to the value of the <see cref="P:NAnt.DotNet.Types.ModuleCollection.Count"/> property of the <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.</exception>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleCollection.List">
- <summary>
- Gets the list of elements contained in the
- <see cref="T:NAnt.DotNet.Types.ModuleCollection"/> instance.
- </summary>
- <value>
- An <see cref="T:System.Collections.ArrayList"/> containing the elements of the
- collection.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleCollection.System#Collections#ICollection#IsSynchronized">
- <summary>
- Gets a value indicating whether access to the collection is
- synchronized (thread-safe).
- </summary>
- <value>
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleCollection.Count">
- <summary>
- Gets the number of items in the collection.
- </summary>
- <value>
- The number of items in the collection.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleCollection.System#Collections#ICollection#SyncRoot">
- <summary>
- Gets an object that can be used to synchronize access to the
- collection.
- </summary>
- <value>
- An object that can be used to synchronize access to the collection.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleCollection.IsFixedSize">
- <summary>
- Gets a value indicating whether the collection has a fixed size.
- </summary>
- <value>
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleCollection.IsReadOnly">
- <summary>
- Gets a value indicating whether the collection has a fixed size.
- </summary>
- <value>
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleCollection.System#Collections#IList#$Item$(System.Int32)">
- <summary>
- Gets or sets the item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to get or set.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="index"/> parameter is less than 0 or greater than or equal to the value of the <see cref="P:NAnt.DotNet.Types.ModuleCollection.Count"/> property of the <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.</exception>
- </member>
- <member name="T:NAnt.DotNet.Types.ModuleEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.DotNet.Types.Module"/> items of a <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleEnumerator.#ctor(NAnt.DotNet.Types.ModuleCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ModuleEnumerator"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.ModuleCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next item of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next item; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first item in the collection.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleEnumerator.Current">
- <summary>
- Gets the current item in the collection.
- </summary>
- <returns>
- The current item in the collection.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleEnumerator.System#Collections#IEnumerator#Current">
- <summary>
- Gets the current item in the collection.
- </summary>
- <returns>
- The current item in the collection.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.ModuleSet">
- <summary>
- <para>
- One or more modules to compile into an assembly.
- </para>
- </summary>
- <example>
- <para>
- Define a global <c><moduleset></c> that can be referenced by
- other tasks or types.
- </para>
- <code>
- <![CDATA[
- <moduleset id="client-modules" dir="${build}">
- <module file="Client.netmodule" />
- <module file="Common.netmodule" />
- </moduleset>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Types.ModuleSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ModuleSet"/> class.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleSet.Dir">
- <summary>
- The base of the directory of this <see cref="T:NAnt.DotNet.Types.ModuleSet"/>.
- The default is the project base directory.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.ModuleSet.Modules">
- <summary>
- The modules to add to this <see cref="T:NAnt.DotNet.Types.ModuleSet"/>.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Types.NamespaceImport">
- <summary>
- Represents a namespace to import.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImport.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImport.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/>
- class for the specified namespace.
- </summary>
- <param name="nameSpace">The namespace.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="nameSpace"/> is <see langword="null"/>.</exception>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImport.TempName">
- <summary>
- The name of the namespace to import.
- </summary>
- <value>
- The name of the namespace to import.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImport.Namespace">
- <summary>
- The name of the namespace to import.
- </summary>
- <value>
- The name of the namespace to import.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImport.IfDefined">
- <summary>
- Indicates if the import should be generated.
- </summary>
- <value>
- <see langword="true" /> if the import should be generated; otherwise,
- <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImport.UnlessDefined">
- <summary>
- Indicates if the import should be not generated.
- </summary>
- <value>
- <see langword="true" /> if the import should be not generated;
- otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Types.NamespaceImportCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> items.
- </summary>
- <example>
- <para>Define a reference with name "system.imports".</para>
- <code>
- <![CDATA[
- <namespaceimports id="system.imports">
- <import namespace="System" />
- <import namespace="System.Data" />
- </namespaceimports>
- ]]>
- </code>
- <para>Use the predefined set of imports to compile a VB.NET assembly.</para>
- <code>
- <![CDATA[
- <vbc target="exe" output="HelloWorld.exe" rootnamespace="HelloWorld">
- <imports refid="system.imports" />
- <sources>
- <include name="**/*.vb" />
- </sources>
- <references>
- <include name="System.dll" />
- <include name="System.Data.dll" />
- </references>
- </vbc>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.DotNet.Types.NamespaceImportEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.ToString">
- <summary>
- Returns a comma-delimited list of namespace imports.
- </summary>
- <returns>
- A comma-delimited list of namespace imports, or an empty
- <see cref="T:System.String"/> if there are no namespace imports.
- </returns>
- <remarks>
- Each namespace import is quoted individually.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#Insert(System.Int32,System.Object)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> into the collection at the
- specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#Remove(System.Object)">
- <summary>
- Removes the specified <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> from the
- collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to remove from the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#Contains(System.Object)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> is in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#IndexOf(System.Object)">
- <summary>
- Gets the location of a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> object to locate.</param>
- <returns>
- The zero-based location of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> in the
- collection.
- </returns>
- <remarks>
- If the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> is not currently a member of
- the collection, -1 is returned.
- </remarks>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#Add(System.Object)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to the end of the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to be added to the end of the collection.</param>
- <returns>
- The position into which the new item was inserted.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.AddRange(NAnt.DotNet.Types.NamespaceImportCollection)">
- <summary>
- Adds the items of a <see cref="T:NAnt.DotNet.Types.NamespaceImportCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.DotNet.Types.NamespaceImportCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.Add(NAnt.DotNet.Types.NamespaceImport)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to the end of the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to be added to the end of the collection.</param>
- <returns>
- The position into which the new item was inserted.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.Insert(System.Int32,NAnt.DotNet.Types.NamespaceImport)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> into the collection at the
- specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.Remove(NAnt.DotNet.Types.NamespaceImport)">
- <summary>
- Removes the specified <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> from the
- collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to remove from the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.Contains(NAnt.DotNet.Types.NamespaceImport)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> is in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="value"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportCollection.IndexOf(NAnt.DotNet.Types.NamespaceImport)">
- <summary>
- Gets the location of a <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> in the collection.
- </summary>
- <param name="value">The <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> object to locate.</param>
- <returns>
- The zero-based location of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> in the
- collection.
- </returns>
- <remarks>
- If the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> is not currently a member of
- the collection, -1 is returned.
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImportCollection.Item(System.Int32)">
- <summary>
- Gets or sets the item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to get or set.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImportCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> with the specified namespace.
- </summary>
- <param name="value">The namespace of the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> to get.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImportCollection.ItemType">
- <summary>
- Gets the <see cref="T:System.Type"/> of the items in this collection.
- </summary>
- <value>
- The <see cref="T:System.Type"/> of the items in this collection.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImportCollection.System#Collections#IList#$Item$(System.Int32)">
- <summary>
- Gets or sets the item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to get or set.</param>
- </member>
- <member name="T:NAnt.DotNet.Types.NamespaceImportEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.DotNet.Types.NamespaceImport"/> items of a <see cref="T:NAnt.DotNet.Types.NamespaceImportCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportEnumerator.#ctor(NAnt.DotNet.Types.NamespaceImportCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.NamespaceImportEnumerator"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.NamespaceImportCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next item of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next item; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.NamespaceImportEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first item in the collection.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImportEnumerator.Current">
- <summary>
- Gets the current item in the collection.
- </summary>
- <returns>
- The current item in the collection.
- </returns>
- </member>
- <member name="P:NAnt.DotNet.Types.NamespaceImportEnumerator.System#Collections#IEnumerator#Current">
- <summary>
- Gets the current item in the collection.
- </summary>
- <returns>
- The current item in the collection.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.Package">
- <summary>
- Represents a package.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.Package.PackageName">
- <summary>
- Name of the package to reference. Multiple package can be specified
- with a single element as a semi-colon separated list of
- package names.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.Package.IfDefined">
- <summary>
- Indicates if the package should be passed to the task.
- If <see langword="true" /> then the package will be passed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.Package.UnlessDefined">
- <summary>
- Indicates if the package should not be passed to the task.
- If <see langword="false" /> then the package will be passed;
- otherwise, skipped. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.DotNet.Types.PackageCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.DotNet.Types.Package"/>
- objects.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.PackageCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.#ctor(NAnt.DotNet.Types.PackageCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.PackageCollection"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.PackageCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.#ctor(NAnt.DotNet.Types.Package[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.PackageCollection"/> class
- with the specified array of <see cref="T:NAnt.DotNet.Types.Package"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.Add(NAnt.DotNet.Types.Package)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.Package"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.AddRange(NAnt.DotNet.Types.Package[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.DotNet.Types.Package"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.DotNet.Types.Package"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.AddRange(NAnt.DotNet.Types.PackageCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.DotNet.Types.PackageCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.DotNet.Types.PackageCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.Contains(NAnt.DotNet.Types.Package)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.Package"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.CopyTo(NAnt.DotNet.Types.Package[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.IndexOf(NAnt.DotNet.Types.Package)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.DotNet.Types.Package"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.DotNet.Types.Package"/>. If the <see cref="T:NAnt.DotNet.Types.Package"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.Insert(System.Int32,NAnt.DotNet.Types.Package)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.Package"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.DotNet.Types.PackageEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageCollection.Remove(NAnt.DotNet.Types.Package)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.Package"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.PackageCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.DotNet.Types.PackageEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.DotNet.Types.Package"/> elements of a <see cref="T:NAnt.DotNet.Types.PackageCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageEnumerator.#ctor(NAnt.DotNet.Types.PackageCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.PackageEnumerator"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.PackageCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.PackageEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.PackageEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.ResourceFileSet">
- <summary>
- Specialized <see cref="T:NAnt.Core.Types.FileSet"/> class for managing resource files.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSet.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSet.#ctor(NAnt.Core.Types.FileSet)">
- <summary>
- copy constructor for FileSet. Required in order to
- assign references of FileSet type where
- ResourceFileSet are used
- </summary>
- <param name="fs"></param>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSet.Clone">
- <summary>
- Creates a shallow copy of the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/>.
- </summary>
- <returns>
- A shallow copy of the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSet.GetManifestResourceName(System.String)">
- <summary>
- Gets the manifest resource name for the specified resource file.
- </summary>
- <param name="resourceFile">The physical path of the resource file.</param>
- <returns>
- The manifest resource name to be sent to the compiler.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSet.GetManifestResourceName(System.String,System.String)">
- <summary>
- Gets the manifest resource name for the file using both its physical
- and logical path.
- </summary>
- <param name="physicalPath">The physical path of the resource file.</param>
- <param name="logicalPath">The logical location of the resource file.</param>
- <returns>
- The manifest resource name to be sent to the compiler.
- </returns>
- <remarks>
- We use the relative path of the logical path, but the filename and
- and the extension of the physical path to match VS.NET
- </remarks>
- </member>
- <member name="P:NAnt.DotNet.Types.ResourceFileSet.Prefix">
- <summary>
- Indicates the prefix to prepend to the actual resource.
- This is usually the default namspace of the assembly.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.ResourceFileSet.DynamicPrefix">
- <summary>
- 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 <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.ResourceFileSet.ResxFiles">
- <summary>
- Gets a <see cref="T:NAnt.Core.Types.FileSet"/> containing all matching resx files.
- </summary>
- <value>
- A <see cref="T:NAnt.Core.Types.FileSet"/> containing all matching resx files.
- </value>
- </member>
- <member name="P:NAnt.DotNet.Types.ResourceFileSet.NonResxFiles">
- <summary>
- Gets a <see cref="T:NAnt.Core.Types.FileSet"/> containing all matching non-resx
- files.
- </summary>
- <value>
- A <see cref="T:NAnt.Core.Types.FileSet"/> containing all matching non-resx files.
- </value>
- </member>
- <member name="T:NAnt.DotNet.Types.ResourceFileSetCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.#ctor(NAnt.DotNet.Types.ResourceFileSetCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.#ctor(NAnt.DotNet.Types.ResourceFileSet[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> class
- with the specified array of <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.Add(NAnt.DotNet.Types.ResourceFileSet)">
- <summary>
- Adds a <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.AddRange(NAnt.DotNet.Types.ResourceFileSet[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.AddRange(NAnt.DotNet.Types.ResourceFileSetCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.Contains(NAnt.DotNet.Types.ResourceFileSet)">
- <summary>
- Determines whether a <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.CopyTo(NAnt.DotNet.Types.ResourceFileSet[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.IndexOf(NAnt.DotNet.Types.ResourceFileSet)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/>. If the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.Insert(System.Int32,NAnt.DotNet.Types.ResourceFileSet)">
- <summary>
- Inserts a <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to insert.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.DotNet.Types.ResourceFileSetEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetCollection.Remove(NAnt.DotNet.Types.ResourceFileSet)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.DotNet.Types.ResourceFileSetCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.DotNet.Types.ResourceFileSetEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.DotNet.Types.ResourceFileSet"/> elements of a <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetEnumerator.#ctor(NAnt.DotNet.Types.ResourceFileSetCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.DotNet.Types.ResourceFileSetEnumerator"/> class
- with the specified <see cref="T:NAnt.DotNet.Types.ResourceFileSetCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.DotNet.Types.ResourceFileSetEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.ResourceFileSetEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.DotNet.Types.WarningAsError">
- <summary>
- Controls the behaviour of a compiler with regards to the reporting of
- warnings.
- </summary>
- <example>
- <para>
- Instruct a compiler to report warning 0519 as an error.
- </para>
- <code>
- <![CDATA[
- <warnaserror>
- <include number="0519" />
- </warnaserror>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Instruct a compiler not to report warning 0519 as an error, if the
- <c>release</c> property is <see langword="true" />.
- </para>
- <code>
- <![CDATA[
- <warnaserror>
- <exclude number="0519" if="${release}" />
- </warnaserror>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.DotNet.Types.WarningAsError.Includes">
- <summary>
- Specifies a list of warnings that the compiler should treat as
- errors. This overrides the <see cref="P:NAnt.DotNet.Tasks.CompilerBase.WarnAsError"/>
- attribute. Only supported when targeting .NET 2.0 or higher.
- </summary>
- </member>
- <member name="P:NAnt.DotNet.Types.WarningAsError.Excludes">
- <summary>
- Specifies a list of warnings that the compiler should NOT treat as
- errors. This is only useful if <see cref="P:NAnt.DotNet.Tasks.CompilerBase.WarnAsError"/>
- is <see langword="true"/>. Only supported when targeting .NET 2.0
- or higher.
- </summary>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.exe
Binary file
slips/build/tools/nant/bin/NAnt.exe.config
@@ -1,1918 +0,0 @@
-<?xml version="1.0"?>
-<configuration>
- <!-- Leave this alone. Sets up configsectionhandler section -->
- <configSections>
- <section name="nant" type="NAnt.Core.ConfigurationSection, NAnt.Core" />
- <section name="log4net" type="System.Configuration.IgnoreSectionHandler" />
- </configSections>
- <appSettings>
- <!-- Used to indicate the location of the cache folder for shadow files -->
- <add key="shadowfiles.path" value="%temp%\nunit20\ShadowCopyCache" />
- <!-- Used to indicate that NAnt should shadow copy files in a cache folder near the executable -->
- <add key="nant.shadowfiles" value="False" />
- <!-- Used to indicate if cached files should be deleted when done running-->
- <add key="nant.shadowfiles.cleanup" value="False" />
- <!-- To enable internal log4net logging, uncomment the next line -->
- <!-- <add key="log4net.Internal.Debug" value="true"/> -->
- </appSettings>
- <!-- nant config settings -->
- <nant>
- <frameworks>
- <platform name="win32" default="auto">
- <task-assemblies>
- <!-- include NAnt task assemblies -->
- <include name="*Tasks.dll" />
- <!-- include NAnt test assemblies -->
- <include name="*Tests.dll" />
- <!-- include framework-neutral assemblies -->
- <include name="extensions/common/neutral/**/*.dll" />
- <!-- exclude Microsoft.NET specific task assembly -->
- <exclude name="NAnt.MSNetTasks.dll" />
- <!-- exclude Microsoft.NET specific test assembly -->
- <exclude name="NAnt.MSNet.Tests.dll" />
- </task-assemblies>
- <framework
- name="net-1.0"
- family="net"
- version="1.0"
- description="Microsoft .NET Framework 1.0"
- sdkdirectory="${path::combine(sdkInstallRoot, 'bin')}"
- frameworkdirectory="${path::combine(installRoot, 'v1.0.3705')}"
- frameworkassemblydirectory="${path::combine(installRoot, 'v1.0.3705')}"
- clrversion="1.0.3705"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/net/1.0" />
- <directory name="lib/net/neutral" />
- <directory name="lib/common/1.0" />
- <directory name="lib/common/neutral" />
- </probing-paths>
-
- <modes>
- <strict>
- <environment>
- <variable name="COMPLUS_VERSION" value="v1.0.3705" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(installRoot, 'v1.0.3705')}">
- <include name="Accessibility.dll" />
- <include name="mscorlib.dll" />
- <include name="Microsoft.Vsa.dll" />
- <include name="Microsoft.VisualBasic.dll" />
- <include name="System.Configuration.Install.dll" />
- <include name="System.Data.dll" />
- <include name="System.Design.dll" />
- <include name="System.DirectoryServices.dll" />
- <include name="System.dll" />
- <include name="System.Drawing.Design.dll" />
- <include name="System.Drawing.dll" />
- <include name="System.EnterpriseServices.dll" />
- <include name="System.Management.dll" />
- <include name="System.Messaging.dll" />
- <include name="System.Runtime.Remoting.dll" />
- <include name="System.Runtime.Serialization.Formatters.Soap.dll" />
- <include name="System.Security.dll" />
- <include name="System.ServiceProcess.dll" />
- <include name="System.Web.dll" />
- <include name="System.Web.RegularExpressions.dll" />
- <include name="System.Web.Services.dll" />
- <include name="System.Windows.Forms.dll" />
- <include name="System.XML.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include MS.NET version-neutral assemblies -->
- <include name="extensions/net/neutral/**/*.dll" />
- <!-- include MS.NET 1.0 specific assemblies -->
- <include name="extensions/net/1.0/**/*.dll" />
- <!-- include Microsoft.NET specific task assembly -->
- <include name="NAnt.MSNetTasks.dll" />
- <!-- include Microsoft.NET specific test assembly -->
- <include name="NAnt.MSNet.Tests.dll" />
- <!-- include .NET 1.0 specific assemblies -->
- <include name="extensions/common/1.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${path::combine(sdkInstallRoot, 'bin')}" />
- <directory name="${path::combine(installRoot, 'v1.0.3705')}" />
- </tool-paths>
- <project>
- <readregistry
- property="installRoot"
- key="SOFTWARE\Microsoft\.NETFramework\InstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot"
- key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot"
- hive="LocalMachine"
- failonerror="false" />
- </project>
- <tasks>
- <task name="csc">
- <attribute name="supportsnowarnlist">true</attribute>
- </task>
- <task name="vjc">
- <attribute name="supportsnowarnlist">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="exename">lc</attribute>
- </task>
- <task name="aximp">
- <attribute name="supportsrcw">false</attribute>
- </task>
- <task name="tlbimp">
- <attribute name="supportstransform">false</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="net-1.1"
- family="net"
- version="1.1"
- description="Microsoft .NET Framework 1.1"
- sdkdirectory="${path::combine(sdkInstallRoot, 'bin')}"
- frameworkdirectory="${path::combine(installRoot, 'v1.1.4322')}"
- frameworkassemblydirectory="${path::combine(installRoot, 'v1.1.4322')}"
- clrversion="1.1.4322"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/net/1.1" />
- <directory name="lib/net/neutral" />
- <directory name="lib/common/1.1" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <strict>
- <environment>
- <variable name="COMPLUS_VERSION" value="v1.1.4322" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(installRoot, 'v1.1.4322')}">
- <include name="Accessibility.dll" />
- <include name="mscorlib.dll" />
- <include name="Microsoft.Vsa.dll" />
- <include name="Microsoft.VisualBasic.dll" />
- <include name="System.Configuration.Install.dll" />
- <include name="System.Data.dll" />
- <include name="System.Design.dll" />
- <include name="System.DirectoryServices.dll" />
- <include name="System.dll" />
- <include name="System.Drawing.Design.dll" />
- <include name="System.Drawing.dll" />
- <include name="System.EnterpriseServices.dll" />
- <include name="System.Management.dll" />
- <include name="System.Messaging.dll" />
- <include name="System.Runtime.Remoting.dll" />
- <include name="System.Runtime.Serialization.Formatters.Soap.dll" />
- <include name="System.Security.dll" />
- <include name="System.ServiceProcess.dll" />
- <include name="System.Web.dll" />
- <include name="System.Web.Mobile.dll" />
- <include name="System.Web.RegularExpressions.dll" />
- <include name="System.Web.Services.dll" />
- <include name="System.Windows.Forms.dll" />
- <include name="System.XML.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include MS.NET version-neutral assemblies -->
- <include name="extensions/net/neutral/**/*.dll" />
- <!-- include MS.NET 1.1 specific assemblies -->
- <include name="extensions/net/1.1/**/*.dll" />
- <!-- include MS.NET specific task assembly -->
- <include name="NAnt.MSNetTasks.dll" />
- <!-- include MS.NET specific test assembly -->
- <include name="NAnt.MSNet.Tests.dll" />
- <!-- include .NET 1.1 specific assemblies -->
- <include name="extensions/common/1.1/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${path::combine(sdkInstallRoot, 'bin')}" />
- <directory name="${path::combine(installRoot, 'v1.1.4322')}" />
- </tool-paths>
- <project>
- <readregistry
- property="installRoot"
- key="SOFTWARE\Microsoft\.NETFramework\InstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot"
- key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRootv1.1"
- hive="LocalMachine"
- failonerror="false" />
- </project>
- <tasks>
- <task name="csc">
- <attribute name="supportsnowarnlist">true</attribute>
- </task>
- <task name="vjc">
- <attribute name="supportsnowarnlist">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="exename">lc</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="net-2.0"
- family="net"
- version="2.0"
- description="Microsoft .NET Framework 2.0"
- sdkdirectory="${path::combine(sdkInstallRoot, 'bin')}"
- frameworkdirectory="${path::combine(installRoot, 'v2.0.50727')}"
- frameworkassemblydirectory="${path::combine(installRoot, 'v2.0.50727')}"
- clrversion="2.0.50727"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/net/2.0" />
- <directory name="lib/net/neutral" />
- <directory name="lib/common/2.0" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <strict>
- <environment>
- <variable name="COMPLUS_VERSION" value="v2.0.50727" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(installRoot, 'v2.0.50727')}">
- <include name="Accessibility.dll" />
- <include name="mscorlib.dll" />
- <include name="Microsoft.Build.Engine.dll" />
- <include name="Microsoft.Build.Framework.dll" />
- <include name="Microsoft.Build.Utilities.dll" />
- <include name="Microsoft.Vsa.dll" />
- <include name="Microsoft.VisualBasic.dll" />
- <include name="Microsoft.VisualBasic.Compatibility.dll" />
- <include name="Microsoft.VisualBasic.Compatibility.Data.dll" />
- <include name="System.Configuration.dll" />
- <include name="System.Configuration.Install.dll" />
- <include name="System.Data.dll" />
- <include name="System.Data.OracleClient.dll" />
- <include name="System.Data.SqlXml.dll" />
- <include name="System.Deployment.dll" />
- <include name="System.Design.dll" />
- <include name="System.DirectoryServices.dll" />
- <include name="System.dll" />
- <include name="System.Drawing.Design.dll" />
- <include name="System.Drawing.dll" />
- <include name="System.EnterpriseServices.dll" />
- <include name="System.Management.dll" />
- <include name="System.Messaging.dll" />
- <include name="System.Runtime.Remoting.dll" />
- <include name="System.Runtime.Serialization.Formatters.Soap.dll" />
- <include name="System.Security.dll" />
- <include name="System.ServiceProcess.dll" />
- <include name="System.Transactions.dll" />
- <include name="System.Web.dll" />
- <include name="System.Web.Mobile.dll" />
- <include name="System.Web.RegularExpressions.dll" />
- <include name="System.Web.Services.dll" />
- <include name="System.Windows.Forms.dll" />
- <include name="System.Xml.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include MS.NET version-neutral assemblies -->
- <include name="extensions/net/neutral/**/*.dll" />
- <!-- include MS.NET 2.0 specific assemblies -->
- <include name="extensions/net/2.0/**/*.dll" />
- <!-- include MS.NET specific task assembly -->
- <include name="NAnt.MSNetTasks.dll" />
- <!-- include MS.NET specific test assembly -->
- <include name="NAnt.MSNet.Tests.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${path::combine(sdkInstallRoot, 'bin')}" />
- <directory name="${path::combine(installRoot, 'v2.0.50727')}" />
- </tool-paths>
- <project>
- <readregistry
- property="installRoot"
- key="SOFTWARE\Microsoft\.NETFramework\InstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot"
- key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRootv2.0"
- hive="LocalMachine"
- failonerror="false" />
- </project>
- <tasks>
- <task name="csc">
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportswarnaserrorlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportsplatform">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="vbc">
- <attribute name="supportsdocgeneration">true</attribute>
- <attribute name="supportsnostdlib">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportsplatform">true</attribute>
- <attribute name="supportswarnaserrorlist">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="supportsplatform">true</attribute>
- </task>
- <task name="vjc">
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="supportsassemblyreferences">true</attribute>
- <attribute name="supportsexternalfilereferences">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="exename">lc</attribute>
- <attribute name="supportsassemblyreferences">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="net-3.5"
- family="net"
- version="2.0"
- description="Microsoft .NET Framework 3.5"
- sdkdirectory="${path::combine(sdkInstallRoot, 'bin')}"
- frameworkdirectory="${path::combine(installRoot, 'v3.5')}"
- frameworkassemblydirectory="${path::combine(installRoot, 'v2.0.50727')}"
- clrversion="2.0.50727"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/net/2.0" />
- <directory name="lib/net/neutral" />
- <directory name="lib/common/2.0" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <strict>
- <environment>
- <variable name="COMPLUS_VERSION" value="v2.0.50727" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(installRoot, 'v2.0.50727')}">
- <include name="Accessibility.dll" />
- <include name="mscorlib.dll" />
- <include name="Microsoft.Build.Utilities.dll" />
- <include name="Microsoft.Vsa.dll" />
- <include name="Microsoft.VisualBasic.dll" />
- <include name="Microsoft.VisualBasic.Compatibility.dll" />
- <include name="Microsoft.VisualBasic.Compatibility.Data.dll" />
- <include name="System.Configuration.dll" />
- <include name="System.Configuration.Install.dll" />
- <include name="System.Data.dll" />
- <include name="System.Data.OracleClient.dll" />
- <include name="System.Data.SqlXml.dll" />
- <include name="System.Deployment.dll" />
- <include name="System.Design.dll" />
- <include name="System.DirectoryServices.dll" />
- <include name="System.dll" />
- <include name="System.Drawing.Design.dll" />
- <include name="System.Drawing.dll" />
- <include name="System.EnterpriseServices.dll" />
- <include name="System.Management.dll" />
- <include name="System.Messaging.dll" />
- <include name="System.Runtime.Remoting.dll" />
- <include name="System.Runtime.Serialization.Formatters.Soap.dll" />
- <include name="System.Security.dll" />
- <include name="System.ServiceProcess.dll" />
- <include name="System.Transactions.dll" />
- <include name="System.Web.dll" />
- <include name="System.Web.Mobile.dll" />
- <include name="System.Web.RegularExpressions.dll" />
- <include name="System.Web.Services.dll" />
- <include name="System.Windows.Forms.dll" />
- <include name="System.Xml.dll" />
- </reference-assemblies>
- <reference-assemblies basedir="${environment::get-folder-path('ProgramFiles')}/Reference Assemblies/Microsoft/Framework/v3.5">
- <include name="Microsoft.Build.Engine.dll" />
- <include name="Microsoft.Build.Framework.dll" />
- <include name="System.AddIn.Contract.dll" />
- <include name="System.AddIn.dll" />
- <include name="System.Core.dll" />
- <include name="System.Data.DataSetExtensions.dll" />
- <include name="System.Data.Linq.dll" />
- <include name="System.DirectoryServices.AccountManagement.dll" />
- <include name="System.Management.Instrumentation.dll" />
- <include name="System.Net.dll" />
- <include name="System.ServiceModel.Web.dll" />
- <include name="System.Web.Extensions.Design.dll" />
- <include name="System.Web.Extensions.dll" />
- <include name="System.Windows.Presentation.dll" />
- <include name="System.WorkflowServices.dll" />
- <include name="System.Xml.Linq.dll" />
- </reference-assemblies>
- <reference-assemblies basedir="${environment::get-folder-path('ProgramFiles')}/Reference Assemblies/Microsoft/Framework/v3.0">
- <include name="System.IdentityModel.dll" />
- <include name="System.IdentityModel.Selectors.dll" />
- <include name="System.IO.Log.dll" />
- <include name="System.Printing.dll" />
- <include name="System.Runtime.Serialization.dll" />
- <include name="System.ServiceModel.dll" />
- <include name="System.Speech.dll" />
- <include name="System.Workflow.Activities.dll" />
- <include name="System.Workflow.ComponentModel.dll" />
- <include name="System.Workflow.Runtime.dll" />
- <include name="WindowsBase.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include MS.NET version-neutral assemblies -->
- <include name="extensions/net/neutral/**/*.dll" />
- <!-- include MS.NET 2.0 specific assemblies -->
- <include name="extensions/net/2.0/**/*.dll" />
- <!-- include MS.NET specific task assembly -->
- <include name="NAnt.MSNetTasks.dll" />
- <!-- include MS.NET specific test assembly -->
- <include name="NAnt.MSNet.Tests.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${path::combine(sdkInstallRoot, 'bin')}" />
- <directory name="${path::combine(installRoot, 'v3.5')}" />
- <directory name="${path::combine(installRoot, 'v2.0.50727')}" />
- </tool-paths>
- <project>
- <readregistry
- property="installRoot"
- key="SOFTWARE\Microsoft\.NETFramework\InstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot"
- key="SOFTWARE\Microsoft\Microsoft SDKs\Windows\v6.0A\WinSDKNetFxTools\InstallationFolder"
- hive="LocalMachine"
- failonerror="false" />
- <property name="frameworkDirectoryV35" value="${path::combine(installRoot, 'v3.5')}" />
- <fail if="${not(directory::exists(frameworkDirectoryV35))}">The Framework directory for .NET 3.5 does not exist.</fail>
- <property name="referenceV35" value="${environment::get-folder-path('ProgramFiles')}/Reference Assemblies/Microsoft/Framework/v3.5" />
- <fail if="${not(directory::exists(referenceV35))}">The Reference Assemblies directory for .NET 3.5 does not exist.</fail>
- </project>
- <tasks>
- <task name="csc">
- <attribute name="exename">${path::combine(frameworkDirectoryV35,'csc.exe')}</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportswarnaserrorlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportsplatform">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="vbc">
- <attribute name="exename">${path::combine(frameworkDirectoryV35,'vbc.exe')}</attribute>
- <attribute name="supportsdocgeneration">true</attribute>
- <attribute name="supportsnostdlib">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportsplatform">true</attribute>
- <attribute name="supportswarnaserrorlist">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="supportsplatform">true</attribute>
- </task>
- <task name="vjc">
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="supportsassemblyreferences">true</attribute>
- <attribute name="supportsexternalfilereferences">true</attribute>
- </task>
- <task name="al">
- <attribute name="exename">${path::combine(sdkInstallRoot, 'bin/al.exe')}</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="exename">lc</attribute>
- <attribute name="supportsassemblyreferences">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="netcf-1.0"
- family="netcf"
- version="1.0"
- description="Microsoft .NET Compact Framework 1.0"
- sdkdirectory="${path::combine(sdkInstallRoot, 'v1.0.5000\bin')}"
- frameworkdirectory="${path::combine(installRoot, 'v1.1.4322')}"
- frameworkassemblydirectory="${path::combine(sdkInstallRoot, 'v1.0.5000\Windows CE')}"
- clrversion="1.1.4322"
- >
- <runtime>
- <modes>
- <strict>
- <environment>
- <variable name="COMPLUS_VERSION" value="v1.1.4322" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(sdkInstallRoot, 'v1.0.5000\Windows CE')}">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- this is not a supported runtime framework -->
- </task-assemblies>
- <tool-paths>
- <directory name="${path::combine(sdkInstallRoot, 'v1.0.5000\bin')}" />
- <directory name="${path::combine(installRoot, 'v1.1.4322')}" />
- <directory name="${path::combine(sdkInstallRoot.DesktopFramework, 'bin')}" />
- </tool-paths>
- <project>
- <readregistry
- property="installRoot"
- key="SOFTWARE\Microsoft\.NETFramework\InstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot"
- key="SOFTWARE\Microsoft\.NETCompactFramework\sdkInstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot.DesktopFramework"
- key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRootv1.1"
- hive="LocalMachine" />
- <fail if="${not directory::exists(sdkInstallRoot.DesktopFramework)}">The .NET Framework 1.1 SDK is not installed.</fail>
- </project>
- <tasks>
- <task name="csc">
- <attribute name="noconfig">true</attribute>
- <attribute name="nostdlib">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="exename">cfresgen</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="exename">lc</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="netcf-2.0"
- family="netcf"
- version="2.0"
- description="Microsoft .NET Compact Framework 2.0"
- sdkdirectory="${path::combine(sdkInstallRoot.DesktopFramework, 'bin')}"
- frameworkdirectory="${path::combine(installRoot, 'v2.0.50727')}"
- frameworkassemblydirectory="${path::combine(sdkInstallRoot, 'WindowsCE')}"
- clrversion="2.0.0"
- >
- <runtime>
- <modes>
- <strict>
- <environment>
- <variable name="COMPLUS_VERSION" value="v2.0.50727" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(sdkInstallRoot, 'WindowsCE')}">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- this is not a supported runtime framework -->
- </task-assemblies>
- <tool-paths>
- <directory name="${path::combine(sdkInstallRoot.DesktopFramework, 'bin')}" />
- </tool-paths>
- <project>
- <readregistry
- property="installRoot"
- key="SOFTWARE\Microsoft\.NETFramework\InstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot"
- key="SOFTWARE\Microsoft\.NETCompactFramework\v2.0.0.0\InstallRoot\"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot.DesktopFramework"
- key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRootv2.0"
- hive="LocalMachine" />
- <fail if="${not directory::exists(sdkInstallRoot.DesktopFramework)}">The .NET Framework 2.0 SDK is not installed.</fail>
- </project>
- <tasks>
- <task name="csc">
- <attribute name="noconfig">true</attribute>
- <attribute name="nostdlib">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportswarnaserrorlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportsplatform">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="vbc">
- <attribute name="nostdlib">true</attribute>
- <attribute name="supportsdocgeneration">true</attribute>
- <attribute name="supportsnostdlib">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportsplatform">true</attribute>
- <attribute name="supportswarnaserrorlist">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="supportsassemblyreferences">true</attribute>
- <attribute name="supportsexternalfilereferences">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="exename">lc</attribute>
- <attribute name="supportsassemblyreferences">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="silverlight-2.0"
- family="silverlight"
- version="2.0"
- description="Microsoft Silverlight 2.0"
- sdkdirectory="${path::combine(sdkInstallRoot, 'bin')}"
- frameworkdirectory="${path::combine(installRoot, 'v2.0.50727')}"
- frameworkassemblydirectory="${environment::get-folder-path('ProgramFiles')}/Microsoft Silverlight"
- clrversion="2.0.50727"
- >
- <runtime>
- <modes>
- <strict>
- <environment>
- <variable name="COMPLUS_VERSION" value="v2.0.50727" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${environment::get-folder-path('ProgramFiles')}/Microsoft Silverlight">
- <include name="agclr.dll" />
- <include name="Microsoft.VisualBasic.dll" />
- <include name="mscorlib.dll" />
- <include name="System.Core.dll" />
- <include name="System.dll" />
- <include name="System.Silverlight.dll" />
- <include name="System.Xml.Core.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include MS.NET version-neutral assemblies -->
- <include name="extensions/net/neutral/**/*.dll" />
- <!-- include MS.NET 2.0 specific assemblies -->
- <include name="extensions/net/2.0/**/*.dll" />
- <!-- include MS.NET specific task assembly -->
- <include name="NAnt.MSNetTasks.dll" />
- <!-- include MS.NET specific test assembly -->
- <include name="NAnt.MSNet.Tests.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${path::combine(sdkInstallRoot, 'bin')}" />
- <directory name="${path::combine(installRoot, 'v2.0.50727')}" />
- <directory name="${environment::get-folder-path('ProgramFiles')}/Microsoft Silverlight" />
- </tool-paths>
- <project>
- <readregistry
- property="installRoot"
- key="SOFTWARE\Microsoft\.NETFramework\InstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="sdkInstallRoot"
- key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRootv2.0"
- hive="LocalMachine"
- failonerror="false" />
- </project>
- <tasks>
- <task name="csc">
- <attribute name="noconfig">true</attribute>
- <attribute name="nostdlib">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportswarnaserrorlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportsplatform">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="vbc">
- <attribute name="nostdlib">true</attribute>
- <attribute name="supportsdocgeneration">true</attribute>
- <attribute name="supportsnostdlib">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportsplatform">true</attribute>
- <attribute name="supportswarnaserrorlist">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="supportsplatform">true</attribute>
- </task>
- <task name="vjc">
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="supportsassemblyreferences">true</attribute>
- <attribute name="supportsexternalfilereferences">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="exename">lc</attribute>
- <attribute name="supportsassemblyreferences">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="mono-1.0"
- family="mono"
- version="1.0"
- description="Mono 1.0 Profile"
- sdkdirectory="${toolDirectory}"
- frameworkdirectory="${toolDirectory}"
- frameworkassemblydirectory="${path::combine(frameworkAssemblyDirectory, 'mono/1.0')}"
- clrversion="1.1.4322"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/mono/1.0" />
- <directory name="lib/mono/neutral" />
- <directory name="lib/common/1.1" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <auto>
- <engine program="${runtimeEngine}" />
- <environment>
- <variable name="PATH" path="${path::combine(sdkInstallRoot, 'bin')};%PATH%" />
- <variable name="MONO_CFG_DIR" path="${configDir};%MONO_CFG_DIR%" />
- </environment>
- </auto>
- <strict>
- <engine program="${runtimeEngine}">
- <arg value="--runtime=v1.1.4322" />
- </engine>
- <environment>
- <variable name="PATH" path="${path::combine(sdkInstallRoot, 'bin')};%PATH%" />
- <variable name="MONO_CFG_DIR" path="${configDir};%MONO_CFG_DIR%" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(frameworkAssemblyDirectory, 'mono/1.0')}">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include Mono version-neutral assemblies -->
- <include name="extensions/mono/neutral/**/*.dll" />
- <!-- include Mono 1.0 specific assemblies -->
- <include name="extensions/mono/1.0/**/*.dll" />
- <!-- include .NET 1.1 specific assemblies -->
- <include name="extensions/common/1.1/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${toolDirectory}" />
- </tool-paths>
- <project>
- <!-- quick and dirty check to see if pkg-config is available (and configured) -->
- <property name="pkgconfig.available" value="${environment::variable-exists('PKG_CONFIG_PATH')}" />
- <if test="${pkgconfig.available}">
- <if test="${pkg-config::exists('mono')}">
- <call target="configure-from-pkg-config" />
- </if>
- <if test="${not pkg-config::exists('mono')}">
- <call target="configure-from-registry" />
- </if>
- </if>
- <if test="${not pkgconfig.available}">
- <call target="configure-from-registry" />
- </if>
-
- <!-- determine if we're dealing with a Mono 1.0.x release -->
- <if test="${version::parse(mono.version) < version::parse('1.1')}">
- <!--
- in Mono 1.0.x, the framework tools are located
- in the <install root>\lib directory
- -->
- <property name="toolDirectory" value="${frameworkAssemblyDirectory}" />
- <property name="runtimeEngine" value="${path::combine(frameworkAssemblyDirectory, 'mono.exe')}" />
- <property name="resgen.tool" value="monoresgen" />
- <!-- in Mono 1.0.x, only mcs and mbas are located in <install root>\lib\mono\<profile> -->
- <property name="csc.tool" value="${path::combine(frameworkAssemblyDirectory, 'mono/1.0/mcs.exe')}" />
- <property name="mbas.tool" value="${path::combine(frameworkAssemblyDirectory, 'mono/1.0/mbas.exe')}" />
- <!-- /doc is not supported in Mono 1.0.x -->
- <property name="csc.supportsdocgeneration" value="false" />
-
- <!--
- Mono 1.0.1 installer incorrectly adds '\mono' to
- "MonoConfigDir" registry value
- -->
- <if test="${string::ends-with(configDir, 'etc\mono')}">
- <property name="configDir" value="${string::replace(configDir, 'etc\mono', 'etc')}" />
- </if>
- </if>
-
- <!-- determine if we're dealing with a Mono 1.1.x release or higher -->
- <if test="${version::parse(mono.version) >= version::parse('1.1')}">
- <!--
- in Mono 1.1.x (and higher ?), the framework tools
- are located in the <install root>\lib\mono\<profile>
- directory
- -->
- <property name="toolDirectory" value="${path::combine(frameworkAssemblyDirectory, 'mono/1.0')}" />
- <property name="runtimeEngine" value="${path::combine(frameworkAssemblyDirectory, 'mono.exe')}" />
- <!-- starting from Mono 1.1.9.2, mono.exe is located in the bin directory -->
- <if test="${not file::exists(runtimeEngine)}">
- <property name="runtimeEngine" value="${path::combine(sdkInstallRoot, 'bin/mono.exe')}" />
- </if>
- <property name="resgen.tool" value="resgen" />
- <property name="csc.tool" value="mcs" />
- <property name="csc.supportsdocgeneration" value="true" />
- <property name="mbas.tool" value="mbas" />
- </if>
-
- <target name="configure-from-pkg-config">
- <property name="mono.version" value="${pkg-config::get-mod-version('mono')}" />
- <property name="sdkInstallRoot" value="${cygpath::get-windows-path(pkg-config::get-variable('mono', 'prefix'))}" />
- <property name="frameworkAssemblyDirectory" value="${cygpath::get-windows-path(pkg-config::get-variable('mono', 'libdir'))}" />
- <property name="configDir" value="${path::combine(sdkInstallRoot, 'etc')}/" />
- </target>
-
- <target name="configure-from-registry">
- <!--
- first try using the DefaultCLR in HKLM\Novell\Mono,
- this is used by the Mono 1.0.1 installer (and later?)
- -->
- <readregistry
- property="mono.version"
- key="SOFTWARE\Novell\Mono\DefaultCLR"
- hive="LocalMachine"
- failonerror="false"
- />
-
- <if test="${property::exists('mono.version')}">
- <property name="monokey" value="SOFTWARE\Novell\Mono\${mono.version}" />
- </if>
-
- <!--
- if the DefaultCLR registry value does not exist in
- HKLM\Novell\Mono, then try the HKML\Mono registry
- key as this was used for the Mono 1.0 installer
- -->
- <if test="${not property::exists('mono.version')}">
- <readregistry
- property="mono.version"
- key="SOFTWARE\Mono\DefaultCLR"
- hive="LocalMachine"
- />
- <property name="monokey" value="SOFTWARE\Mono\${mono.version}" />
- </if>
-
- <readregistry
- property="sdkInstallRoot"
- key="${monokey}\SdkInstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="frameworkAssemblyDirectory"
- key="${monokey}\FrameworkAssemblyDirectory"
- hive="LocalMachine" />
- <readregistry
- property="configDir"
- key="${monokey}\MonoConfigDir"
- hive="LocalMachine" />
- </target>
- </project>
- <properties>
- </properties>
- <tasks>
- <task name="al">
- <attribute name="managed">true</attribute>
- </task>
- <task name="csc">
- <attribute name="exename">${csc.tool}</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="supportspackagereferences">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportsdocgeneration">${csc.supportsdocgeneration}</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="exename">mjs</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="vbc">
- <attribute name="exename">${mbas.tool}</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="exename">${resgen.tool}</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- <task name="ilasm">
- <attribute name="managed">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="mono-2.0"
- family="mono"
- version="2.0"
- description="Mono 2.0 Profile"
- sdkdirectory="${toolDirectory}"
- frameworkdirectory="${toolDirectory}"
- frameworkassemblydirectory="${path::combine(frameworkAssemblyDirectory, 'mono/2.0')}"
- clrversion="2.0.50727"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/mono/2.0" />
- <directory name="lib/mono/neutral" />
- <directory name="lib/common/2.0" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <auto>
- <engine program="${runtimeEngine}" />
- <environment>
- <variable name="PATH" path="${path::combine(sdkInstallRoot, 'bin')};%PATH%" />
- <variable name="MONO_CFG_DIR" path="${configDir};%MONO_CFG_DIR%" />
- </environment>
- </auto>
- <strict>
- <engine program="${runtimeEngine}">
- <arg value="--runtime=v2.0.50727" />
- </engine>
- <environment>
- <variable name="PATH" path="${path::combine(sdkInstallRoot, 'bin')};%PATH%" />
- <variable name="MONO_CFG_DIR" path="${configDir};%MONO_CFG_DIR%" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(frameworkAssemblyDirectory, 'mono/2.0')}">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include Mono version-neutral assemblies -->
- <include name="extensions/mono/neutral/**/*.dll" />
- <!-- include Mono 2.0 specific assemblies -->
- <include name="extensions/mono/2.0/**/*.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${toolDirectory}" />
- <directory name="${path::combine(frameworkAssemblyDirectory, 'mono/1.0')}" />
- <!-- for compatibility with Mono 1.0.x -->
- <directory name="${frameworkAssemblyDirectory}" />
- </tool-paths>
- <project>
- <!-- quick and dirty check to see if pkg-config is available (and configured) -->
- <property name="pkgconfig.available" value="${environment::variable-exists('PKG_CONFIG_PATH')}" />
- <if test="${pkgconfig.available}">
- <if test="${pkg-config::exists('mono')}">
- <call target="configure-from-pkg-config" />
- </if>
- <if test="${not pkg-config::exists('mono')}">
- <call target="configure-from-registry" />
- </if>
- </if>
- <if test="${not pkgconfig.available}">
- <call target="configure-from-registry" />
- </if>
-
- <property name="resgen.supportsexternalfilereferences" value="false" />
-
- <!-- determine if we're dealing with a Mono 1.0.x release -->
- <if test="${version::parse(mono.version) < version::parse('1.1')}">
- <!--
- in Mono 1.0.x, the framework tools are located
- in the <install root>\lib directory, except for
- mbas and mcs
- -->
- <property name="toolDirectory" value="${frameworkAssemblyDirectory}" />
- <property name="runtimeEngine" value="${path::combine(frameworkAssemblyDirectory, 'mono.exe')}" />
- <property name="resgen.tool" value="monoresgen" />
- <property name="csc.supportsdocgeneration" value="false" />
-
- <!--
- Mono 1.0.1 installer incorrectly adds '\mono' to
- "MonoConfigDir" registry value
- -->
- <if test="${string::ends-with(configDir, 'etc\mono')}">
- <property name="configDir" value="${string::replace(configDir, 'etc\mono', 'etc')}" />
- </if>
- </if>
-
- <!-- determine if we're dealing with a Mono 1.1.x release or higher -->
- <if test="${version::parse(mono.version) >= version::parse('1.1')}">
- <property name="toolDirectory" value="${path::combine(frameworkAssemblyDirectory, 'mono/2.0')}" />
- <property name="runtimeEngine" value="${path::combine(frameworkAssemblyDirectory, 'mono.exe')}" />
- <!-- starting from Mono 1.1.9.2, mono.exe is located in the bin directory -->
- <if test="${not file::exists(runtimeEngine)}">
- <property name="runtimeEngine" value="${path::combine(sdkInstallRoot, 'bin/mono.exe')}" />
- </if>
- <property name="csc.supportsdocgeneration" value="true" />
- </if>
- <!-- as from Mono 1.2.3.50, resgen supports the /usesourcepath option -->
- <if test="${version::parse(mono.version) >= version::parse('1.2.3.50')}">
- <property name="resgen.supportsexternalfilereferences" value="true" />
- </if>
-
- <target name="configure-from-pkg-config">
- <property name="mono.version" value="${pkg-config::get-mod-version('mono')}" />
- <property name="sdkInstallRoot" value="${cygpath::get-windows-path(pkg-config::get-variable('mono', 'prefix'))}" />
- <property name="frameworkAssemblyDirectory" value="${cygpath::get-windows-path(pkg-config::get-variable('mono', 'libdir'))}" />
- <property name="configDir" value="${path::combine(sdkInstallRoot, 'etc')}/" />
- </target>
-
- <target name="configure-from-registry">
- <readregistry
- property="mono.version"
- key="SOFTWARE\Novell\Mono\DefaultCLR"
- hive="LocalMachine"
- />
- <property name="monokey" value="SOFTWARE\Novell\Mono\${mono.version}" />
-
- <readregistry
- property="sdkInstallRoot"
- key="${monokey}\SdkInstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="frameworkAssemblyDirectory"
- key="${monokey}\FrameworkAssemblyDirectory"
- hive="LocalMachine" />
- <readregistry
- property="configDir"
- key="${monokey}\MonoConfigDir"
- hive="LocalMachine" />
- </target>
- </project>
- <properties>
- </properties>
- <tasks>
- <task name="al">
- <attribute name="managed">true</attribute>
- </task>
- <task name="csc">
- <attribute name="exename">gmcs</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="supportspackagereferences">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportsdocgeneration">${csc.supportsdocgeneration}</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="exename">mjs</attribute>
- <attribute name="managed">strict</attribute>
- </task>
- <task name="vbc">
- <attribute name="exename">vbnc}</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="exename">${resgen.tool}</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="supportsexternalfilereferences">${resgen.supportsexternalfilereferences}</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- <task name="ilasm">
- <attribute name="managed">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="mono-3.5"
- family="mono"
- version="3.5"
- description="Mono 3.5 Profile"
- sdkdirectory="${toolDirectory}"
- frameworkdirectory="${toolDirectory}"
- frameworkassemblydirectory="${path::combine(frameworkAssemblyDirectory, 'mono/2.0')}"
- clrversion="2.0.50727"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/mono/2.0" />
- <directory name="lib/mono/neutral" />
- <directory name="lib/common/2.0" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <auto>
- <engine program="${runtimeEngine}" />
- <environment>
- <variable name="PATH" path="${path::combine(sdkInstallRoot, 'bin')};%PATH%" />
- <variable name="MONO_CFG_DIR" path="${configDir};%MONO_CFG_DIR%" />
- </environment>
- </auto>
- <strict>
- <engine program="${runtimeEngine}">
- <arg value="--runtime=v2.0.50727" />
- </engine>
- <environment>
- <variable name="PATH" path="${path::combine(sdkInstallRoot, 'bin')};%PATH%" />
- <variable name="MONO_CFG_DIR" path="${configDir};%MONO_CFG_DIR%" />
- </environment>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(frameworkAssemblyDirectory, 'mono/3.5')}">
- <include name="*.dll" />
- </reference-assemblies>
- <reference-assemblies basedir="${path::combine(frameworkAssemblyDirectory, 'mono/3.0')}">
- <include name="*.dll" />
- </reference-assemblies>
- <reference-assemblies basedir="${path::combine(frameworkAssemblyDirectory, 'mono/2.0')}">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include Mono version-neutral assemblies -->
- <include name="extensions/mono/neutral/**/*.dll" />
- <!-- include Mono 2.0 specific assemblies -->
- <include name="extensions/mono/2.0/**/*.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${path::combine(frameworkAssemblyDirectory, 'mono/3.5')}" />
- <directory name="${path::combine(frameworkAssemblyDirectory, 'mono/2.0')}" />
- <directory name="${path::combine(frameworkAssemblyDirectory, 'mono/1.0')}" />
- </tool-paths>
- <project>
- <!-- quick and dirty check to see if pkg-config is available (and configured) -->
- <property name="pkgconfig.available" value="${environment::variable-exists('PKG_CONFIG_PATH')}" />
- <if test="${pkgconfig.available}">
- <if test="${pkg-config::exists('mono')}">
- <call target="configure-from-pkg-config" />
- </if>
- <if test="${not pkg-config::exists('mono')}">
- <call target="configure-from-registry" />
- </if>
- </if>
- <if test="${not pkgconfig.available}">
- <call target="configure-from-registry" />
- </if>
-
- <property name="toolDirectory" value="${path::combine(frameworkAssemblyDirectory, 'mono/3.5')}" />
- <property name="runtimeEngine" value="${path::combine(sdkInstallRoot, 'bin/mono.exe')}" />
-
- <target name="configure-from-pkg-config">
- <property name="mono.version" value="${pkg-config::get-mod-version('mono')}" />
- <property name="sdkInstallRoot" value="${cygpath::get-windows-path(pkg-config::get-variable('mono', 'prefix'))}" />
- <property name="frameworkAssemblyDirectory" value="${cygpath::get-windows-path(pkg-config::get-variable('mono', 'libdir'))}" />
- <property name="configDir" value="${path::combine(sdkInstallRoot, 'etc')}/" />
- </target>
-
- <target name="configure-from-registry">
- <readregistry
- property="mono.version"
- key="SOFTWARE\Novell\Mono\DefaultCLR"
- hive="LocalMachine"
- />
- <property name="monokey" value="SOFTWARE\Novell\Mono\${mono.version}" />
-
- <readregistry
- property="sdkInstallRoot"
- key="${monokey}\SdkInstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="frameworkAssemblyDirectory"
- key="${monokey}\FrameworkAssemblyDirectory"
- hive="LocalMachine" />
- <readregistry
- property="configDir"
- key="${monokey}\MonoConfigDir"
- hive="LocalMachine" />
- </target>
- </project>
- <properties>
- </properties>
- <tasks>
- <task name="al">
- <attribute name="managed">true</attribute>
- </task>
- <task name="csc">
- <attribute name="exename">gmcs</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="langversion">linq</attribute>
- <attribute name="supportspackagereferences">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportsdocgeneration">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="exename">mjs</attribute>
- <attribute name="managed">strict</attribute>
- </task>
- <task name="vbc">
- <attribute name="exename">vbnc</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="managed">true</attribute>
- <attribute name="supportsexternalfilereferences">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- <task name="ilasm">
- <attribute name="managed">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="moonlight-2.0"
- family="moonlight"
- version="2.0"
- description="Moonlight 2.0"
- sdkdirectory="${toolDirectory}"
- frameworkdirectory="${toolDirectory}"
- frameworkassemblydirectory="${toolDirectory}"
- clrversion="2.0.50727"
- >
- <runtime>
- <modes>
- <auto>
- <engine program="${runtimeEngine}">
- <arg value="--runtime=moonlight" />
- <arg value="--security=temporary-smcs-hack" />
- </engine>
- </auto>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(prefix, 'lib/mono/2.1')}">
- <include name="agclr.dll" />
- <include name="Microsoft.VisualBasic.dll" />
- <include name="mscorlib.dll" />
- <include name="System.Core.dll" />
- <include name="System.dll" />
- <include name="System.Silverlight.dll" />
- <include name="System.Xml.Core.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include MS.NET version-neutral assemblies -->
- <include name="extensions/net/neutral/**/*.dll" />
- <!-- include MS.NET 2.0 specific assemblies -->
- <include name="extensions/net/2.0/**/*.dll" />
- <!-- include MS.NET specific task assembly -->
- <include name="NAnt.MSNetTasks.dll" />
- <!-- include MS.NET specific test assembly -->
- <include name="NAnt.MSNet.Tests.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${toolDirectory}" />
- <directory name="${path::combine(frameworkAssemblyDirectory, 'mono/2.0')}" />
- <directory name="${path::combine(frameworkAssemblyDirectory, 'mono/1.0')}" />
- </tool-paths>
- <project>
- <!-- quick and dirty check to see if pkg-config is available (and configured) -->
- <property name="pkgconfig.available" value="${environment::variable-exists('PKG_CONFIG_PATH')}" />
- <if test="${pkgconfig.available}">
- <if test="${pkg-config::exists('mono')}">
- <call target="configure-from-pkg-config" />
- </if>
- <if test="${not pkg-config::exists('mono')}">
- <call target="configure-from-registry" />
- </if>
- </if>
- <if test="${not pkgconfig.available}">
- <call target="configure-from-registry" />
- </if>
-
- <property name="toolDirectory" value="${path::combine(frameworkAssemblyDirectory, 'mono/2.1')}" />
- <property name="runtimeEngine" value="${path::combine(sdkInstallRoot, 'bin/mono.exe')}" />
-
- <target name="configure-from-pkg-config">
- <property name="mono.version" value="${pkg-config::get-mod-version('mono')}" />
- <property name="sdkInstallRoot" value="${cygpath::get-windows-path(pkg-config::get-variable('mono', 'prefix'))}" />
- <property name="frameworkAssemblyDirectory" value="${cygpath::get-windows-path(pkg-config::get-variable('mono', 'libdir'))}" />
- <property name="configDir" value="${path::combine(sdkInstallRoot, 'etc')}/" />
- </target>
-
- <target name="configure-from-registry">
- <readregistry
- property="mono.version"
- key="SOFTWARE\Novell\Mono\DefaultCLR"
- hive="LocalMachine"
- />
- <property name="monokey" value="SOFTWARE\Novell\Mono\${mono.version}" />
-
- <readregistry
- property="sdkInstallRoot"
- key="${monokey}\SdkInstallRoot"
- hive="LocalMachine" />
- <readregistry
- property="frameworkAssemblyDirectory"
- key="${monokey}\FrameworkAssemblyDirectory"
- hive="LocalMachine" />
- <readregistry
- property="configDir"
- key="${monokey}\MonoConfigDir"
- hive="LocalMachine" />
- </target>
- </project>
- <tasks>
- <task name="csc">
- <attribute name="exename">smcs</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="supportspackagereferences">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportsdocgeneration">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="supportsassemblyreferences">true</attribute>
- <attribute name="supportsexternalfilereferences">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="sscli-1.0"
- family="sscli"
- version="1.0"
- description="Microsoft Shared Source CLI 1.0"
- sdkdirectory="C:\sscli\build\v1.x86fstchk.rotor\sdk\bin"
- frameworkdirectory="C:\sscli\build\v1.x86fstchk.rotor"
- frameworkassemblydirectory="C:\sscli\build\v1.x86fstchk.rotor"
- clrversion="1.0.3"
- >
- <runtime>
- <modes>
- <auto>
- <engine program="C:\sscli\build\v1.x86fstchk.rotor\clix.exe" />
- </auto>
- </modes>
- </runtime>
- <reference-assemblies basedir="C:\sscli\build\v1.x86fstchk.rotor">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- this is not a supported runtime framework -->
- </task-assemblies>
- <tool-paths>
- <directory name="C:\sscli\build\v1.x86fstchk.rotor\sdk\bin" />
- <directory name="C:\sscli\build\v1.x86fstchk.rotor" />
- </tool-paths>
- <project />
- <tasks>
- <task name="csc">
- <attribute name="supportsnowarnlist">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="managed">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- <task name="ilasm">
- <attribute name="managed">true</attribute>
- </task>
- <task name="ildasm">
- <attribute name="managed">true</attribute>
- </task>
- </tasks>
- </framework>
- </platform>
- <platform name="unix" default="auto">
- <task-assemblies>
- <!-- include NAnt task assemblies -->
- <include name="*Tasks.dll" />
- <!-- include NAnt test assemblies -->
- <include name="*Tests.dll" />
- <!-- include framework-neutral assemblies -->
- <include name="extensions/common/neutral/**/*.dll" />
- <!-- exclude Microsoft.NET specific task assembly -->
- <exclude name="NAnt.MSNetTasks.dll" />
- <!-- exclude Microsoft.NET specific test assembly -->
- <exclude name="NAnt.MSNet.Tests.dll" />
- <!-- exclude win32 specific task assembly -->
- <exclude name="NAnt.Win32Tasks.dll" />
- <!-- exclude win32 specific test assembly -->
- <exclude name="NAnt.Win32.Tests.dll" />
- </task-assemblies>
- <framework
- name="mono-1.0"
- family="mono"
- version="1.0"
- description="Mono 1.0 Profile"
- sdkdirectory="${toolDirectory}"
- frameworkdirectory="${toolDirectory}"
- frameworkassemblydirectory="${path::combine(prefix, 'lib/mono/1.0')}"
- clrversion="1.1.4322"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/mono/1.0" />
- <directory name="lib/mono/neutral" />
- <directory name="lib/common/1.1" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <auto>
- <engine program="${path::combine(prefix, 'bin/mono')}" />
- </auto>
- <strict>
- <engine program="${path::combine(prefix, 'bin/mono')}">
- <arg value="--runtime=v1.1.4322" />
- </engine>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(prefix, 'lib/mono/1.0')}">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include Mono version-neutral assemblies -->
- <include name="extensions/mono/neutral/**/*.dll" />
- <!-- include Mono 1.0 specific assemblies -->
- <include name="extensions/mono/1.0/**/*.dll" />
- <!-- include .NET 1.1 specific assemblies -->
- <include name="extensions/common/1.1/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${toolDirectory}" />
- </tool-paths>
- <project>
- <if test="${not pkg-config::exists('mono')}">
- <fail>Unable to locate 'mono' module using pkg-config. Download the Mono development packages from http://www.mono-project.com/downloads/.</fail>
- </if>
- <property name="prefix" value="${pkg-config::get-variable('mono', 'prefix')}" />
- <if test="${not(pkg-config::is-atleast-version('mono', '1.1'))}">
- <property name="toolDirectory" value="${path::combine(prefix, 'bin')}" />
- <property name="resgen.tool" value="monoresgen" />
- <property name="csc.supportsdocgeneration" value="false" />
- </if>
- <if test="${pkg-config::is-atleast-version('mono', '1.1')}">
- <property name="toolDirectory" value="${path::combine(prefix, 'lib/mono/1.0')}" />
- <property name="resgen.tool" value="resgen" />
- <property name="csc.supportsdocgeneration" value="true" />
- </if>
- </project>
- <tasks>
- <task name="al">
- <attribute name="managed">true</attribute>
- </task>
- <task name="csc">
- <attribute name="exename">${path::combine(prefix, 'lib/mono/1.0/mcs.exe')}</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="supportspackagereferences">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportsdocgeneration">${csc.supportsdocgeneration}</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="exename">mjs</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="vbc">
- <attribute name="exename">${path::combine(prefix, 'lib/mono/1.0/mbas.exe')}</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="exename">${resgen.tool}</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- <task name="ilasm">
- <attribute name="managed">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="mono-2.0"
- family="mono"
- version="2.0"
- description="Mono 2.0 Profile"
- sdkdirectory="${toolDirectory}"
- frameworkdirectory="${toolDirectory}"
- frameworkassemblydirectory="${path::combine(prefix, 'lib/mono/2.0')}"
- clrversion="2.0.50727"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/mono/2.0" />
- <directory name="lib/mono/neutral" />
- <directory name="lib/common/2.0" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <auto>
- <engine program="${path::combine(prefix, 'bin/mono')}" />
- </auto>
- <strict>
- <engine program="${path::combine(prefix, 'bin/mono')}">
- <arg value="--runtime=v2.0.50727" />
- </engine>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(prefix, 'lib/mono/2.0')}">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include Mono version-neutral assemblies -->
- <include name="extensions/mono/neutral/**/*.dll" />
- <!-- include Mono 2.0 specific assemblies -->
- <include name="extensions/mono/2.0/**/*.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${toolDirectory}" />
- <directory name="${path::combine(prefix, 'lib/mono/1.0')}" />
- </tool-paths>
- <project>
- <if test="${not pkg-config::exists('mono')}">
- <fail>Unable to locate 'mono' module using pkg-config. Download the Mono development packages from http://www.mono-project.com/downloads/.</fail>
- </if>
- <property name="resgen.supportsexternalfilereferences" value="false" />
- <property name="prefix" value="${pkg-config::get-variable('mono', 'prefix')}" />
- <if test="${not(pkg-config::is-atleast-version('mono', '1.1'))}">
- <property name="toolDirectory" value="${path::combine(prefix, 'bin')}" />
- <property name="resgen.tool" value="monoresgen" />
- <property name="csc.supportsdocgeneration" value="false" />
- </if>
- <if test="${pkg-config::is-atleast-version('mono', '1.1')}">
- <property name="toolDirectory" value="${path::combine(prefix, 'lib/mono/2.0')}" />
- <property name="resgen.tool" value="resgen" />
- <property name="csc.supportsdocgeneration" value="true" />
- </if>
- <!-- as from Mono 1.2.3.50, resgen supports the /usesourcepath option -->
- <if test="${pkg-config::is-atleast-version('mono', '1.2.3.50')}">
- <property name="resgen.supportsexternalfilereferences" value="true" />
- </if>
- </project>
- <tasks>
- <task name="al">
- <attribute name="managed">true</attribute>
- </task>
- <task name="csc">
- <attribute name="exename">gmcs</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="supportspackagereferences">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportsdocgeneration">${csc.supportsdocgeneration}</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="exename">mjs</attribute>
- <attribute name="managed">strict</attribute>
- </task>
- <task name="vbc">
- <attribute name="exename">vbnc</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="exename">${resgen.tool}</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="supportsexternalfilereferences">${resgen.supportsexternalfilereferences}</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- <task name="ilasm">
- <attribute name="managed">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="mono-3.5"
- family="mono"
- version="3.5"
- description="Mono 3.5 Profile"
- sdkdirectory="${toolDirectory}"
- frameworkdirectory="${toolDirectory}"
- frameworkassemblydirectory="${path::combine(prefix, 'lib/mono/2.0')}"
- clrversion="2.0.50727"
- >
- <runtime>
- <probing-paths>
- <directory name="lib/mono/2.0" />
- <directory name="lib/mono/neutral" />
- <directory name="lib/common/2.0" />
- <directory name="lib/common/neutral" />
- </probing-paths>
- <modes>
- <auto>
- <engine program="${path::combine(prefix, 'bin/mono')}" />
- </auto>
- <strict>
- <engine program="${path::combine(prefix, 'bin/mono')}">
- <arg value="--runtime=v2.0.50727" />
- </engine>
- </strict>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(prefix, 'lib/mono/3.5')}">
- <include name="*.dll" />
- </reference-assemblies>
- <reference-assemblies basedir="${path::combine(prefix, 'lib/mono/3.0')}">
- <include name="*.dll" />
- </reference-assemblies>
- <reference-assemblies basedir="${path::combine(prefix, 'lib/mono/2.0')}">
- <include name="*.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include Mono version-neutral assemblies -->
- <include name="extensions/mono/neutral/**/*.dll" />
- <!-- include Mono 2.0 specific assemblies -->
- <include name="extensions/mono/2.0/**/*.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${toolDirectory}" />
- <directory name="${path::combine(prefix, 'lib/mono/2.0')}" />
- <directory name="${path::combine(prefix, 'lib/mono/1.0')}" />
- </tool-paths>
- <project>
- <if test="${not pkg-config::exists('mono')}">
- <fail>Unable to locate 'mono' module using pkg-config. Download the Mono development packages from http://www.mono-project.com/downloads/.</fail>
- </if>
- <property name="resgen.supportsexternalfilereferences" value="false" />
- <property name="prefix" value="${pkg-config::get-variable('mono', 'prefix')}" />
- <property name="toolDirectory" value="${path::combine(prefix, 'lib/mono/3.5')}" />
- </project>
- <tasks>
- <task name="al">
- <attribute name="managed">true</attribute>
- </task>
- <task name="csc">
- <attribute name="exename">gmcs</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="langversion">linq</attribute>
- <attribute name="supportspackagereferences">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportsdocgeneration">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="jsc">
- <attribute name="exename">mjs</attribute>
- <attribute name="managed">strict</attribute>
- </task>
- <task name="vbc">
- <attribute name="exename">vbnc</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="managed">true</attribute>
- <attribute name="supportsexternalfilereferences">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- <attribute name="managed">true</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- <task name="ilasm">
- <attribute name="managed">true</attribute>
- </task>
- </tasks>
- </framework>
- <framework
- name="moonlight-2.0"
- family="moonlight"
- version="2.0"
- description="Moonlight 2.0"
- sdkdirectory="${toolDirectory}"
- frameworkdirectory="${toolDirectory}"
- frameworkassemblydirectory="${toolDirectory}"
- clrversion="2.0.50727"
- >
- <runtime>
- <modes>
- <auto>
- <engine program="${path::combine(prefix, 'bin/mono')}">
- <arg value="--runtime=moonlight" />
- <arg value="--security=temporary-smcs-hack" />
- </engine>
- </auto>
- </modes>
- </runtime>
- <reference-assemblies basedir="${path::combine(prefix, 'lib/mono/2.1')}">
- <include name="agclr.dll" />
- <include name="Microsoft.VisualBasic.dll" />
- <include name="mscorlib.dll" />
- <include name="System.Core.dll" />
- <include name="System.dll" />
- <include name="System.Silverlight.dll" />
- <include name="System.Xml.Core.dll" />
- </reference-assemblies>
- <task-assemblies>
- <!-- include MS.NET version-neutral assemblies -->
- <include name="extensions/net/neutral/**/*.dll" />
- <!-- include MS.NET 2.0 specific assemblies -->
- <include name="extensions/net/2.0/**/*.dll" />
- <!-- include MS.NET specific task assembly -->
- <include name="NAnt.MSNetTasks.dll" />
- <!-- include MS.NET specific test assembly -->
- <include name="NAnt.MSNet.Tests.dll" />
- <!-- include .NET 2.0 specific assemblies -->
- <include name="extensions/common/2.0/**/*.dll" />
- </task-assemblies>
- <tool-paths>
- <directory name="${toolDirectory}" />
- <directory name="${path::combine(prefix, 'lib/mono/2.0')}" />
- <directory name="${path::combine(prefix, 'lib/mono/1.0')}" />
- </tool-paths>
- <project>
- <if test="${not pkg-config::exists('mono')}">
- <fail>Unable to locate 'mono' module using pkg-config. Download the Mono development packages from http://www.mono-project.com/downloads/.</fail>
- </if>
- <property name="prefix" value="${pkg-config::get-variable('mono', 'prefix')}" />
- <property name="toolDirectory" value="${path::combine(prefix, 'lib/mono/2.1')}" />
- </project>
- <tasks>
- <task name="csc">
- <attribute name="exename">smcs</attribute>
- <attribute name="managed">true</attribute>
- <attribute name="supportspackagereferences">true</attribute>
- <attribute name="supportsnowarnlist">true</attribute>
- <attribute name="supportsdocgeneration">true</attribute>
- <attribute name="supportskeycontainer">true</attribute>
- <attribute name="supportskeyfile">true</attribute>
- <attribute name="supportsdelaysign">true</attribute>
- <attribute name="supportslangversion">true</attribute>
- </task>
- <task name="resgen">
- <attribute name="supportsassemblyreferences">true</attribute>
- <attribute name="supportsexternalfilereferences">true</attribute>
- </task>
- <task name="delay-sign">
- <attribute name="exename">sn</attribute>
- </task>
- <task name="license">
- <attribute name="hascommandlinecompiler">false</attribute>
- </task>
- </tasks>
- </framework>
- </platform>
- </frameworks>
- <properties>
- <!-- properties defined here are accessible to all build files -->
- <!-- <property name="foo" value = "bar" readonly="false" /> -->
- </properties>
- </nant>
- <!--
- This section contains the log4net configuration settings.
-
- By default, no messages will be logged to the log4net logging infrastructure.
-
- To enable the internal logging, set the threshold attribute on the log4net element
- to "ALL".
-
- When internal logging is enabled, internal messages will be written to the
- console.
- -->
- <log4net threshold="OFF">
- <appender name="ConsoleAppender" type="log4net.Appender.ConsoleAppender">
- <layout type="log4net.Layout.PatternLayout">
- <param name="ConversionPattern" value="[%c{2}:%m - [%x] <%X{auth}>]%n" />
- </layout>
- </appender>
- <appender name="RollingLogFileAppender" type="log4net.Appender.RollingFileAppender">
- <param name="File" value="${APPDATA}\\NAnt\\NAnt.log" />
- <param name="AppendToFile" value="true" />
- <param name="MaxSizeRollBackups" value="2" />
- <param name="MaximumFileSize" value="500KB" />
- <param name="RollingStyle" value="Size" />
- <param name="StaticLogFileName" value="true" />
- <layout type="log4net.Layout.PatternLayout">
- <param name="ConversionPattern" value="[%c{2}:%m - [%x] <%X{auth}>]%n" />
- </layout>
- </appender>
- <!-- Setup the root category, add the appenders and set the default level -->
- <root>
- <!-- Only log messages with severity ERROR (or higher) -->
- <level value="ERROR" />
- <!-- Log messages to the console -->
- <appender-ref ref="ConsoleAppender" />
- <!-- Uncomment the next line to enable logging messages to the NAnt.log file -->
- <!-- <appender-ref ref="RollingLogFileAppender" /> -->
- </root>
- <!-- Specify the priority for some specific categories -->
- <!--
- <logger name="NAnt.Core.TaskBuilderCollection">
- <level value="DEBUG" />
- </logger>
- <logger name="NAnt">
- <level value="INFO" />
- </logger>
- -->
- </log4net>
- <runtime>
- <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
- <probing privatePath="lib" />
- </assemblyBinding>
- </runtime>
- <startup>
- <!-- .NET Framework 2.0 -->
- <supportedRuntime version="v2.0.50727" />
- <!-- .NET Framework 1.1 -->
- <supportedRuntime version="v1.1.4322" />
- <!-- .NET Framework 1.0 -->
- <supportedRuntime version="v1.0.3705" />
- </startup>
-</configuration>
slips/build/tools/nant/bin/NAnt.MSNetTasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.MSNetTasks.xml
@@ -1,579 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.MSNetTasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.MSNet.Tasks.IldasmTask">
- <summary>
- Disassembles any portable executable (PE) file that contains
- intermediate language (IL) code.
- </summary>
- <remarks>
- <para>
- Files are only disassembled if the input file is newer than the output
- file, or if the output file does not exist. However, you can
- explicitly force files to be disassembled with the
- <see cref="P:NAnt.MSNet.Tasks.IldasmTask.ForceRebuild"/> attribute.
- </para>
- <para>
- A <see cref="T:NAnt.Core.Types.FileSet"/> can be used to select files to disassemble.
- To use a <see cref="T:NAnt.Core.Types.FileSet"/>, the <see cref="P:NAnt.MSNet.Tasks.IldasmTask.ToDirectory"/>
- attribute must be set. The file name of the output file will be equal
- to the file name of the input file, but with extension ".il".
- </para>
- </remarks>
- <example>
- <para>
- Disassembles <c>helloworld.exe</c> to <c>helloworld.il</c>.
- </para>
- <code>
- <![CDATA[
- <ildasm input="helloworld.exe" output="helloworld.il" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Disassembles a set of PE files into the specified directory.
- </para>
- <code>
- <![CDATA[
- <ildasm todir=".">
- <assemblies>
- <include name="*.exe" />
- <include name="*.dll" />
- </assemblies>
- </ildasm>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.MSNet.Tasks.IldasmTask.Initialize">
- <summary>
- Checks whether the task is initialized with valid attributes.
- </summary>
- </member>
- <member name="M:NAnt.MSNet.Tasks.IldasmTask.ExecuteTask">
- <summary>
- Disassembles the PE file(s).
- </summary>
- </member>
- <member name="M:NAnt.MSNet.Tasks.IldasmTask.DisassemblyFile(System.IO.FileInfo)">
- <summary>
- Disassembles the specified PE file.
- </summary>
- <param name="inputFile">The PE file to disassemble.</param>
- </member>
- <member name="M:NAnt.MSNet.Tasks.IldasmTask.GetOutputFile(System.IO.FileInfo)">
- <summary>
- Determines the full path and extension for the output file.
- </summary>
- <param name="inputFile">
- A <see cref="T:System.IO.FileInfo"/> that represents the PE file
- file for which the corresponding output file should be determined.
- </param>
- <returns>
- A <see cref="T:System.IO.FileInfo"/> that represents the full path
- for the output file.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">The path of the output file could not be determined.</exception>
- </member>
- <member name="M:NAnt.MSNet.Tasks.IldasmTask.WriteOptions(System.IO.FileInfo,System.IO.FileInfo)">
- <summary>
- Writes the disassembler options.
- </summary>
- </member>
- <member name="M:NAnt.MSNet.Tasks.IldasmTask.WriteOption(System.IO.StringWriter,System.String)">
- <summary>
- Writes an option using the default output format.
- </summary>
- <param name="writer">
- The <see cref="T:System.IO.StringWriter"/> to which the disassembler options
- should be written.
- </param>
- <param name="name">
- A <see cref="T:System.String"/> that contains the name of the
- option which should be passed to the disassembler.
- </param>
- </member>
- <member name="M:NAnt.MSNet.Tasks.IldasmTask.WriteOption(System.IO.StringWriter,System.String,System.String)">
- <summary>
- Writes an option and its value using the default output format.
- </summary>
- <param name="writer">
- The <see cref="T:System.IO.StringWriter"/> to which the disassembler options
- should be written.
- </param>
- <param name="name">
- A <see cref="T:System.String"/> that contains the name of the
- option which should be passed to the disassembler.
- </param>
- <param name="arg">
- A <see cref="T:System.String"/> that contains the value of the
- option which should be passed to the disassembler.
- </param>
- </member>
- <member name="M:NAnt.MSNet.Tasks.IldasmTask.NeedsDisassembling(System.IO.FileInfo,System.IO.FileInfo)">
- <summary>
- Determines whether or not disassembling is needed.
- </summary>
- <returns>
- <see langword="true" /> if disassembling is needed; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.All">
- <summary>
- Specifies whether or not the disassembler should combine the
- <c>/HEADER</c>, <c>/BYTE</c>, and <c>/TOKENS</c> options. The default
- is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the disassembler should combine the
- <c>/HEADER</c>, <c>/BYTE</c>, and <c>/TOKENS</c> options;
- otherwise, <see langword="false" />. The default is
- <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/ALL</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Bytes">
- <summary>
- Specifies whether or not the disassembler should generate the
- IL stream bytes (in hexadecimal notation) as instruction comments.
- The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the IL stream bytes should be generated
- as instruction comments; otherwise, <see langword="false" />. The
- default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/BYTE</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.ForceRebuild">
- <summary>
- Instructs NAnt to rebuild the output file regardless of the file
- timestamps. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the output file should be rebuilt
- regardless of its timestamps; otherwise <see langword="false" />.
- The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Header">
- <summary>
- Specifies whether or not the disassembler should include PE header
- information and runtime header information in the output. The default
- is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if PE header information and runtime header
- information should be included in the output; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/HEADER</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.InputFile">
- <summary>
- Specifies the PE file to disassemble.
- </summary>
- <value>
- A <see cref="T:System.IO.FileInfo"/> that represents the PE file
- to disassemble.
- </value>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.LineNumbers">
- <summary>
- Specifies whether or not the disassembler should include
- references to original source lines. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if references to original source lines
- should be included; otherwise, <see langword="false" />. The
- default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/LINENUM</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.NoIL">
- <summary>
- Specifies whether or not the disassembler should suppress ILASM
- code output. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if ILASM code output should be suppresses;
- otherwise, <see langword="false" />. The default is
- <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/NOIL</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.PublicOnly">
- <summary>
- Specifies whether or not the disassembler should disassemble
- public items only. This is a shortcut for <see cref="P:NAnt.MSNet.Tasks.IldasmTask.Visibility"/>="pub".
- The default is <see langword="false"/>.
- </summary>
- <value>
- <see langword="true"/> if only public items should be
- disassembled; otherwise, <see langword="false"/>. The default is
- <see langword="false"/>.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/PUBONLY</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.QuoteAllNames">
- <summary>
- 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
- <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if all names should be enclosed in single
- quotation marks; otherwise, <see langword="false" />. The default
- is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/QUOTEALLNAMES</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.RawExceptionHandling">
- <summary>
- Specifies whether or not the disassembler should generate
- structured exception handling clauses in canonical (label) form.
- The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if structured exception handling clauses
- should be generated in canonical form; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/RAWEH</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Source">
- <summary>
- Specifies whether or not the disassembler should generate
- original source lines as comments. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if original source lines should be
- generated as comments; otherwise, <see langword="false" />.
- The default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/SOURCE</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Tokens">
- <summary>
- Specifies whether or not the disassembler should generate metadata
- token values as comments. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if metadata token values should be
- generated as comments; otherwise, <see langword="false" />. The
- default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/TOKENS</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Unicode">
- <summary>
- Specifies whether or not the disassembler should use the UNICODE
- encoding when generating the output. The default is ANSI.
- </summary>
- <value>
- <see langword="true" /> if the output should be generated using
- the UNICODE encoding; otherwise, <see langword="false" />. The
- default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/UNICODE</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Utf8">
- <summary>
- Specifies whether or not the disassembler should use the UTF-8
- encoding when generating the output. The default is ANSI.
- </summary>
- <value>
- <see langword="true" /> if the output should be generated using
- the UTF-8 encoding; otherwise, <see langword="false" />. The
- default is <see langword="false" />.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/UTF8</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Item">
- <summary>
- Instructs the disassembler to disassemble the specified item only.
- </summary>
- <value>
- A <see cref="T:System.String"/> that specifies the item to
- disassemble.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/ITEM</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Visibility">
- <summary>
- Instructs the disassembler to disassemble only the items with the
- specified visibility. Possible values are <c>PUB</c>, <c>PRI</c>,
- <c>FAM</c>, <c>ASM</c>, <c>FAA</c>, <c>FOA</c>, <c>PSC</c>,
- or any combination of them separated by <c>+</c>.
- </summary>
- <value>
- A <see cref="T:System.String"/> that contains the visibility
- suboptions.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/VISIBILITY</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.OutputFile">
- <summary>
- Specifies the name of the output file created by the disassembler.
- </summary>
- <value>
- A <see cref="T:System.IO.FileInfo"/> that represents the name of
- the output file.
- </value>
- <remarks>
- <para>
- Corresponds to the <c>/OUT</c> flag.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.ToDirectory">
- <summary>
- Specifies the directory to which outputs will be stored.
- </summary>
- <value>
- A <see cref="T:System.IO.DirectoryInfo"/> that represents the
- directory to which outputs will be stored.
- </value>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Assemblies">
- <summary>
- Specifies a list of PE files to disassemble. To use a <see cref="T:NAnt.Core.Types.FileSet"/>,
- the <see cref="P:NAnt.MSNet.Tasks.IldasmTask.ToDirectory"/> attribute must be specified.
- </summary>
- <value>
- A <see cref="T:NAnt.Core.Types.FileSet"/> that represents the set
- of PE files to disassemble.
- </value>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.Arguments">
- <summary>
- The command-line arguments for the external program.
- </summary>
- <remarks>
- Overridden to ensure the <arg> elements would not be exposed
- to build authors.
- </remarks>
- </member>
- <member name="P:NAnt.MSNet.Tasks.IldasmTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- A <see cref="T:System.String"/> that contains the command-line
- arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.MSNet.Tasks.ServiceControllerTask">
- <summary>
- Allows a Windows service to be controlled.
- </summary>
- <example>
- <para>Starts the World Wide Web Publishing Service on the local computer.</para>
- <code>
- <![CDATA[
- <servicecontroller action="Start" service="w3svc" />
- ]]>
- </code>
- </example>
- <example>
- <para>Stops the Alerter service on computer 'MOTHER'.</para>
- <code>
- <![CDATA[
- <servicecontroller action="Stop" service="Alerter" machine="MOTHER" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.MSNet.Tasks.ServiceControllerTask"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.ExecuteTask">
- <summary>
- Peforms actions on the service in order to reach the desired status.
- </summary>
- </member>
- <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.DetermineDesiredStatus">
- <summary>
- Determines the desired status of the service based on the action
- that should be performed on it.
- </summary>
- <returns>
- The <see cref="T:System.ServiceProcess.ServiceControllerStatus"/> that should be reached
- in order for the <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.Action"/> to be considered successful.
- </returns>
- </member>
- <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.StartService(System.ServiceProcess.ServiceController)">
- <summary>
- Starts the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
- <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
- </summary>
- <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
- </member>
- <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.StopService(System.ServiceProcess.ServiceController)">
- <summary>
- Stops the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
- <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
- </summary>
- <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
- </member>
- <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.RestartService(System.ServiceProcess.ServiceController)">
- <summary>
- Restarts the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
- <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
- </summary>
- <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
- </member>
- <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.PauseService(System.ServiceProcess.ServiceController)">
- <summary>
- Pauses the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
- <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
- </summary>
- <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
- </member>
- <member name="M:NAnt.MSNet.Tasks.ServiceControllerTask.ContinueService(System.ServiceProcess.ServiceController)">
- <summary>
- Continues the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and
- <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.
- </summary>
- <param name="serviceController"><see cref="T:System.ServiceProcess.ServiceController"/> instance for controlling the service identified by <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName"/> and <see cref="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName"/>.</param>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._serviceName">
- <summary>
- Holds the name of the service that should be controlled.
- </summary>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._machineName">
- <summary>
- Holds the name of the computer on which the service resides.
- </summary>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._action">
- <summary>
- Holds the action that should be performed on the service.
- </summary>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask._timeout">
- <summary>
- Holds the time, in milliseconds, the task will wait for a service
- to reach the desired status.
- </summary>
- </member>
- <member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.ServiceName">
- <summary>
- The name of the service that should be controlled.
- </summary>
- </member>
- <member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.MachineName">
- <summary>
- The name of the computer on which the service resides. The default
- is the local computer.
- </summary>
- </member>
- <member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.Action">
- <summary>
- The action that should be performed on the service.
- </summary>
- </member>
- <member name="P:NAnt.MSNet.Tasks.ServiceControllerTask.Timeout">
- <summary>
- The time, in milliseconds, the task will wait for the service to
- reach the desired status. The default is 5000 milliseconds.
- </summary>
- </member>
- <member name="T:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType">
- <summary>
- Defines the actions that can be performed on a service.
- </summary>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Start">
- <summary>
- Starts a service.
- </summary>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Stop">
- <summary>
- Stops a service.
- </summary>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Restart">
- <summary>
- Restarts a service.
- </summary>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Pause">
- <summary>
- Pauses a running service.
- </summary>
- </member>
- <member name="F:NAnt.MSNet.Tasks.ServiceControllerTask.ActionType.Continue">
- <summary>
- Continues a paused service.
- </summary>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.NUnit.dll
Binary file
slips/build/tools/nant/bin/NAnt.NUnit.xml
@@ -1,353 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.NUnit</name>
- </assembly>
- <members>
- <member name="T:NAnt.NUnit.Types.FormatterData">
- <summary>
- Carries data specified through the formatter element.
- </summary>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterData.Type">
- <summary>
- Gets or sets the type of the formatter.
- </summary>
- <value>The type of the formatter.</value>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterData.UseFile">
- <summary>
- Gets or sets a value indicating whether output should be persisted
- to a file.
- </summary>
- <value>
- <see langword="true" /> if output should be written to a file; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterData.Extension">
- <summary>
- Gets or sets the extension to append to the output filename.
- </summary>
- <value>The extension to append to the output filename.</value>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterData.OutputDirectory">
- <summary>
- Gets or sets the directory where the output file should be written
- to, if <see cref="P:NAnt.NUnit.Types.FormatterData.UseFile"/> is <see langword="true"/>.
- </summary>
- <value>
- The directory where the output file should be written to.
- </value>
- </member>
- <member name="T:NAnt.NUnit.Types.FormatterDataCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.NUnit.Types.FormatterData"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.#ctor(NAnt.NUnit.Types.FormatterDataCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> class
- with the specified <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.#ctor(NAnt.NUnit.Types.FormatterData[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> class
- with the specified array of <see cref="T:NAnt.NUnit.Types.FormatterData"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.Add(NAnt.NUnit.Types.FormatterData)">
- <summary>
- Adds a <see cref="T:NAnt.NUnit.Types.FormatterData"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.AddRange(NAnt.NUnit.Types.FormatterData[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit.Types.FormatterData"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.NUnit.Types.FormatterData"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.AddRange(NAnt.NUnit.Types.FormatterDataCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.Contains(NAnt.NUnit.Types.FormatterData)">
- <summary>
- Determines whether a <see cref="T:NAnt.NUnit.Types.FormatterData"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.CopyTo(NAnt.NUnit.Types.FormatterData[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.IndexOf(NAnt.NUnit.Types.FormatterData)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.NUnit.Types.FormatterData"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.NUnit.Types.FormatterData"/>. If the <see cref="T:NAnt.NUnit.Types.FormatterData"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.Insert(System.Int32,NAnt.NUnit.Types.FormatterData)">
- <summary>
- Inserts a <see cref="T:NAnt.NUnit.Types.FormatterData"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to insert.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.NUnit.Types.FormatterDataEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataCollection.Remove(NAnt.NUnit.Types.FormatterData)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterData"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterDataCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.NUnit.Types.FormatterDataEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.NUnit.Types.FormatterData"/> elements of a <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataEnumerator.#ctor(NAnt.NUnit.Types.FormatterDataCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterDataEnumerator"/> class
- with the specified <see cref="T:NAnt.NUnit.Types.FormatterDataCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterDataEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterDataEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.NUnit.Types.FormatterType">
- <summary>
- The built-in formatter types.
- </summary>
- </member>
- <member name="F:NAnt.NUnit.Types.FormatterType.Plain">
- <summary>
- A plaintext formatter.
- </summary>
- </member>
- <member name="F:NAnt.NUnit.Types.FormatterType.Xml">
- <summary>
- An XML formatter.
- </summary>
- </member>
- <member name="T:NAnt.NUnit.Types.FormatterElement">
- <summary>
- Represents the FormatterElement of the NUnit task.
- </summary>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterElement.Type">
- <summary>
- Type of formatter.
- </summary>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterElement.Extension">
- <summary>
- Extension to append to the output filename.
- </summary>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterElement.UseFile">
- <summary>
- Determines whether output should be persisted to a file. The default
- is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterElement.OutputDirectory">
- <summary>
- Specifies the directory where the output file should be written to,
- if <see cref="P:NAnt.NUnit.Types.FormatterElement.UseFile"/> is <see langword="true"/>. If not
- specified, the output file will be written to the directory where
- the test module is located.
- </summary>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterElement.Data">
- <summary>
- Gets the underlying <see cref="T:NAnt.NUnit.Types.FormatterData"/> for the element.
- </summary>
- </member>
- <member name="T:NAnt.NUnit.Types.FormatterElementCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.NUnit.Types.FormatterElement"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.#ctor(NAnt.NUnit.Types.FormatterElementCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> class
- with the specified <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.#ctor(NAnt.NUnit.Types.FormatterElement[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> class
- with the specified array of <see cref="T:NAnt.NUnit.Types.FormatterElement"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.Add(NAnt.NUnit.Types.FormatterElement)">
- <summary>
- Adds a <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.AddRange(NAnt.NUnit.Types.FormatterElement[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit.Types.FormatterElement"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.NUnit.Types.FormatterElement"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.AddRange(NAnt.NUnit.Types.FormatterElementCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.Contains(NAnt.NUnit.Types.FormatterElement)">
- <summary>
- Determines whether a <see cref="T:NAnt.NUnit.Types.FormatterElement"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.CopyTo(NAnt.NUnit.Types.FormatterElement[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.IndexOf(NAnt.NUnit.Types.FormatterElement)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.NUnit.Types.FormatterElement"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.NUnit.Types.FormatterElement"/>. If the <see cref="T:NAnt.NUnit.Types.FormatterElement"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.Insert(System.Int32,NAnt.NUnit.Types.FormatterElement)">
- <summary>
- Inserts a <see cref="T:NAnt.NUnit.Types.FormatterElement"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to insert.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.NUnit.Types.FormatterElementEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementCollection.Remove(NAnt.NUnit.Types.FormatterElement)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit.Types.FormatterElement"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterElementCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.NUnit.Types.FormatterElementEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.NUnit.Types.FormatterElement"/> elements of a <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementEnumerator.#ctor(NAnt.NUnit.Types.FormatterElementCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit.Types.FormatterElementEnumerator"/> class
- with the specified <see cref="T:NAnt.NUnit.Types.FormatterElementCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit.Types.FormatterElementEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.NUnit.Types.FormatterElementEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.NUnit1Tasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.NUnit1Tasks.xml
@@ -1,538 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.NUnit1Tasks</name>
- </assembly>
- <members>
- <member name="M:NAnt.NUnit1.Types.IResultFormatter.StartTestSuite(NAnt.NUnit1.Types.NUnitTestData)">
- <summary>
- The whole test suite started.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatter.EndTestSuite(NAnt.NUnit1.Types.TestResultExtra)">
- <summary>
- The whole test suite ended.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatter.SetOutput(System.IO.TextWriter)">
- <summary>
- Sets the <see cref="T:System.IO.TextWriter"/> the formatter is supposed to write
- its results to.
- </summary>
- </member>
- <member name="T:NAnt.NUnit1.Types.IResultFormatterCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.IResultFormatterCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.#ctor(NAnt.NUnit1.Types.IResultFormatterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.IResultFormatterCollection"/> class
- with the specified <see cref="T:NAnt.NUnit1.Types.IResultFormatterCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.#ctor(NAnt.NUnit1.Types.IResultFormatter[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.IResultFormatterCollection"/> class
- with the specified array of <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.Add(NAnt.NUnit1.Types.IResultFormatter)">
- <summary>
- Adds a <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.AddRange(NAnt.NUnit1.Types.IResultFormatter[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.AddRange(NAnt.NUnit1.Types.IResultFormatterCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit1.Types.IResultFormatterCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.NUnit1.Types.IResultFormatterCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.Contains(NAnt.NUnit1.Types.IResultFormatter)">
- <summary>
- Determines whether a <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.CopyTo(NAnt.NUnit1.Types.IResultFormatter[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.IndexOf(NAnt.NUnit1.Types.IResultFormatter)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/>. If the <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.Insert(System.Int32,NAnt.NUnit1.Types.IResultFormatter)">
- <summary>
- Inserts a <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> to insert.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.NUnit1.Types.IResultFormatterEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterCollection.Remove(NAnt.NUnit1.Types.IResultFormatter)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.NUnit1.Types.IResultFormatterCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.NUnit1.Types.IResultFormatterEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.NUnit1.Types.IResultFormatter"/> elements of a <see cref="T:NAnt.NUnit1.Types.IResultFormatterCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterEnumerator.#ctor(NAnt.NUnit1.Types.IResultFormatterCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.IResultFormatterEnumerator"/> class
- with the specified <see cref="T:NAnt.NUnit1.Types.IResultFormatterCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.IResultFormatterEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.IResultFormatterEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.NUnit1.Types.LogFormatter">
- <summary>
- Prints information about running tests directly to the build log.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.LogFormatter.SetOutput(System.IO.TextWriter)">
- <summary>Not used, all output goes to Log class.</summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.LogFormatter.StartTestSuite(NAnt.NUnit1.Types.NUnitTestData)">
- <summary>Called when the whole test suite has started.</summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.LogFormatter.EndTestSuite(NAnt.NUnit1.Types.TestResultExtra)">
- <summary>Called when the whole test suite has ended.</summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.LogFormatter.FormatError(System.String,System.String)">
- <summary>Convert a stack trace line into something that can be clicked on in an IDE output window.</summary>
- <param name="trace">The StackTrace string, see <see cref="P:System.Exception.StackTrace"/>.</param>
- <param name="message">The string that gets appended to the end of file(line): portion.</param>
- </member>
- <member name="T:NAnt.NUnit1.Tasks.NUnitTask">
- <summary>
- Runs tests using the NUnit V1.0 framework.
- </summary>
- <remarks>
- <para>
- See the <see href="http://nunit.sf.net">NUnit home page</see> for more
- information.
- </para>
- <para>
- The <see cref="P:NAnt.NUnit1.Tasks.NUnitTask.HaltOnFailure"/> or <see cref="P:NAnt.NUnit1.Tasks.NUnitTask.HaltOnError"/>
- attributes are only used to stop more than one test suite to stop
- running. If any test suite fails a build error will be thrown.
- Set <see cref="P:NAnt.Core.Task.FailOnError"/> to <see langword="false"/> to
- ignore test errors and continue build.
- </para>
- </remarks>
- <example>
- <para>
- Run tests in the <c>MyProject.Tests.dll</c> assembly.
- </para>
- <para>
- The test results are logged in <c>results.xml</c> and <c>results.txt</c>
- using the <see cref="F:NAnt.NUnit.Types.FormatterType.Xml"/> and <see cref="F:NAnt.NUnit.Types.FormatterType.Plain"/>
- formatters, respectively.
- </para>
- <code>
- <![CDATA[
- <nunit basedir="build" verbose="false" haltonerror="true" haltonfailure="true">
- <formatter type="Xml" />
- <formatter type="Plain" />
- <test name="MyProject.Tests.AllTests" assembly="MyProject.Tests.dll" outfile="results"/>
- </nunit>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.NUnit1.Tasks.NUnitTask.HaltOnError">
- <summary>
- Stops running tests when a test causes an error. The default is
- <see langword="false" />.
- </summary>
- <remarks>
- Implies haltonfailure.
- </remarks>
- </member>
- <member name="P:NAnt.NUnit1.Tasks.NUnitTask.HaltOnFailure">
- <summary>
- Stops running tests if a test fails (errors are considered failures
- as well). The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Tasks.NUnitTask.Timeout">
- <summary>
- Cancel the individual tests if they do not finish in the specified
- time (measured in milliseconds). Ignored if fork is disabled.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Tasks.NUnitTask.Tests">
- <summary>
- Tests to run.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Tasks.NUnitTask.FormatterElements">
- <summary>
- Formatters to output results of unit tests.
- </summary>
- </member>
- <member name="T:NAnt.NUnit1.Types.NUnitTest">
- <summary>
- Represents a test element of an <see cref="T:NAnt.NUnit1.Tasks.NUnitTask"/>.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTest.OutFile">
- <summary>
- Base name of the test result. The full filename is determined by this
- attribute and the extension of formatter.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTest.ToDir">
- <summary>
- Directory to write the reports to.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTest.Class">
- <summary>
- Class name of the test.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTest.Assembly">
- <summary>
- Assembly to load the test from.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTest.Fork">
- <summary>
- Run the tests in a separate <see cref="T:System.AppDomain"/>.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTest.HaltOnError">
- <summary>
- Stop the build process if an error occurs during the test run.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTest.HaltOnFailure">
- <summary>
- Stop the build process if a test fails (errors are considered failures
- as well).
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTest.AppConfigFile">
- <summary>
- The application configuration file to use for the NUnit test domain.
- </summary>
- </member>
- <member name="T:NAnt.NUnit1.Types.NUnitTestCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.NUnitTestCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.#ctor(NAnt.NUnit1.Types.NUnitTestCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.NUnitTestCollection"/> class
- with the specified <see cref="T:NAnt.NUnit1.Types.NUnitTestCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.#ctor(NAnt.NUnit1.Types.NUnitTest[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.NUnitTestCollection"/> class
- with the specified array of <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.Add(NAnt.NUnit1.Types.NUnitTest)">
- <summary>
- Adds a <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.AddRange(NAnt.NUnit1.Types.NUnitTest[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.AddRange(NAnt.NUnit1.Types.NUnitTestCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit1.Types.NUnitTestCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.NUnit1.Types.NUnitTestCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.Contains(NAnt.NUnit1.Types.NUnitTest)">
- <summary>
- Determines whether a <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.CopyTo(NAnt.NUnit1.Types.NUnitTest[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.IndexOf(NAnt.NUnit1.Types.NUnitTest)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.NUnit1.Types.NUnitTest"/>. If the <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.Insert(System.Int32,NAnt.NUnit1.Types.NUnitTest)">
- <summary>
- Inserts a <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> to insert.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.NUnit1.Types.NUnitTestEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestCollection.Remove(NAnt.NUnit1.Types.NUnitTest)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTestCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.NUnit1.Types.NUnitTestEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.NUnit1.Types.NUnitTest"/> elements of a <see cref="T:NAnt.NUnit1.Types.NUnitTestCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestEnumerator.#ctor(NAnt.NUnit1.Types.NUnitTestCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.NUnitTestEnumerator"/> class
- with the specified <see cref="T:NAnt.NUnit1.Types.NUnitTestCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit1.Types.NUnitTestEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.NUnitTestEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.NUnit1.Types.NUnitTestData">
- <summary>
- Carries data specified through the test element.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.NeedsRunning">
- <summary>
- Determines if the unit test needs running.
- </summary>
- <returns>
- <see langword="true" /> if unit test needs running, otherwise,
- <see langword="false" />.
- </returns>
- <remarks>
- <para>
- Determines if the test needs running by looking at the date stamp
- of the test assembly and the test results log.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.Run(System.String,System.Boolean)">
- <summary>
- Runs a Suite extracted from a TestCase subclass.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.CreateFormatters(NAnt.NUnit1.Types.NUnitTestData,System.String,System.Boolean)">
- <summary>
- Creates the formatters to be used when running this test.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.GetOutput(NAnt.NUnit.Types.FormatterData,NAnt.NUnit1.Types.NUnitTestData)">
- <summary>
- Returns the output file or null if does not use a file.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Tasks.NUnitTestRunner.GetSuite(System.String)">
- <summary>
- Returns the test suite from a given class.
- </summary>
- <remarks>
- The assemblyQualifiedName parameter needs to be in form:
- "full.qualified.class.name,Assembly"
- </remarks>
- </member>
- <member name="P:NAnt.NUnit1.Tasks.NUnitTestRunner.Formatters">
- <summary>
- Gets the collection of registered formatters.
- </summary>
- <value>Collection of registered formatters.</value>
- </member>
- <member name="P:NAnt.NUnit1.Tasks.NUnitTestRunner.ResultCode">
- <summary>
- Gets the result of the test.
- </summary>
- <value>The result of the test.</value>
- </member>
- <member name="T:NAnt.NUnit1.Types.PlainTextFormatter">
- <summary>
- Prints information about running tests in plain text.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.PlainTextFormatter.SetOutput(System.IO.TextWriter)">
- <summary>Sets the Writer the formatter is supposed to write its results to.</summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.PlainTextFormatter.StartTestSuite(NAnt.NUnit1.Types.NUnitTestData)">
- <summary>Called when the whole test suite has started.</summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.PlainTextFormatter.EndTestSuite(NAnt.NUnit1.Types.TestResultExtra)">
- <summary>Called when the whole test suite has ended.</summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.PlainTextFormatter.FormatError(System.String,System.String)">
- <summary>Convert a stack trace line into something that can be clicked on in an IDE output window.</summary>
- <param name="trace">The StackTrace string, see <see cref="P:System.Exception.StackTrace"/>.</param>
- <param name="message">The string that gets appended to the end of file(line): portion.</param>
- </member>
- <member name="T:NAnt.NUnit1.Types.TestResultExtra">
- <summary>
- Decorates NUnits <see cref="T:NUnit.Framework.TestResult"/> with extra information such as
- run-time.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.TestResultExtra.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.TestResultExtra"/>
- class.
- </summary>
- </member>
- <member name="P:NAnt.NUnit1.Types.TestResultExtra.RunTime">
- <summary>
- Gets or sets the total run-time of a test.
- </summary>
- <value>The total run-time of a test.</value>
- </member>
- <member name="T:NAnt.NUnit1.Types.XmlResultFormatter">
- <summary>
- Prints detailed information about running tests in XML format.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.XmlResultFormatter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit1.Types.XmlResultFormatter"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.XmlResultFormatter.SetOutput(System.IO.TextWriter)">
- <summary>
- Sets the <see cref="T:System.IO.TextWriter"/> the formatter is supposed to
- write its results to.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.XmlResultFormatter.StartTestSuite(NAnt.NUnit1.Types.NUnitTestData)">
- <summary>
- Called when the whole test suite has started.
- </summary>
- </member>
- <member name="M:NAnt.NUnit1.Types.XmlResultFormatter.EndTestSuite(NAnt.NUnit1.Types.TestResultExtra)">
- <summary>
- Called when the whole test suite has ended.
- </summary>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.NUnit2Tasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.NUnit2Tasks.xml
@@ -1,568 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.NUnit2Tasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.NUnit2.Types.Categories">
- <summary>
- Controls the categories of tests to execute using the <see cref="T:NAnt.NUnit2.Tasks.NUnit2Task"/>.
- </summary>
- <example>
- <para>
- Only include test cases and fixtures that require no internet access.
- </para>
- <code>
- <![CDATA[
- <categories>
- <include name="NoInternetAccess" />
- </categories>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Exclude test cases and fixtures that are known to fail.
- </para>
- <code>
- <![CDATA[
- <categories>
- <exclude name="NotWorking" />
- </categories>
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.NUnit2.Types.Categories.Includes">
- <summary>
- Specifies a list of categories to include.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.Categories.Excludes">
- <summary>
- Specifies a list of categories to exclude.
- </summary>
- </member>
- <member name="T:NAnt.NUnit2.Types.Category">
- <summary>
- Represents a certain group of test cases or fixtures.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.Category.CategoryName">
- <summary>
- A name of a category, or comma-separated list of names.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.Category.IfDefined">
- <summary>
- If <see langword="true" /> then the category will be processed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.Category.UnlessDefined">
- <summary>
- If <see langword="true" /> then the category will be skipped;
- otherwise, processed. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.NUnit2.Types.CategoryCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.NUnit2.Types.Category"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.CategoryCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.#ctor(NAnt.NUnit2.Types.CategoryCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.CategoryCollection"/> class
- with the specified <see cref="T:NAnt.NUnit2.Types.CategoryCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.#ctor(NAnt.NUnit2.Types.Category[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.CategoryCollection"/> class
- with the specified array of <see cref="T:NAnt.NUnit2.Types.Category"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.ToString">
- <summary>
- Returns a comma-delimited list of categories.
- </summary>
- <returns>
- A comma-delimited list of categories, or an empty
- <see cref="T:System.String"/> if there are no categories.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.Add(NAnt.NUnit2.Types.Category)">
- <summary>
- Adds a <see cref="T:NAnt.NUnit2.Types.Category"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.Category"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.AddRange(NAnt.NUnit2.Types.Category[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit2.Types.Category"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.NUnit2.Types.Category"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.AddRange(NAnt.NUnit2.Types.CategoryCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit2.Types.CategoryCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.NUnit2.Types.CategoryCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.Contains(NAnt.NUnit2.Types.Category)">
- <summary>
- Determines whether a <see cref="T:NAnt.NUnit2.Types.Category"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.Category"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.NUnit2.Types.Category"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.NUnit2.Types.Category"/> with value
- <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.CopyTo(NAnt.NUnit2.Types.Category[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.IndexOf(NAnt.NUnit2.Types.Category)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.NUnit2.Types.Category"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.Category"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.NUnit2.Types.Category"/>. If the <see cref="T:NAnt.NUnit2.Types.Category"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.Insert(System.Int32,NAnt.NUnit2.Types.Category)">
- <summary>
- Inserts a <see cref="T:NAnt.NUnit2.Types.Category"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.Category"/> to insert.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.NUnit2.Types.CategoryEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryCollection.Remove(NAnt.NUnit2.Types.Category)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.Category"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.NUnit2.Types.CategoryCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.NUnit2.Types.CategoryCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.NUnit2.Types.Category"/> with the specified name.
- </summary>
- <param name="value">The name of the <see cref="T:NAnt.NUnit2.Types.Category"/> to get.</param>
- </member>
- <member name="T:NAnt.NUnit2.Types.CategoryEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.NUnit2.Types.Category"/> elements of a <see cref="T:NAnt.NUnit2.Types.CategoryCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryEnumerator.#ctor(NAnt.NUnit2.Types.CategoryCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.CategoryEnumerator"/> class
- with the specified <see cref="T:NAnt.NUnit2.Types.CategoryCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.CategoryEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.CategoryEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.NUnit2.Types.NUnit2TestCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> objects.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor(NAnt.NUnit2.Types.NUnit2TestCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class
- with the specified <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.#ctor(NAnt.NUnit2.Types.NUnit2Test[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> class
- with the specified array of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Add(NAnt.NUnit2.Types.NUnit2Test)">
- <summary>
- Adds a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.AddRange(NAnt.NUnit2.Types.NUnit2Test[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.AddRange(NAnt.NUnit2.Types.NUnit2TestCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Contains(NAnt.NUnit2.Types.NUnit2Test)">
- <summary>
- Determines whether a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.CopyTo(NAnt.NUnit2.Types.NUnit2Test[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.IndexOf(NAnt.NUnit2.Types.NUnit2Test)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/>. If the <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Insert(System.Int32,NAnt.NUnit2.Types.NUnit2Test)">
- <summary>
- Inserts a <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to insert.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.NUnit2.Types.NUnit2TestEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestCollection.Remove(NAnt.NUnit2.Types.NUnit2Test)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2TestCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.NUnit2.Types.NUnit2TestEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.NUnit2.Types.NUnit2Test"/> elements of a <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.#ctor(NAnt.NUnit2.Types.NUnit2TestCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Types.NUnit2TestEnumerator"/> class
- with the specified <see cref="T:NAnt.NUnit2.Types.NUnit2TestCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Types.NUnit2TestEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2TestEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.NUnit2.Tasks.NUnit2Task">
- <summary>
- Runs tests using the NUnit V2.2 framework.
- </summary>
- <remarks>
- <para>
- The <see cref="P:NAnt.NUnit2.Tasks.NUnit2Task.HaltOnFailure"/> attribute is only useful when more
- than one test suite is used, and you want to continue running other
- test suites although a test failed.
- </para>
- <para>
- Set <see cref="P:NAnt.Core.Task.FailOnError"/> to <see langword="false"/> to
- ignore any errors and continue the build.
- </para>
- <para>
- In order to run a test assembly built with NUnit 2.0 or 2.1 using
- <see cref="T:NAnt.NUnit2.Tasks.NUnit2Task"/>, you must add the following node to your
- test config file :
- </para>
- <code>
- <![CDATA[
- <configuration>
- ...
- <runtime>
- <assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
- <dependentAssembly>
- <assemblyIdentity name="nunit.framework" publicKeyToken="96d09a1eb7f44a77" culture="Neutral" />
- <bindingRedirect oldVersion="2.0.6.0" newVersion="2.2.8.0" />
- <bindingRedirect oldVersion="2.1.4.0" newVersion="2.2.8.0" />
- </dependentAssembly>
- </assemblyBinding>
- </runtime>
- ...
- </configuration>
- ]]>
- </code>
- <para>
- See the <see href="http://nunit.sf.net">NUnit home page</see> for more
- information.
- </para>
- </remarks>
- <example>
- <para>
- Run tests in the <c>MyProject.Tests.dll</c> assembly.
- </para>
- <code>
- <![CDATA[
- <nunit2>
- <formatter type="Plain" />
- <test assemblyname="MyProject.Tests.dll" appconfig="MyProject.Tests.dll.config" />
- </nunit2>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Only run tests that are not known to fail in files listed in the <c>tests.txt</c>
- file.
- </para>
- <code>
- <![CDATA[
- <nunit2>
- <formatter type="Xml" usefile="true" extension=".xml" outputdir="${build.dir}/results" />
- <test>
- <assemblies>
- <includesfile name="tests.txt" />
- </assemblies>
- <categories>
- <exclude name="NotWorking" />
- </categories>
- </test>
- </nunit2>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.NUnit2.Tasks.NUnit2Task.ExecuteTask">
- <summary>
- Runs the tests and sets up the formatters.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Tasks.NUnit2Task.HaltOnFailure">
- <summary>
- Stop the test run if a test fails. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Tasks.NUnit2Task.Tests">
- <summary>
- Tests to run.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Tasks.NUnit2Task.FormatterElements">
- <summary>
- Formatters to output results of unit tests.
- </summary>
- </member>
- <member name="T:NAnt.NUnit2.Types.NUnit2Test">
- <summary>
- Represents a <c>test</c> element of an <see cref="T:NAnt.NUnit2.Tasks.NUnit2Task"/>.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2Test.AssemblyFile">
- <summary>
- Name of the assembly to search for tests.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2Test.TestName">
- <summary>
- Name of a specific testfixture to run. If not specified then all
- testfixtures are run.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2Test.Assemblies">
- <summary>
- Assemblies to include in test.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2Test.Categories">
- <summary>
- Categories of test cases to include or exclude.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2Test.HaltOnFailure">
- <summary>
- Build fails on failure. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2Test.XsltFile">
- <summary>
- XSLT transform file to use when using the <see cref="F:NAnt.NUnit.Types.FormatterType.Plain"/>
- formatter.
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2Test.AppConfigFile">
- <summary>
- 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".
- </summary>
- </member>
- <member name="P:NAnt.NUnit2.Types.NUnit2Test.TestAssemblies">
- <summary>
- Gets all assemblies specified for these tests.
- </summary>
- <returns>
- All assemblies specified for these tests.
- </returns>
- </member>
- <member name="T:NAnt.NUnit2.Tasks.NUnit2TestDomain">
- <summary>
- Custom TestDomain, similar to the one included with NUnit, in order
- to workaround some limitations in it.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.NUnit2.Tasks.NUnit2TestDomain"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.CreateRunner(System.IO.FileInfo,System.IO.FileInfo)">
- <summary>
- Runs a single testcase.
- </summary>
- <param name="assemblyFile">The test assembly.</param>
- <param name="configFile">The application configuration file for the test domain.</param>
- <returns>
- The result of the test.
- </returns>
- </member>
- <member name="T:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler">
- <summary>
- Helper class called when an assembly resolve event is raised.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler.#ctor(System.String[])">
- <summary>
- Initializes an instanse of the <see cref="T:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler.ResolveAssembly(System.Object,System.ResolveEventArgs)">
- <summary>
- Called back when the CLR cannot resolve a given assembly.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="args">A <see cref="T:System.ResolveEventArgs"/> that contains the event data.</param>
- <returns>
- The <c>nunit.framework</c> we know to be in NAnts bin directory, if
- that is the assembly that needs to be resolved; otherwise,
- <see langword="null"/>.
- </returns>
- </member>
- <member name="M:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler.AssemblyLoad(System.Object,System.AssemblyLoadEventArgs)">
- <summary>
- Occurs when an assembly is loaded. The loaded assembly is added
- to the assembly cache.
- </summary>
- <param name="sender">The source of the event.</param>
- <param name="args">An <see cref="T:System.AssemblyLoadEventArgs"/> that contains the event data.</param>
- </member>
- <member name="F:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler._probePaths">
- <summary>
- Holds the list of directories that will be scanned for missing
- assembly references.
- </summary>
- </member>
- <member name="F:NAnt.NUnit2.Tasks.NUnit2TestDomain.AssemblyResolveHandler._assemblyCache">
- <summary>
- Holds the loaded assemblies.
- </summary>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.SourceControlTasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.SourceControlTasks.xml
@@ -1,1283 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.SourceControlTasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.SourceControl.Tasks.AbstractCvsTask">
- <summary>
- A base class for creating tasks for executing CVS client commands on a
- CVS repository.
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.AbstractSourceControlTask">
- <summary>
- A base class for creating tasks for executing CVS client commands on a
- CVS repository.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.EnvHome">
- <summary>
- Name of the environmental variable specifying a users' home
- in a *nix environment.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.AppData">
- <summary>
- Used on windows to specify the location of application data.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PathVariable">
- <summary>
- The environment variable that holds path information.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.CvsPassFileVariable">
- <summary>
- The environment variable that holds the location of the
- .cvspass file.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PropExeName">
- <summary>
- Property name used to specify the source control executable. This is
- used as a readonly property.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.AbstractCvsTask"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Build up the command line arguments, determine which executable is being
- used and find the path to that executable and set the working
- directory.
- </summary>
- <param name="process">The process to prepare.</param>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.SetGlobalOption(System.String,System.String,System.Boolean)">
- <summary>
- Adds a new global option if none exists. If one does exist then
- the use switch is toggled on or of.
- </summary>
- <param name="name">The common name of the option.</param>
- <param name="value">The option value or command line switch
- of the option.</param>
- <param name="on"><code>true</code> if the option should be
- appended to the commandline, otherwise <code>false</code>.</param>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.SetCommandOption(System.String,System.String,System.Boolean)">
- <summary>
- Adds a new command option if none exists. If one does exist then
- the use switch is toggled on or of.
- </summary>
- <param name="name">The common name of the option.</param>
- <param name="value">The option value or command line switch
- of the option.</param>
- <param name="on"><code>true</code> if the option should be
- appended to the commandline, otherwise <code>false</code>.</param>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.SetEnvironment(System.Diagnostics.Process)">
- <summary>
- Set up the environment variables for a process.
- </summary>
- <param name="process">A process to setup.</param>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.AppendFiles">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractSourceControlTask.DeriveVcsFromEnvironment">
- <summary>
- Derive the location of the version control system from the environment
- variable <code>PATH</code>.
- </summary>
- <returns>The file information of the version control system,
- or <code>null</code> if this cannot be found.</returns>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PassFileName">
- <summary>
- The name of the passfile, overriden for each version control system (VCS).
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.VcsHome">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.VcsHomeEnv">
- <summary>
- The environment variable that defines where the version control system
- (VCS) home variable is kept.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.VcsExeName">
- <summary>
- The name of the version control system (VCS) executable file.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.Root">
- <summary>
- <para>
- The root variable contains information on how to locate a repository.
- Although this information is in different formats it typically must
- define the following:
- <list type="table">
- <item>server location</item>
- <item>protocol used to communicate with the repository</item>
- <item>repository location on the server</item>
- <item>project location in the repository</item>
- </list>
- </para>
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.DestinationDirectory">
- <summary>
- Destination directory for the local sandbox. If destination is not specified
- then the current directory is used.
- </summary>
- <value>
- Root path of the local sandbox.
- </value>
- <remarks>
- <para>
- Root path of the local sandbox.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.Password">
- <summary>
- The password for logging in to the repository.
- </summary>
- <value>
- The password for logging in to the repository.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.PassFile">
- <summary>
- The full path to the cached password file. If not specified then the
- environment variables are used to try and locate the file.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.GlobalOptions">
- <summary>
- Holds a collection of globally available options.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.CommandOptions">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.CommandLineArguments">
- <summary>
- 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.
- </summary>
- <example>
- <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"
- />
- <br />
- Produces the cvs command:
- <code>c:\Program Files\TortoiseCVS\cvs.exe -d:pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant -q checkout -n nant</code>
- </example>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.CommandName">
- <summary>
- The name of the command that is going to be executed.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.VcsFileSet">
- <summary>
- Used to specify the version control system (VCS) files that are going
- to be acted on.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.Ssh">
- <summary>
- The executable to use for ssh communication.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.SshEnv">
- <summary>
- The environment name for the ssh variable.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.ExeName">
- <summary>
- The name of the version control system executable.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.ProgramArguments">
- <summary>
- Get the command line arguments for the task.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultRecursive">
- <summary>
- Default value for the recursive directive. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultQuiet">
- <summary>
- Default value for the quiet command.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultReallyQuiet">
- <summary>
- Default value for the really quiet command.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsHome">
- <summary>
- An environment variable that holds path information about where
- cvs is located.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsPassfile">
- <summary>
- Name of the password file that cvs stores pserver
- cvsroot/ password pairings.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultCompressionLevel">
- <summary>
- The default compression level to use for cvs commands.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.DefaultUseSharpCvsLib">
- <summary>
- The default use of binaries, defaults to use sharpcvs.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsExe">
- <summary>
- The name of the cvs executable.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.SharpCvsExe">
- <summary>
- The temporary name of the sharpcvslib binary file, to avoid
- conflicts in the path variable.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsRsh">
- <summary>
- Environment variable that holds the executable name that is used for
- ssh communication.
- </summary>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.AbstractCvsTask.UseSharpCvsLibProp">
- <summary>
- Property name used to specify on a project level whether sharpcvs is
- used or not.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.AbstractCvsTask"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Build up the command line arguments, determine which executable is being
- used and find the path to that executable and set the working
- directory.
- </summary>
- <param name="process">The process to prepare.</param>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.AppendSubCommandArgs">
- <summary>
- Override to append any commands before the modele and files.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.AppendCommandOptions">
- <summary>
- 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.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.AbstractCvsTask.AddArg(System.String)">
- <summary>
- 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.
- </summary>
- <param name="arg"></param>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.SshEnv">
- <summary>
- The environment name for the ssh variable.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.VcsExeName">
- <summary>
- The name of the cvs binary, or <c>cvs.exe</c> at the time this
- was written.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.PassFileName">
- <summary>
- The name of the pass file, or <c>.cvspass</c> at the time
- of this writing.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.VcsHomeEnv">
- <summary>
- The name of the version control system specific home environment
- variable.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.IsModuleNeeded">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsFileSet">
- <summary>
- Used to specify the version control system (VCS) files that are going
- to be acted on.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.VcsFileSet">
- <summary>
- Get the cvs file set.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.ExeName">
- <summary>
- The name of the cvs executable.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.CvsFullPath">
- <summary>
- 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.
- </summary>
- <value>
- A full path (i.e. including file name) of your cvs binary:
- On Windows: c:\vcs\cvs\cvs.exe
- On *nix: /usr/bin/cvs
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.Root">
- <summary>
- <para>
- The cvs root variable has the following components:
- </para>
- <para>
- <code>[protocol]:[username]@[servername]:[server path]</code>
- <ul>
- <li>protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation.</li>
- <li>username: [username]</li>
- <li>servername: cvs.sourceforge.net</li>
- <li>server path: /cvsroot/nant</li>
- </ul>
- </para>
- </summary>
- <example>
- <para>NAnt anonymous cvsroot:</para>
- <code>
- :pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant
- </code>
- </example>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.Module">
- <summary>
- The module to perform an operation on.
- </summary>
- <value>
- The module to perform an operation on. This is a normal file/folder
- name without path information.
- </value>
- <example>
- <para>In NAnt the module name would be:</para>
- <code>nant</code>
- </example>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.UseSharpCvsLib">
- <summary>
- <para>
- <see langword="true" /> if the SharpCvsLib binaries that come bundled
- with NAnt should be used to perform the cvs commands, <see langword="false" />
- otherwise.
- </para>
- <para>
- You may also specify an override value for all cvs tasks instead
- of specifying a value for each. To do this set the property
- <c>sourcecontrol.usesharpcvslib</c> to <see langword="false" />.
- </para>
- <warn>
- If you choose not to use SharpCvsLib to checkout from cvs you will
- need to include a cvs.exe binary in your path.
- </warn>
- </summary>
- <example>
- 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.
- </example>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.Ssh">
- <summary>
- The executable to use for ssh communication.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.Quiet">
- <summary>
- Indicates if the output from the cvs command should be supressed.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.ReallyQuiet">
- <summary>
- Indicates if the output from the cvs command should be stopped.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.ReadOnly">
- <summary>
- <see langword="true" /> if the sandbox files should be checked out in
- read only mode. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.ReadWrite">
- <summary>
- <see langword="true" /> if the sandbox files should be checked out in
- read/write mode. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.AbstractCvsTask.CompressionLevel">
- <summary>
- Compression level to use for all net traffic. This should be a value from 1-9.
- <br />
- <br />
- <bold>NOTE: This is not available on sharpcvslib.</bold>
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.ChangeLogTask">
- <summary>
- Produces an XML report that represents the cvs changes from the given
- start day, to a given end date.
- </summary>
- <example>
- <para>Report changes in NAnt from 1st of June 2004 until 25th of July 2004.</para>
- <code>
- <![CDATA[
- <cvs-changelog
- destination="e:/test/nant/sourcecontrol/"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- module="nant"
- start="2004/06/01"
- end="2004/07/25"
- xmlfile="e:/test/nant/sourcecontrol/changelog-nant.xml"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.ChangeLogTask.CvsCommandName">
- <summary>
- The command being executed.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.DestFile">
- <summary>
- Name of the xml file that will contain the cvs log information.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.StartDate">
- <summary>
- The earliest change to use in the cvs log command.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.EndDate">
- <summary>
- The latest date to use in the cvs log command.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.CommandName">
- <summary>
- The cvs command to execute.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.UseSharpCvsLib">
- <summary>
- Override use of sharpcvslib, needs to be true.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ChangeLogTask.Root">
- <summary>
- <para>
- The cvs root variable has the following components:
- </para>
- <para>
- <code>[protocol]:[username]@[servername]:[server path]</code>
- <ul>
- <li>protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation.</li>
- <li>username: [username]</li>
- <li>servername: cvs.sourceforge.net</li>
- <li>server path: /cvsroot/nant</li>
- </ul>
- </para>
- <para>
- If the cvsroot is not specified then the directory specified by the
- <see cref="P:NAnt.SourceControl.Tasks.AbstractSourceControlTask.DestinationDirectory"/> attribute
- is searched for CVS\Root.
- </para>
- </summary>
- <example>
- <para>NAnt anonymous cvsroot:</para>
- <code>
- :pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant
- </code>
- </example>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.CheckoutTask">
- <summary>
- Checks out a CVS module to the required directory.
- </summary>
- <example>
- <para>Checkout NAnt.</para>
- <code>
- <![CDATA[
- <cvs-checkout
- destination="c:\src\nant\"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- module="nant" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Checkout NAnt revision named <c>0_85</c> to the
- folder <c>c:\src\nant\v0.85</c>.
- </para>
- <code>
- <![CDATA[
- <cvs-checkout
- destination="c:\src\nant"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- module="nant"
- revision="0_85"
- overridedir="v0.85" />
- ]]>
- </code>
- <para>So the nant module tagged with revision 0_85 will be checked
- out in the folder v0.85 under the working/ destination directory.
- <br/>This could be used to work on different
- branches of a repository at the same time.</para>
- </example>
- <example>
- <para>
- Checkout NAnt with specified revision date to the
- folder <c>c:\src\nant\2003_08_16</c>.
- </para>
- <code>
- <![CDATA[
- <cvs-checkout
- destination="c:\src\nant\"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- module="nant"
- date="2003/08/16"
- overridedir="2003_08_16" />
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.CheckoutTask.CvsCommandName">
- <summary>
- The command being executed.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.CheckoutTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.CheckoutTask"/> class.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.Revision">
- <summary>
- Specify the revision to checkout. This corresponds to the "sticky-tag"
- of the file.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.StickyTag">
- <summary>
- Sticky tag or revision to checkout.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.Date">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.OverrideDir">
- <summary>
- Specify a directory name to replace the module name. Valid names
- include any valid filename, excluding path information.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.OverrideDirectory">
- <summary>
- Specify a directory name to replace the module name. Valid names
- include any valid filename, excluding path information.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CheckoutTask.CommandName">
- <summary>
- The name of the cvs command that is going to be executed.
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.CvsPass">
- <summary>
- Executes the cvs login command which appends or updates an entry to the
- specified .cvspass file.
- </summary>
- <example>
- <para>Update .cvspass file to include the NAnt anonymous login.</para>
- <code>
- <![CDATA[
- <cvs-pass cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- password="anonymous"
- passfile="C:\.cvspass" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.CvsPass.Initialize">
- <summary>
- Ensures all information is available to execute the <see cref="T:NAnt.Core.Task"/>.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.CvsPass.ExecuteTask">
- <summary>
- Update the .cvspass file with the given password. If the passfile
- is not specified then the default search locations are used:
- <list type="list">
- <item>CVS_PASSFILE/.cvspass</item>
- <item>HOME/.cvspass</item>
- <item>USERPROFILE/.cvspass TODO: Confirm that this is valid
- behavior or if it is going to give problems with the
- cvsnt implementation.</item>
- </list>
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CvsPass.Password">
- <summary>
- Password to append or update to the .cvspass file.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CvsPass.PassFile">
- <summary>
- The full path to the .cvspass file. The default is ~/.cvspass.
- </summary>
- <value></value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CvsPass.DestinationDirectory">
- <summary>
- The current working directory.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CvsPass.Root">
- <summary>
- The repository root string.
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.CvsTask">
- <summary>
- Executes the cvs command specified by the command attribute.
- </summary>
- <example>
- <para>Checkout NAnt.</para>
- <code>
- <![CDATA[
- <cvs command="checkout"
- destination="c:\src\nant\"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- module="nant" />
- ]]>
- </code>
- </example>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CvsTask.CommandName">
- <summary>
- The cvs command to execute.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.CvsTask.IsModuleNeeded">
- <summary>
- Specify if the module is needed for this cvs command.
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.ExportTask">
- <summary>
- Exports a cvs module in preperation for a release (i.e. the CVS version
- folders are not exported).
- </summary>
- <example>
- <para>Export the most recent NAnt sources from cvs.</para>
- <code>
- <![CDATA[
- <cvs-export
- destination="c:\src\nant\"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- module="nant" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Export NAnt revision named <c>your_favorite_revision_here</c> to the
- folder <c>c:\src\nant\replacement_for_module_directory_name</c>.
-
- <warn>**NOTE**</warn>: filesets names for the export task must be
- prefixed with the module name. This is different than other tasks.
- </para>
- <code>
- <![CDATA[
- <cvs-export
- destination="c:\src\nant\"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- module="nant"
- revision="your_favorite_revision_here"
- overridedir="replacement_for_module_directory_name"
- recursive="false">
- <fileset>
- <include name="nant/bin/NAnt.exe"/>
- <include name="nant/bin/NAnt.exe.config"/>
- </fileset>
- </cvs-export>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.ExportTask.CvsCommandName">
- <summary>
- The command being executed.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.ExportTask.#ctor">
- <summary>
- Create a new instance of the <see cref="T:NAnt.SourceControl.Tasks.ExportTask"/>.
- </summary>
- <value>
- The following values are set by default:
- <ul>
- <li>Recursive: <see langword="true"/></li>
- </ul>
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ExportTask.NoShortening">
- <summary>
- No shortening. Do not shorten module paths if -d specified.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ExportTask.ForceHead">
- <summary>
- Indicates whether the head revision should be used if the revison specified by
- <see cref="P:NAnt.SourceControl.Tasks.ExportTask.Revision"/> or the <see cref="P:NAnt.SourceControl.Tasks.ExportTask.Date"/> tags are not
- found. The default is <see langword="false"/>.
- </summary>
- <value>
- <see langword="true"/> if the specified tag should be moved;
- otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ExportTask.Recursive">
- <summary>
- If a directory is specified indicates whether sub-directories should
- also be processed.
- </summary>
- <value>
- <see langword="true" /> if the sub-directories should be tagged;
- otherwise, <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ExportTask.Revision">
- <summary>
- Specify the revision to update the file to. This corresponds to the "sticky-tag"
- of the file.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ExportTask.Date">
- <summary>
- Specify the revision date to update to. The version of the file that
- existed at the date specified is retrieved.
- </summary>
- <value>
- A valid date time value, which is then converted to a format that
- cvs can parse.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ExportTask.OverrideDir">
- <summary>
- Specify a directory name to replace the module name. Valid names
- include any valid filename, excluding path information.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.ExportTask.CommandName">
- <summary>
- The export command name for the cvs client.
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.RTagTask">
- <summary>
- Tags all sources in the remote repository with a given tag.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- </remarks>
- <example>
- <para>Tag NAnt sources remotely.</para>
- <code>
- <![CDATA[
- <cvs-rtag
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- destination="."
- module="nant"
- tagname="v0_8_4"
- />
- ]]>
- </code>
- </example>
- <example>
- <para>Remove a tag from the remote repository.</para>
- <code>
- <![CDATA[
- <cvs-rtag
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- destination="."
- module="nant"
- tagname="v0_8_4"
- remove="true"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.RTagTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.RTagTask"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.RTagTask.AppendSubCommandArgs">
- <summary>
- Append the tag information to the commandline.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.RTagTask.Tag">
- <summary>
- The name of the tag to assign or remove.
- </summary>
- <value>
- The name of the tag to assign or remove.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.RTagTask.Remove">
- <summary>
- Indicates whether the tag specified in <see cref="P:NAnt.SourceControl.Tasks.RTagTask.Tag"/> should
- be removed or not.
- </summary>
- <value>
- <see langword="true"/> if the specified tag should be removed;
- otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.RTagTask.MoveIfExists">
- <summary>
- Indicates whether the tag specified in <see cref="P:NAnt.SourceControl.Tasks.RTagTask.Tag"/> should
- be moved to the current file revision. If the tag does not exist
- then it is created.
- </summary>
- <value>
- <see langword="true"/> if the specified tag should be moved;
- otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.RTagTask.Recursive">
- <summary>
- If a directory is specified indicates whether sub-directories should
- also be processed.
- </summary>
- <value>
- <see langword="true" /> if the sub-directories should be tagged;
- otherwise, <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.RTagTask.ActOnTag">
- <summary>
- Indicates the repository <see cref="P:NAnt.SourceControl.Tasks.RTagTask.Tag"/> that is acted on
- for the tag command. Note if <see cref="P:NAnt.SourceControl.Tasks.RTagTask.MoveIfExists"/> is
- <see langword="true"/> then the tag specified is moved to the revision
- of the file on the HEAD of the branch specified.
- </summary>
- <value>
- The tag (or more likely) branch that should be used to apply the new tag.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.RTagTask.ActOnDate">
- <summary>
- Indicates the revision date of the file that the tag should be
- applied to.
- </summary>
- <value>
- A valid date which specifies the revision point that the tag will
- be applied to.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.RTagTask.ForceHead">
- <summary>
- Indicates whether the head revision should be used if the
- <see cref="P:NAnt.SourceControl.Tasks.RTagTask.ActOnTag"/> or the <see cref="P:NAnt.SourceControl.Tasks.RTagTask.ActOnDate"/> tags are not
- found.
- </summary>
- <value>
- <see langword="true"/> if the specified tag should be moved;
- otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.RTagTask.CommandName">
- <summary>
- The name of the cvs command that is going to be executed.
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.TagTask">
- <summary>
- Tags all local sources with the specified tag.
- </summary>
- <remarks>
- <para>
- This differs from the
- <see cref="T:NAnt.SourceControl.Tasks.RTagTask"/> in that it acts on references to the cvs files
- contained in your local filesystem. As such the sticky tags and local
- revisions can be considered in commits. It also allows you to verify that
- all local files have been checked in before a tag is performed.
- </para>
- </remarks>
- <example>
- <para>Tag NAnt sources remotely.</para>
- <code>
- <![CDATA[
- <cvs-tag
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- destination="."
- module="nant"
- tagname="v0_8_4"
- />
- ]]>
- </code>
- </example>
- <example>
- <para>Remove a tag from the remote repository.</para>
- <code>
- <![CDATA[
- <cvs-tag
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- destination="."
- module="nant"
- tagname="v0_8_4"
- remove="true"
- fail-if-modified="true"
- />
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.TagTask.CvsCommandName">
- <summary>
- Cvs command to be executed.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.TagTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.TagTask"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.TagTask.AppendSubCommandArgs">
- <summary>
- Append the tag information to the commandline.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.Tag">
- <summary>
- The name of the tag to assign or remove.
- </summary>
- <value>
- The name of the tag to assign or remove.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.Remove">
- <summary>
- Indicates whether the tag specified in <see cref="P:NAnt.SourceControl.Tasks.TagTask.Tag"/> should
- be removed or not.
- </summary>
- <value>
- <see langword="true"/> if the specified tag should be removed;
- otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.MoveIfExists">
- <summary>
- Indicates whether the tag specified in <see cref="P:NAnt.SourceControl.Tasks.TagTask.Tag"/> should
- be moved to the current file revision. If the tag does not exist
- then it is created.
- </summary>
- <value>
- <see langword="true"/> if the specified tag should be moved;
- otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.Recursive">
- <summary>
- If a directory is specified indicates whether sub-directories should
- also be processed.
- </summary>
- <value>
- <see langword="true" /> if the sub-directories should be tagged;
- otherwise, <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.ActOnTag">
- <summary>
- Indicates the repository <see cref="P:NAnt.SourceControl.Tasks.TagTask.Tag"/> that is acted on
- for the tag command. Note if <see cref="P:NAnt.SourceControl.Tasks.TagTask.MoveIfExists"/> is
- <see langword="true"/> then the tag specified is moved to the revision
- of the file on the HEAD of the branch specified.
- </summary>
- <value>
- The tag (or more likely) branch that should be used to apply the new tag.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.ActOnDate">
- <summary>
- Indicates the revision date of the file that the tag should be
- applied to.
- </summary>
- <value>
- A valid date which specifies the revision point that the tag will
- be applied to.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.ForceHead">
- <summary>
- Indicates whether the head revision should be used if the revision specified by
- <see cref="P:NAnt.SourceControl.Tasks.TagTask.ActOnTag"/> or the <see cref="P:NAnt.SourceControl.Tasks.TagTask.ActOnDate"/> tags are not
- found.
- </summary>
- <value>
- <see langword="true"/> if the specified tag should be moved;
- otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.FailIfModified">
- <summary>
- Indicates whether the head revision should be used if the
- <see cref="P:NAnt.SourceControl.Tasks.TagTask.ActOnTag"/> or the <see cref="P:NAnt.SourceControl.Tasks.TagTask.ActOnDate"/> tags are not
- found.
- </summary>
- <value>
- <see langword="true"/> if the specified tag should be moved;
- otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.CommandName">
- <summary>
- The name of the cvs command that is going to be executed.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.Module">
- <summary>
- Not used
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.TagTask.IsModuleNeeded">
- <summary>
- 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.
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Tasks.UpdateTask">
- <summary>
- Updates a CVS module in a local working directory.
- </summary>
- <example>
- <para>Update nant.</para>
- <code>
- <![CDATA[
- <cvs-update
- destination="c:\src\nant\"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- password=""
- module="nant" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Update your NAnt revision named <c>your_favorite_revision_here</c> in
- the folder <c>c:\src\nant\replacement_for_module_directory_name</c>.
- </para>
- <code>
- <![CDATA[
- <cvs-update
- destination="c:\src\nant\"
- cvsroot=":pserver:anonymous@cvs.sourceforge.net:/cvsroot/nant"
- module="nant"
- revision="your_favorite_revision_here"
- overridedir="replacement_for_module_directory_name"
- usesharpcvslib="false">
- <fileset>
- <include name="build.number"/>
- </fileset>
- </cvs-update>
- ]]>
- </code>
- </example>
- </member>
- <member name="F:NAnt.SourceControl.Tasks.UpdateTask.CvsCommandName">
- <summary>
- The command being executed.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Tasks.UpdateTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.SourceControl.Tasks.UpdateTask"/>
- class.
- </summary>
- <remarks>
- Sets the build directory and prune empty directory properties to
- <see langword="true"/>.
- </remarks>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.BuildDirs">
- <summary>
- If <see langword="true" />. new directories will be created on the local
- sandbox. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.PruneEmpty">
- <summary>
- If <see langword="true" /> empty directories copied down from the
- remote repository will be removed from the local sandbox.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.OverwriteLocal">
- <summary>
- If <see langword="true" /> the local copy of the file will be
- overwritten with the copy from the remote repository. The default
- is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.Recursive">
- <summary>
- Specifies if the command should be executed recursively. The
- default is <see langword="true" />.
- </summary>
- <remarks>
- The <c>-R</c> option is on by default in cvs.
- </remarks>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.Revision">
- <summary>
- Specify the revision to update the file to. This corresponds to the
- "sticky-tag" of the file.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.StickyTag">
- <summary>
- Sticky tag or revision to update the local file to.
- </summary>
- <value>
- A valid cvs tag.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.Date">
- <summary>
- Specify the revision date to update to. The version of the file that
- existed at the date specified is retrieved.
- </summary>
- <value>
- A valid date time value, which is then converted to a format that
- cvs can parse.
- </value>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.IsModuleNeeded">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Tasks.UpdateTask.CommandName">
- <summary>
- The name of the cvs command that is going to be executed.
- </summary>
- </member>
- <member name="T:NAnt.SourceControl.Types.CvsFileSet">
- <summary>
- A <see cref="T:NAnt.SourceControl.Types.CvsFileSet"/> is a <see cref="T:NAnt.Core.Types.FileSet"/> with extra
- attributes useful in the context of the <see cref="T:NAnt.SourceControl.Tasks.CvsTask"/>.
- </summary>
- </member>
- <member name="M:NAnt.SourceControl.Types.CvsFileSet.Initialize">
- <summary>
- Initialize the <see cref="T:NAnt.SourceControl.Types.CvsFileSet"/> object and locate the .cvsignore
- files to add to the exclude list.
- </summary>
- </member>
- <member name="P:NAnt.SourceControl.Types.CvsFileSet.UseCvsIgnore">
- <summary>
- Indicates whether the entires in the .cvsignore should be used to limit the
- file list; <see langword="true"/> to exclude files in .cvsignore, otherwise
- <see langword="false"/>. The default is <see langword="true"/>.
- </summary>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.VisualCppTasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.VisualCppTasks.xml
@@ -1,1205 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.VisualCppTasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.VisualCpp.Tasks.ClTask">
- <summary>
- Compiles C/C++ programs using <c>cl.exe</c>, Microsoft's C/C++ compiler.
- </summary>
- <remarks>
- <para>This task is intended for version 13.00.9466 of <c>cl.exe</c>.</para>
- </remarks>
- <example>
- <para>Compiles <c>helloworld.cpp</c> for the Common Language Runtime.</para>
- <code>
- <![CDATA[
- <cl outputdir="build" options="/clr">
- <sources>
- <include name="helloworld.cpp" />
- </sources>
- </cl>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.ClTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Tasks.ClTask"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.ClTask.ExecuteTask">
- <summary>
- Compiles the sources.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.ClTask.NeedsCompiling">
- <summary>
- Determines if the sources need to be compiled.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.ClTask.IsPchfileUpToDate">
- <summary>
- Determines whether the precompiled header file is up-to-date.
- </summary>
- <returns>
- <see langword="true" /> if no precompiled header file was specified;
- otherwise, <see langword="false" />.
- </returns>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.ClTask.FindUpdatedInclude(System.String,System.DateTime)">
- <summary>
- Determines whether any file that are includes in the specified
- source file has been updated after the obj was compiled.
- </summary>
- <param name="srcFileName">The source file to check.</param>
- <param name="objLastWriteTime">The last write time of the compiled obj.</param>
- <returns>
- The full path to the include file that was modified after the obj
- was compiled, or <see langword="null" /> if no include files were
- modified since the obj was compiled.
- </returns>
- <remarks>
- <para>
- To determine what includes are defined in a source file, conditional
- directives are not honored.
- </para>
- <para>
- If a given include cannot be resolved to an existing file, then
- it will be considered stable.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.ClTask.QuoteArgumentValue(System.String)">
- <summary>
- Quotes an argument value and duplicates trailing backslahes.
- </summary>
- <param name="value">The argument value to quote.</param>
- <returns>
- The quotes argument value.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.ClTask.GetObjOutputFile(System.String,System.String)">
- <summary>
- Determines the file name of the OBJ file for the specified source
- file.
- </summary>
- <param name="srcFile">The source file for which the OBJ file should be determined.</param>
- <param name="objectPath">The path of the object file.</param>
- <returns>
- The file name of the OBJ file for the specified source file.
- </returns>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.OutputDir">
- <summary>
- Directory where all output files are placed.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.PchFile">
- <summary>
- Specifies the path and/or name of the generated precompiled header
- file - given either relative to <see cref="P:NAnt.VisualCpp.Tasks.ClTask.OutputDir"/> or as an
- absolute path.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.PchThroughFile">
- <summary>
- The path of the boundary file when generating/using the
- specified <see cref="P:NAnt.VisualCpp.Tasks.ClTask.PchFile"/>. If a precompiled header file is
- not specified then this attribute is ignored.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.PchMode">
- <summary>
- The mode in which the specified <see cref="P:NAnt.VisualCpp.Tasks.ClTask.PchFile"/> (if any) is
- used. The default is <see cref="F:NAnt.VisualCpp.Tasks.ClTask.PrecompiledHeaderMode.Use"/>.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.ManagedExtensions">
- <summary>
- Specifies whether Managed Extensions for C++ should be enabled.
- The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.CharacterSet">
- <summary>
- Tells the compiler to use the specified character set.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.Options">
- <summary>
- Options to pass to the compiler.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.Sources">
- <summary>
- The list of files to compile.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.IncludeDirs">
- <summary>
- The list of directories in which to search for include files.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.MetaDataIncludeDirs">
- <summary>
- Directories that the compiler will search to resolve file references
- passed to the <c>#using</c> directive.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.ForcedUsingFiles">
- <summary>
- Specifies metadata files to reference in this compilation as an
- alternative to passing a file name to <c>#using</c> in source code.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.Defines">
- <summary>
- Macro definitions to pass to cl.exe.
- Each entry will generate a /D
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.Undefines">
- <summary>
- Macro undefines (/U) to pass to cl.exe.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.ObjectFile">
- <summary>
- A name to override the default object file name; can be either a file
- or directory name. The default is the output directory.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.ProgramDatabaseFile">
- <summary>
- A name for the compiler-generated PDB file; can be either a file or
- directory name. The default is the output directory.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>The filename of the external program.</value>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.ClTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.VisualCpp.Tasks.ClTask.PrecompiledHeaderMode">
- <summary>
- Defines the supported modes for the use of precompiled header files.
- </summary>
- </member>
- <member name="F:NAnt.VisualCpp.Tasks.ClTask.PrecompiledHeaderMode.Create">
- <summary>
- Create a precompiled header file.
- </summary>
- <remarks>
- For further information on the use of this option
- see the Microsoft documentation on the C++ compiler flag /Yc.
- </remarks>
- </member>
- <member name="F:NAnt.VisualCpp.Tasks.ClTask.PrecompiledHeaderMode.AutoCreate">
- <summary>
- Automatically create a precompiled header file if necessary.
- </summary>
- <remarks>
- For further information on the use of this option
- see the Microsoft documentation on the C++ compiler flag /YX.
- </remarks>
- </member>
- <member name="F:NAnt.VisualCpp.Tasks.ClTask.PrecompiledHeaderMode.Use">
- <summary>
- Use a (previously generated) precompiled header file.
- </summary>
- <remarks>
- For further information on the use of this option
- see the Microsoft documentation on the C++ compiler flag /Yu.
- </remarks>
- </member>
- <member name="T:NAnt.VisualCpp.Tasks.LibTask">
- <summary>
- Run <c>lib.exe</c>, Microsoft's Library Manager.
- </summary>
- <example>
- <para>Create a library.</para>
- <code>
- <![CDATA[
- <lib output="library.lib">
- <sources>
- <include name="library.obj" />
- </sources>
- </lib>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.LibTask.ExecuteTask">
- <summary>
- Creates the library.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.LibTask.NeedsCompiling">
- <summary>
- Determines if the sources need to be linked.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.Options">
- <summary>
- Options to pass to the compiler.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.OutputFile">
- <summary>
- The output file.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.ModuleDefinitionFile">
- <summary>
- The module definition file.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.Sources">
- <summary>
- The list of files to combine into the output file.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.Symbols">
- <summary>
- Symbols to add to the symbol table.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.IgnoreLibraries">
- <summary>
- Names of default libraries to ignore.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.LibDirs">
- <summary>
- The list of additional library directories to search.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>The filename of the external program.</value>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LibTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.VisualCpp.Tasks.LinkTask">
- <summary>
- Links files using <c>link.exe</c>, Microsoft's Incremental Linker.
- </summary>
- <remarks>
- <para>This task is intended for version 7.00.9466 of <c>link.exe</c>.</para>
- </remarks>
- <example>
- <para>
- Combine all object files in the current directory into <c>helloworld.exe</c>.
- </para>
- <code>
- <![CDATA[
- <link output="helloworld.exe">
- <sources>
- <include name="*.obj" />
- </sources>
- </link>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.LinkTask.ExecuteTask">
- <summary>
- Links the sources.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.LinkTask.NeedsLinking">
- <summary>
- Determines if the output needs linking.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.LinkTask.QuoteArgumentValue(System.String)">
- <summary>
- Quotes an argument value and duplicates trailing backslahes.
- </summary>
- <param name="value">The argument value to quote.</param>
- <returns>
- The quotes argument value.
- </returns>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.Options">
- <summary>
- Options to pass to the compiler.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.Debug">
- <summary>
- Create debugging information for the .exe file or DLL. The default is
- <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.OutputFile">
- <summary>
- The output file.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.ProgramDatabaseFile">
- <summary>
- A user-specified name for the program database (PDB) that the linker
- creates. The default file name for the PDB has the base name of the
- <see cref="P:NAnt.VisualCpp.Tasks.LinkTask.OutputFile"/> and the extension .pdb.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.DelayLoadedDlls">
- <summary>
- Specified DLLs for delay loading.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.Sources">
- <summary>
- The list of files to combine into the output file.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.LibDirs">
- <summary>
- The list of additional library directories to search.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.Modules">
- <summary>
- Link the specified modules into this assembly.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.EmbeddedResources">
- <summary>
- Embed the specified resources into this assembly.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.Symbols">
- <summary>
- Symbols to add to the symbol table.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.IgnoreLibraries">
- <summary>
- Names of libraries that you want the linker to ignore when it
- resolves external references.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>The filename of the external program.</value>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.LinkTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.VisualCpp.Tasks.McTask">
- <summary>
- Compiles messages using mc.exe, Microsoft's Win32 message compiler.
- </summary>
- <example>
- <para>
- Compile <c>text.mc</c> using the default options.
- </para>
- <code>
- <![CDATA[
- <mc mcfile="text.mc"/>
- ]]>
- </code>
- <para>
- Compile <c>text.mc</c>, passing a path to store the header, the rc
- file and some additonal options.
- </para>
- <code>
- <![CDATA[
- <mc mcfile="text.mc" headerpath=".\build" rcpath=".\build" options="-v -c -u"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.McTask.ExecuteTask">
- <summary>
- Compiles the sources.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.McTask.NeedsCompiling(System.String)">
- <summary>
- Determine if source files need re-building.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.McTask.Options">
- <summary>
- Options to pass to the compiler.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.McTask.HeaderPath">
- <summary>
- Path to store header file. The default is the project base directory.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.McTask.RCPath">
- <summary>
- Path to store RC file. The default is the project base directory.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.McTask.McFile">
- <summary>
- Input filename.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.McTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.McTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.VisualCpp.Tasks.MidlTask">
- <summary>
- This tasks allows you to run MIDL.exe.
- </summary>
- <remarks>
- <para>
- 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.
- </para>
- </remarks>
- <example>
- <code>
- <![CDATA[
- <midl
- env="win32"
- Oi="cf"
- tlb="${outputdir}\TempAtl.tlb"
- header="${outputdir}\TempAtl.h"
- iid="${outputdir}\TempAtl_i.c"
- proxy="${outputdir}\TempAtl_p.c"
- filename="TempAtl.idl"
- >
- <defines>
- <define name="_DEBUG"/>
- <define name="WIN32" value="1"/>
- </defines>
- <options>
- <option name="/mktyplib203"/>
- <option name="/error" value="allocation"/>
- </options>
- </midl>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.MidlTask.ExecuteTask">
- <summary>
- This is where the work is done.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.MidlTask.NeedsCompiling">
- <summary>
- Check output files to see if we need rebuilding.
- </summary>
- <see langword="true" /> if a rebuild is needed; otherwise,
- <see langword="false" />.
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.MidlTask.NeedsCompiling(System.IO.FileInfo)">
- <summary>
- Check output files to see if we need rebuilding.
- </summary>
- <returns>
- <see langword="true" /> if a rebuild is needed; otherwise,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.MidlTask.WriteResponseFile(System.IO.TextWriter)">
- <summary>
- Writes the response file for <c>midl.exe</c>.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Acf">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Align">
- <summary>
- 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.
- </summary>
- <remarks>The alignment value can be 1, 2, 4, or 8.</remarks>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.AppConfig">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Char">
- <summary>
- The /char switch helps to ensure that the MIDL compiler
- and C compiler operate together correctly for all char
- and small types.
- </summary>
- <remarks>Can be one of signed | unsigned | ascii7 </remarks>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Client">
- <summary>
- The /client switch directs the MIDL compiler to generate
- client-side C source files for an RPC interface
- </summary>
- <remarks>can be one of stub | none</remarks>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.CStub">
- <summary>
- The /cstub switch specifies the name of the client
- stub file for an RPC interface.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.DllData">
- <summary>
- Specifies the file name for the generated dlldata file for a proxy
- DLL. The default file name Dlldata.c is used if
- <see cref="P:NAnt.VisualCpp.Tasks.MidlTask.DllData"/> is not specified.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Env">
- <summary>
- The /env switch selects the
- environment in which the application runs.
- </summary>
- <remarks>It can take the values win32 and win64</remarks>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Oi">
- <summary>
- The /Oi switch directs the MIDL compiler to
- use a fully-interpreted marshaling method.
- The /Oic and /Oicf switches provide additional
- performance enhancements.
- </summary>
- <remarks>
- If you specify the Oi attribute, you must set it to
- one of the values:
- - Oi=""
- - Oi="c"
- - Oi="f"
- - Oi="cf"
- </remarks>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Tlb">
- <summary>
- Specifies a file name for the type library generated by the MIDL
- compiler.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Header">
- <summary>
- Specifies the name of the header file.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Iid">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Proxy">
- <summary>
- Specifies the name of the interface proxy file for a COM interface.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Filename">
- <summary>
- Name of .IDL file to process.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Options">
- <summary>
- Additional options to pass to midl.exe.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Defines">
- <summary>
- Macro definitions to pass to mdil.exe.
- Each entry will generate a /D
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.Undefines">
- <summary>
- Macro undefines (/U) to pass to mdil.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.IncludeDirs">
- <summary>
- The list of directories in which to search for include files.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.ProgramFileName">
- <summary>
- Filename of program to execute
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.MidlTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.VisualCpp.Tasks.RcTask">
- <summary>
- Compiles resources using <c>rc.exe</c>, Microsoft's Win32 resource
- compiler.
- </summary>
- <example>
- <para>
- Compile <c>text.rc</c> to <c>text.res</c> using the default options.
- </para>
- <code>
- <![CDATA[
- <rc rcfile="text.rc" output="text.res" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Compile <c>text.rc</c>, passing an additional option.
- </para>
- <code>
- <![CDATA[
- <rc rcfile="text.rc" options="/r"/>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.RcTask.ExecuteTask">
- <summary>
- Compile the resource file
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.RcTask.NeedsCompiling">
- <summary>
- Determines if the resource need compiling.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Tasks.RcTask.CheckResourceTimeStamp(System.String)">
- <summary>
- Check if a resource file has been updated.
- </summary>
- <param name="filePath"></param>
- <returns></returns>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.RcTask.Options">
- <summary>
- Options to pass to the compiler.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.RcTask.OutputFile">
- <summary>
- Output file.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.RcTask.RcFile">
- <summary>
- The resource file to compile.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.RcTask.LangId">
- <summary>
- Default language ID.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.RcTask.IncludeDirs">
- <summary>
- The list of directories in which to search for include files.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.RcTask.Defines">
- <summary>
- Macro definitions to pass to rc.exe.
- Each entry will generate a /d
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.RcTask.ProgramFileName">
- <summary>
- Filename of program to execute
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Tasks.RcTask.ProgramArguments">
- <summary>
- Arguments of program to execute
- </summary>
- </member>
- <member name="T:NAnt.VisualCpp.Types.CharacterSet">
- <summary>
- Defines the character sets that can be used by the C++ compiler.
- </summary>
- </member>
- <member name="F:NAnt.VisualCpp.Types.CharacterSet.NotSet">
- <summary>
- Have the compiler determine the character set.
- </summary>
- </member>
- <member name="F:NAnt.VisualCpp.Types.CharacterSet.Unicode">
- <summary>
- Unicode character set.
- </summary>
- </member>
- <member name="F:NAnt.VisualCpp.Types.CharacterSet.MultiByte">
- <summary>
- Multi-byte character set.
- </summary>
- </member>
- <member name="T:NAnt.VisualCpp.Types.Library">
- <summary>
- Represents a library.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.Library.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.Library"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.Library.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.Library"/> class with
- the specified name.
- </summary>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- </member>
- <member name="P:NAnt.VisualCpp.Types.Library.LibraryName">
- <summary>
- The name of the library.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Types.Library.IfDefined">
- <summary>
- If <see langword="true" /> then the element will be processed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Types.Library.UnlessDefined">
- <summary>
- If <see langword="true" /> then the element will be skipped;
- otherwise, processed. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.VisualCpp.Types.LibraryCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.VisualCpp.Types.Library"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.LibraryCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.#ctor(NAnt.VisualCpp.Types.LibraryCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.LibraryCollection"/> class
- with the specified <see cref="T:NAnt.VisualCpp.Types.LibraryCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.#ctor(NAnt.VisualCpp.Types.Library[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.LibraryCollection"/> class
- with the specified array of <see cref="T:NAnt.VisualCpp.Types.Library"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.Add(NAnt.VisualCpp.Types.Library)">
- <summary>
- Adds a <see cref="T:NAnt.VisualCpp.Types.Library"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Library"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.AddRange(NAnt.VisualCpp.Types.Library[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VisualCpp.Types.Library"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.VisualCpp.Types.Library"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.AddRange(NAnt.VisualCpp.Types.LibraryCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VisualCpp.Types.LibraryCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.VisualCpp.Types.LibraryCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.Contains(NAnt.VisualCpp.Types.Library)">
- <summary>
- Determines whether a <see cref="T:NAnt.VisualCpp.Types.Library"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Library"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.CopyTo(NAnt.VisualCpp.Types.Library[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.IndexOf(NAnt.VisualCpp.Types.Library)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.VisualCpp.Types.Library"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Library"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.VisualCpp.Types.Library"/>. If the <see cref="T:NAnt.VisualCpp.Types.Library"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.Insert(System.Int32,NAnt.VisualCpp.Types.Library)">
- <summary>
- Inserts a <see cref="T:NAnt.VisualCpp.Types.Library"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Library"/> to insert.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.VisualCpp.Types.LibraryEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryCollection.Remove(NAnt.VisualCpp.Types.Library)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Library"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.VisualCpp.Types.LibraryCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.VisualCpp.Types.LibraryEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.VisualCpp.Types.Library"/> elements of a <see cref="T:NAnt.VisualCpp.Types.LibraryCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryEnumerator.#ctor(NAnt.VisualCpp.Types.LibraryCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.LibraryEnumerator"/> class
- with the specified <see cref="T:NAnt.VisualCpp.Types.LibraryCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.LibraryEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Types.LibraryEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.VisualCpp.Types.Symbol">
- <summary>
- Represents a symbol.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.Symbol.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.Symbol"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.Symbol.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.Symbol"/> class with
- the specified name.
- </summary>
- <exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
- </member>
- <member name="P:NAnt.VisualCpp.Types.Symbol.SymbolName">
- <summary>
- The name of the symbol.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Types.Symbol.IfDefined">
- <summary>
- If <see langword="true" /> then the element will be processed;
- otherwise, skipped. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Types.Symbol.UnlessDefined">
- <summary>
- If <see langword="true" /> then the element will be skipped;
- otherwise, processed. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="T:NAnt.VisualCpp.Types.SymbolCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.VisualCpp.Types.Symbol"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.SymbolCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.#ctor(NAnt.VisualCpp.Types.SymbolCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.SymbolCollection"/> class
- with the specified <see cref="T:NAnt.VisualCpp.Types.SymbolCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.#ctor(NAnt.VisualCpp.Types.Symbol[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.SymbolCollection"/> class
- with the specified array of <see cref="T:NAnt.VisualCpp.Types.Symbol"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.Add(NAnt.VisualCpp.Types.Symbol)">
- <summary>
- Adds a <see cref="T:NAnt.VisualCpp.Types.Symbol"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Symbol"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.AddRange(NAnt.VisualCpp.Types.Symbol[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VisualCpp.Types.Symbol"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.VisualCpp.Types.Symbol"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.AddRange(NAnt.VisualCpp.Types.SymbolCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VisualCpp.Types.SymbolCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.VisualCpp.Types.SymbolCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.Contains(NAnt.VisualCpp.Types.Symbol)">
- <summary>
- Determines whether a <see cref="T:NAnt.VisualCpp.Types.Symbol"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Symbol"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.CopyTo(NAnt.VisualCpp.Types.Symbol[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.IndexOf(NAnt.VisualCpp.Types.Symbol)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.VisualCpp.Types.Symbol"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Symbol"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.VisualCpp.Types.Symbol"/>. If the <see cref="T:NAnt.VisualCpp.Types.Symbol"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.Insert(System.Int32,NAnt.VisualCpp.Types.Symbol)">
- <summary>
- Inserts a <see cref="T:NAnt.VisualCpp.Types.Symbol"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Symbol"/> to insert.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.VisualCpp.Types.SymbolEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolCollection.Remove(NAnt.VisualCpp.Types.Symbol)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VisualCpp.Types.Symbol"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.VisualCpp.Types.SymbolCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="T:NAnt.VisualCpp.Types.SymbolEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.VisualCpp.Types.Symbol"/> elements of a <see cref="T:NAnt.VisualCpp.Types.SymbolCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolEnumerator.#ctor(NAnt.VisualCpp.Types.SymbolCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VisualCpp.Types.SymbolEnumerator"/> class
- with the specified <see cref="T:NAnt.VisualCpp.Types.SymbolCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Types.SymbolEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.VisualCpp.Types.SymbolEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.VisualCpp.Util.BackslashProcessingMethod">
- <summary>
- Defines how to deal with backslashes in values of command line
- arguments.
- </summary>
- </member>
- <member name="F:NAnt.VisualCpp.Util.BackslashProcessingMethod.None">
- <summary>
- Does not perform any processing on backslashes.
- </summary>
- </member>
- <member name="F:NAnt.VisualCpp.Util.BackslashProcessingMethod.Duplicate">
- <summary>
- Duplicates the trailing backslash.
- </summary>
- </member>
- <member name="F:NAnt.VisualCpp.Util.BackslashProcessingMethod.Fix">
- <summary>
- Fixes the trailing backslash by replaces trailing double backslashes
- with only one backslash and removing single trailing backslashes.
- </summary>
- </member>
- <member name="F:NAnt.VisualCpp.Util.BackslashProcessingMethod.Clean">
- <summary>
- Removes all the trailing backslashes.
- </summary>
- </member>
- <member name="T:NAnt.VisualCpp.Util.ArgumentUtils">
- <summary>
- Groups a set of useful <see cref="T:System.String"/> manipulation methods for
- command-line arguments.
- </summary>
- </member>
- <member name="M:NAnt.VisualCpp.Util.ArgumentUtils.ProcessTrailingBackslash(System.String,NAnt.VisualCpp.Util.BackslashProcessingMethod)">
- <summary>
- Performs backslash processing on the specified value using a given
- method.
- </summary>
- <param name="value">The <see cref="T:System.String"/> to process.</param>
- <param name="processingMethod">The <see cref="T:NAnt.VisualCpp.Util.BackslashProcessingMethod"/> to use.</param>
- <returns>
- <paramref name="value"/> with backslashes processed using the given
- <see cref="T:NAnt.VisualCpp.Util.BackslashProcessingMethod"/>.
- </returns>
- </member>
- <member name="M:NAnt.VisualCpp.Util.ArgumentUtils.DuplicateTrailingBackslash(System.String)">
- <summary>
- Duplicates the trailing backslash.
- </summary>
- <param name="value">The input string to check and duplicate the trailing backslash if necessary.</param>
- <returns>The result string after being processed.</returns>
- <remarks>
- Also duplicates trailing backslash in quoted value.
- </remarks>
- </member>
- <member name="M:NAnt.VisualCpp.Util.ArgumentUtils.FixTrailingBackslash(System.String)">
- <summary>
- Fixes the trailing backslash. This function replaces the trailing double backslashes with
- only one backslash. It also, removes the single trailing backslash.
- </summary>
- <param name="value">The input string.</param>
- <returns>The result string after being processed.</returns>
- </member>
- <member name="M:NAnt.VisualCpp.Util.ArgumentUtils.CleanTrailingBackslash(System.String)">
- <summary>
- Removes all the trailing backslashes from the input.
- </summary>
- <param name="value">The input string.</param>
- <returns>The result string without trailing backslashes.</returns>
- </member>
- <member name="M:NAnt.VisualCpp.Util.ArgumentUtils.QuoteArgumentValue(System.String,NAnt.VisualCpp.Util.BackslashProcessingMethod)">
- <summary>
- Quotes an argument value and processes backslashes using a given
- <see cref="T:NAnt.VisualCpp.Util.BackslashProcessingMethod"/>.
- </summary>
- <param name="value">The argument value to quote.</param>
- <param name="processingMethod">The <see cref="T:NAnt.VisualCpp.Util.BackslashProcessingMethod"/> to use.</param>
- <returns>
- The quoted argument value.
- </returns>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.VSNetTasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.VSNetTasks.xml
@@ -1,3912 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.VSNetTasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.VSNet.Everett.Solution">
- <summary>
- Analyses Microsoft Visual Studio .NET 2003 (Everett) solution files.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.GetProjectFileFromGuid(System.String)">
- <summary>
- Gets the project file of the project with the given unique identifier.
- </summary>
- <param name="projectGuid">The unique identifier of the project for which the project file should be retrieves.</param>
- <returns>
- The project file of the project with the given unique identifier.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">No project with unique identifier <paramref name="projectGuid"/> could be located.</exception>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.Log(NAnt.Core.Level,System.String)">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to be logged.</param>
- <remarks>
- The actual logging is delegated to the underlying task.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- The actual logging is delegated to the underlying task.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.LoadProjects(NAnt.Core.Util.GacCache,NAnt.VSNet.ReferencesResolver,System.Collections.Hashtable)">
- <summary>
- Loads the projects from the file system and stores them in an
- instance variable.
- </summary>
- <param name="gacCache"><see cref="T:NAnt.Core.Util.GacCache"/> instance to use to determine whether an assembly is located in the Global Assembly Cache.</param>
- <param name="refResolver"><see cref="T:NAnt.VSNet.ReferencesResolver"/> instance to use to determine location and references of assemblies.</param>
- <param name="explicitProjectDependencies">TODO</param>
- <exception cref="T:NAnt.Core.BuildException">A project GUID in the solution file does not match the actual GUID of the project in the project file.</exception>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.TranslateProjectPath(System.String,System.String)">
- <summary>
- Translates a project path, in the form of a relative file path or
- a URL, to an absolute file path.
- </summary>
- <param name="solutionDir">The directory of the solution.</param>
- <param name="projectPath">The project path to translate to an absolute file path.</param>
- <returns>
- The project path translated to an absolute file path.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.FixProjectReferences(NAnt.VSNet.ProjectBase,System.String,System.Collections.Hashtable,System.Collections.Hashtable)">
- <summary>
- Converts assembly references to projects to project references, adding
- a build dependency.c
- </summary>
- <param name="project">The <see cref="T:NAnt.VSNet.ProjectBase"/> to analyze.</param>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <param name="builtProjects"><see cref="T:System.Collections.Hashtable"/> containing list of projects that have been built.</param>
- <param name="failedProjects"><see cref="T:System.Collections.Hashtable"/> containing list of projects that failed to build.</param>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.HasDirtyProjectDependency(NAnt.VSNet.ProjectBase,System.Collections.Hashtable)">
- <summary>
- Determines whether any of the project dependencies of the specified
- project still needs to be built.
- </summary>
- <param name="project">The <see cref="T:NAnt.VSNet.ProjectBase"/> to analyze.</param>
- <param name="builtProjects"><see cref="T:System.Collections.Hashtable"/> containing list of projects that have been built.</param>
- <returns>
- <see langword="true"/> if one of the project dependencies has not
- yet been built; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="P:NAnt.VSNet.SolutionBase.ProjectEntry.Project">
- <summary>
- Gets or sets the in memory representation of the project.
- </summary>
- <value>
- The in memory representation of the project, or <see langword="null" />
- if the project is not (yet) loaded.
- </value>
- <remarks>
- This property will always be <see langword="null" /> for
- projects that are not supported.
- </remarks>
- </member>
- <member name="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.#ctor(NAnt.VSNet.SolutionBase.ProjectEntryCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection"/> class
- with the specified <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.#ctor(NAnt.VSNet.SolutionBase.ProjectEntry[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection"/> class
- with the specified array of <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.Add(NAnt.VSNet.SolutionBase.ProjectEntry)">
- <summary>
- Adds a <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> to be added to the end of the collection.</param>
- <returns>
- The position into which the new element was inserted.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.AddRange(NAnt.VSNet.SolutionBase.ProjectEntry[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.AddRange(NAnt.VSNet.SolutionBase.ProjectEntryCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.Contains(NAnt.VSNet.SolutionBase.ProjectEntry)">
- <summary>
- Determines whether a <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> with the specified
- GUID is in the collection, using a case-insensitive lookup.
- </summary>
- <param name="value">The GUID to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> with GUID
- <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.CopyTo(NAnt.VSNet.SolutionBase.ProjectEntry[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.IndexOf(NAnt.VSNet.SolutionBase.ProjectEntry)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/>. If the <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.Insert(System.Int32,NAnt.VSNet.SolutionBase.ProjectEntry)">
- <summary>
- Inserts a <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> to insert.</param>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryCollection.Remove(NAnt.VSNet.SolutionBase.ProjectEntry)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.VSNet.SolutionBase.ProjectEntryCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.VSNet.SolutionBase.ProjectEntryCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> with the specified GUID.
- </summary>
- <param name="guid">The GUID of the <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> to get.</param>
- <remarks>
- Performs a case-insensitive lookup.
- </remarks>
- </member>
- <member name="T:NAnt.VSNet.SolutionBase.ProjectEntryEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntry"/> elements of a <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryEnumerator.#ctor(NAnt.VSNet.SolutionBase.ProjectEntryCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryEnumerator"/> class
- with the specified <see cref="T:NAnt.VSNet.SolutionBase.ProjectEntryCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.SolutionBase.ProjectEntryEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.SolutionBase.ProjectEntryEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.Extensibility.IProjectBuildProvider.IsSupported(System.String,System.Xml.XmlElement)">
- <summary>
- Returns a number representing how much this file fits this project type.
- </summary>
- <param name="projectExt"></param>
- <param name="xmlDefinition"></param>
- <returns></returns>
- <remarks>
- This enables the override in other providers. Do not return big numbers, mainly when compring only on filename.
- </remarks>
- </member>
- <member name="T:NAnt.VSNet.Rainier.Solution">
- <summary>
- Analyses Microsoft Visual Studio .NET 2002 (Rainier) solution files.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.Tasks.SolutionTask">
- <summary>
- Compiles VS.NET solutions (or sets of projects), automatically determining
- project dependencies from inter-project references.
- </summary>
- <remarks>
- <para>
- This task support the following projects:
- </para>
- <list type="bullet">
- <item>
- <description>Visual Basic .NET</description>
- </item>
- <item>
- <description>Visual C# .NET</description>
- </item>
- <item>
- <description>Visual J# .NET</description>
- </item>
- <item>
- <description>Visual C++ .NET</description>
- </item>
- </list>
- <note>
- Right now, only Microsoft Visual Studio .NET 2002 and 2003 solutions
- and projects are supported. Support for .NET Compact Framework projects
- is also not available at this time.
- </note>
- <para>
- The <see cref="T:NAnt.VSNet.Tasks.SolutionTask"/> also supports the model of referencing
- projects by their output filenames, rather than referencing them inside
- the solution. It will automatically detect the existance of a file
- reference and convert it to a project reference. For example, if project
- "A" references the file in the release output directory of
- project "B", the <see cref="T:NAnt.VSNet.Tasks.SolutionTask"/> will automatically
- convert this to a project dependency on project "B" and will
- reference the appropriate configuration output directory at the final
- build time (ie: reference the debug version of "B" if the
- solution is built as debug).
- </para>
- <note>
- The <see cref="T:NAnt.VSNet.Tasks.SolutionTask"/> expects all project files to be valid
- XML files.
- </note>
- <h3>Resx Files</h3>
- <para>
- When building a project for a down-level target framework, special care
- should be given to resx files. Resx files (can) contain references to
- a specific version of CLR types, and as such are only upward compatible.
- </para>
- <para>
- For example: if you want to be able to build a project both as a .NET 1.0
- and .NET 1.1 assembly, the resx files should only contain references to
- .NET 1.0 CLR types. Failure to do this may result in a <see cref="T:System.InvalidCastException"/>
- failure at runtime on machines with only the .NET Framework 1.0 installed.
- </para>
- </remarks>
- <example>
- <para>
- Compiles all of the projects in <c>test.sln</c>, in release mode, in
- the proper order.
- </para>
- <code>
- <![CDATA[
- <solution configuration="release" solutionfile="test.sln" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Compiles all of the projects in <c>projects.txt</c>, in the proper
- order.
- </para>
- <code>
- <![CDATA[
- <solution configuration="release">
- <projects>
- <includesfile name="projects.txt" />
- </projects>
- </solution>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Compiles projects A, B and C, using the output of project X as a
- reference.
- </para>
- <code>
- <![CDATA[
- <solution configuration="release">
- <projects>
- <include name="A\A.csproj" />
- <include name="B\b.vbproj" />
- <include name="C\c.csproj" />
- </projects>
- <referenceprojects>
- <include name="X\x.csproj" />
- </referenceprojects>
- </solution>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Compiles all of the projects in the solution except for project A.
- </para>
- <code>
- <![CDATA[
- <solution solutionfile="test.sln" configuration="release">
- <excludeprojects>
- <include name="A\A.csproj" />
- </excludeprojects>
- </solution>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Compiles all of the projects in the solution mapping the specific project at
- http://localhost/A/A.csproj to c:\inetpub\wwwroot\A\A.csproj and any URLs under
- http://localhost/B/[remainder] to c:\other\B\[remainder]. This allows the build
- to work without WebDAV.
- </para>
- <code>
- <![CDATA[
- <solution solutionfile="test.sln" configuration="release">
- <webmap>
- <map url="http://localhost/A/A.csproj" path="c:\inetpub\wwwroot\A\A.csproj" />
- <map url="http://localhost/B" path="c:\other\B" />
- </webmap>
- </solution>
- ]]>
- </code>
- </example>
- <example>
- <para>
- Compiles all of the projects in the solution placing compiled outputs
- in <c>c:\temp</c>.</para>
- <code>
- <![CDATA[
- <solution solutionfile="test.sln" configuration="release" outputdir="c:\temp" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.VSNet.Tasks.SolutionTask.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.Tasks.SolutionTask"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.Tasks.SolutionTask.ExpandMacro(System.String)">
- <summary>
- Expands the given macro.
- </summary>
- <param name="macro">The macro to expand.</param>
- <returns>
- The expanded macro or <see langword="null"/> if the macro is not
- supported.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">The macro cannot be expanded.</exception>
- </member>
- <member name="M:NAnt.VSNet.Tasks.SolutionTask.BuildAssemblyFolders">
- <summary>
- Builds the list of folders that should be scanned for assembly
- references.
- </summary>
- <returns>
- The list of folders that should be scanned for assembly references.
- </returns>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.Projects">
- <summary>
- The projects to build.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.ReferenceProjects">
- <summary>
- The projects to scan, but not build.
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.SolutionFile">
- <summary>
- The name of the VS.NET solution file to build.
- </summary>
- <remarks>
- <para>
- The <see cref="P:NAnt.VSNet.Tasks.SolutionTask.Projects"/> can be used instead to supply a list
- of Visual Studio.NET projects that should be built.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.Configuration">
- <summary>
- The name of the solution configuration to build.
- </summary>
- <remarks>
- <para>
- Generally <c>release</c> or <c>debug</c>. Not case-sensitive.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.OutputDir">
- <summary>
- The directory where compiled targets will be placed. This
- overrides path settings contained in the solution/project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.WebMaps">
- <summary>
- WebMap of URL's to project references.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.ExcludeProjects">
- <summary>
- Fileset of projects to exclude.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.AssemblyFolders">
- <summary>
- Set of folders where references are searched when not found in path
- from project file (HintPath).
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.IncludeVSFolders">
- <summary>
- Includes Visual Studio search folders in reference search path.
- The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.EnableWebDav">
- <summary>
- Allow the task to use WebDAV for retrieving/compiling the projects within solution. Use of
- <see cref="T:NAnt.VSNet.Types.WebMap"/> is preferred over WebDAV. The default is <see langword="false"/>.
- </summary>
- <remarks>
- <para>WebDAV support requires permission changes to be made on your project server. These changes may affect
- the security of the server and should not be applied to a public installation.</para>
- <para>Consult your web server or the NAnt Wiki documentation for more information.</para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.Tasks.SolutionTask.AssemblyFolderList">
- <summary>
- Gets the list of folders to scan for assembly references.
- </summary>
- <value>
- The list of folders to scan for assembly references.
- </value>
- </member>
- <member name="T:NAnt.VSNet.Types.UseOfATL">
- <summary>
- Defines how the project is using the ATL library.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.Types.UseOfATL.NotUsing">
- <summary>
- Don't use ATL.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.Types.UseOfATL.Static">
- <summary>
- Use ATL in a Static Library.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.Types.UseOfATL.Shared">
- <summary>
- Use ATL in a Shared DLL.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.Types.UseOfMFC">
- <summary>
- Defines how the project is using the MFC library.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.Types.UseOfMFC.NotUsing">
- <summary>
- Don't use MFC.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.Types.UseOfMFC.Static">
- <summary>
- Use MFC in a Static Library.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.Types.UseOfMFC.Shared">
- <summary>
- Use MFC in a Shared DLL.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.Types.UsePrecompiledHeader">
- <summary>
- Indicates the possible ways in which precompiled header file use is
- specified in a Visual C++ project.
- </summary>
- <remarks>
- The integer values assigned match those specified in the Visual C++
- project file for each setting.
- </remarks>>
- </member>
- <member name="F:NAnt.VSNet.Types.UsePrecompiledHeader.Unspecified">
- <summary>
- Precompiled header file use not specified.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.Types.UsePrecompiledHeader.No">
- <summary>
- Don't use a precompiled header file.
- </summary>
- <remarks>
- For further information on the use of this option
- see the Microsoft documentation on the C++ compiler flag /Yc.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.Types.UsePrecompiledHeader.Create">
- <summary>
- Create precompiled header file.
- </summary>
- <remarks>
- For further information on the use of this option
- see the Microsoft documentation on the C++ compiler flag /Yc.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.Types.UsePrecompiledHeader.AutoCreate">
- <summary>
- Automatically create precompiled header file if necessary.
- </summary>
- <remarks>
- For further information on the use of this option
- see the Microsoft documentation on the C++ compiler flag /Yc.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.Types.UsePrecompiledHeader.Use">
- <summary>
- Use a precompiled header file.
- </summary>
- <remarks>
- For further information on the use of this option
- see the Microsoft documentation on the C++ compiler flag /Yu.
- </remarks>
- </member>
- <member name="T:NAnt.VSNet.Types.WebMap">
- <summary>
- Represents a single mapping from URL project path to physical project
- path.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Types.WebMap.Url">
- <summary>
- Specifies the URL of the project file, or a URL fragment to match.
- </summary>
- <value>
- The URL of the project file or the URL fragment to match.
- </value>
- </member>
- <member name="P:NAnt.VSNet.Types.WebMap.Path">
- <summary>
- Specifies the actual path to the project file, or the path fragment
- to replace.
- </summary>
- <value>
- The actual path to the project file or the path fragment to replace
- the URL fragment with.
- </value>
- </member>
- <member name="P:NAnt.VSNet.Types.WebMap.CaseSensitive">
- <summary>
- Specifies whether the mapping is case-sensitive or not.
- </summary>
- <value>
- A boolean flag representing the case-sensitivity of the mapping. Default is <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.VSNet.Types.WebMap.IfDefined">
- <summary>
- Indicates if the URL of the project file should be mapped.
- </summary>
- <value>
- <see langword="true" /> if the URL of the project file should be
- mapped; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.VSNet.Types.WebMap.UnlessDefined">
- <summary>
- Indicates if the URL of the project file should not be mapped.
- </summary>
- <value>
- <see langword="true" /> if the URL of the project file should not
- be mapped; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.VSNet.Types.WebMapCollection">
- <summary>
- Contains a strongly typed collection of <see cref="T:NAnt.VSNet.Types.WebMap"/>
- objects.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.Types.WebMapCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.#ctor(NAnt.VSNet.Types.WebMapCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.Types.WebMapCollection"/> class
- with the specified <see cref="T:NAnt.VSNet.Types.WebMapCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.#ctor(NAnt.VSNet.Types.WebMap[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.Types.WebMapCollection"/> class
- with the specified array of <see cref="T:NAnt.VSNet.Types.WebMap"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.FindBestMatch(System.String)">
- <summary>
- Find the best matching <see cref="T:NAnt.VSNet.Types.WebMap"/> for the given Uri.
- </summary>
- <param name="uri">The value to match against the <see cref="T:NAnt.VSNet.Types.WebMap"/> objects in the collection.</param>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.Add(NAnt.VSNet.Types.WebMap)">
- <summary>
- Adds a <see cref="T:NAnt.VSNet.Types.WebMap"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.Types.WebMap"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.AddRange(NAnt.VSNet.Types.WebMap[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VSNet.Types.WebMap"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.VSNet.Types.WebMap"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.AddRange(NAnt.VSNet.Types.WebMapCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VSNet.Types.WebMapCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.VSNet.Types.WebMapCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.Contains(NAnt.VSNet.Types.WebMap)">
- <summary>
- Determines whether a <see cref="T:NAnt.VSNet.Types.WebMap"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.Types.WebMap"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.VSNet.Types.WebMap"/> with the specified
- value is in the collection.
- </summary>
- <param name="value">The argument value to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.VSNet.Types.WebMap"/> with value
- <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.CopyTo(NAnt.VSNet.Types.WebMap[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.IndexOf(NAnt.VSNet.Types.WebMap)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.VSNet.Types.WebMap"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.Types.WebMap"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.VSNet.Types.WebMap"/>. If the <see cref="T:NAnt.VSNet.Types.WebMap"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.Insert(System.Int32,NAnt.VSNet.Types.WebMap)">
- <summary>
- Inserts a <see cref="T:NAnt.VSNet.Types.WebMap"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.VSNet.Types.WebMap"/> to insert.</param>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.VSNet.Types.WebMapEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapCollection.Remove(NAnt.VSNet.Types.WebMap)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.Types.WebMap"/> to remove from the collection.</param>
- </member>
- <member name="P:NAnt.VSNet.Types.WebMapCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.VSNet.Types.WebMapCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.VSNet.Types.WebMap"/> with the specified value.
- </summary>
- <param name="value">The value of the <see cref="T:NAnt.VSNet.Types.WebMap"/> to get.</param>
- </member>
- <member name="T:NAnt.VSNet.Types.WebMapEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.VSNet.Types.WebMap"/> elements of a <see cref="T:NAnt.VSNet.Types.WebMapCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapEnumerator.#ctor(NAnt.VSNet.Types.WebMapCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.Types.WebMapEnumerator"/> class
- with the specified <see cref="T:NAnt.VSNet.Types.WebMapCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.Types.WebMapEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Types.WebMapEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ReferenceBase.GetPrimaryOutputFile(System.String)">
- <summary>
- Gets the output path of the reference, without taking the "copy local"
- setting into consideration.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The full output path of the reference.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ReferenceBase.GetOutputFiles(System.String,System.Collections.Hashtable)">
- <summary>
- Gets the complete set of output files of the reference for the
- specified configuration.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <param name="outputFiles">The set of output files to be updated.</param>
- <remarks>
- The key of the case-insensitive <see cref="T:System.Collections.Hashtable"/> is the
- full path of the output file and the value is the path relative to
- the output directory.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ReferenceBase.GetAssemblyReferences(System.String)">
- <summary>
- Gets the complete set of assemblies that need to be referenced when
- a project references this component.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The complete set of assemblies that need to be referenced when a
- project references this component.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ReferenceBase.GetTimestamp(System.String)">
- <summary>
- Gets the timestamp of the reference.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The timestamp of the reference.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ReferenceBase.IsManaged(System.String)">
- <summary>
- Gets a value indicating whether the reference is managed for the
- specified configuration.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- <see langword="true" /> if the reference is managed for the
- specified configuration; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ReferenceBase.GetFileTimestamp(System.String)">
- <summary>
- Returns the date and time the specified file was last written to.
- </summary>
- <param name="fileName">The file for which to obtain write date and time information.</param>
- <returns>
- A <see cref="T:System.DateTime"/> structure set to the date and time that
- the specified file was last written to, or
- <see cref="F:System.DateTime.MaxValue"/> if the specified file does not
- exist.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ReferenceBase.Log(NAnt.Core.Level,System.String)">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to be logged.</param>
- <remarks>
- The actual logging is delegated to the underlying task.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ReferenceBase.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- The actual logging is delegated to the underlying task.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ReferenceBase.CopyLocal">
- <summary>
- Gets a value indicating whether the output file(s) of this reference
- should be copied locally.
- </summary>
- <value>
- <see langword="true" /> if the output file(s) of this reference
- should be copied locally; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ReferenceBase.IsSystem">
- <summary>
- Gets a value indicating whether this reference represents a system
- assembly.
- </summary>
- <value>
- <see langword="true" /> if this reference represents a system
- assembly; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ReferenceBase.Parent">
- <summary>
- Gets the project in which the reference is defined.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.FileReferenceBase.IsManaged(System.String)">
- <summary>
- Gets a value indicating whether the reference is managed for the
- specified configuration.
- </summary>
- <param name="config">The build configuration of the reference.</param>
- <returns>
- <see langword="true" />.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.FileReferenceBase.GetAssemblyOutputFiles(System.String,System.Collections.Hashtable)">
- <summary>
- Gets the complete set of output files for the specified assembly
- and adds them to <paremref name="outputFiles"/> collection.
- </summary>
- <param name="assemblyFile">The path of the assembly to get the output files for.</param>
- <param name="outputFiles">The set of output files to be updated.</param>
- <remarks>
- The key of the case-insensitive <see cref="T:System.Collections.Hashtable"/> is the
- full path of the output file and the value is the path relative to
- the output directory.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.AssemblyReferenceBase.GetPrimaryOutputFile(System.String)">
- <summary>
- Gets the path of the reference, without taking the "copy local"
- setting into consideration.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The output path of the reference.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.AssemblyReferenceBase.GetOutputFiles(System.String,System.Collections.Hashtable)">
- <summary>
- Gets the complete set of output files for the referenced project.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <param name="outputFiles">The set of output files to be updated.</param>
- <remarks>
- The key of the case-insensitive <see cref="T:System.Collections.Hashtable"/> is the
- full path of the output file and the value is the path relative to
- the output directory.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.AssemblyReferenceBase.GetAssemblyReferences(System.String)">
- <summary>
- Gets the complete set of assemblies that need to be referenced when
- a project references this component.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The complete set of assemblies that need to be referenced when a
- project references this component.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.AssemblyReferenceBase.GetTimestamp(System.String)">
- <summary>
- Gets the timestamp of the reference.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The timestamp of the reference.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.AssemblyReferenceBase.ResolveAssemblyReference">
- <summary>
- Resolves an assembly reference.
- </summary>
- <returns>
- The full path to the resolved assembly, or <see langword="null" />
- if the assembly reference could not be resolved.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.AssemblyReferenceBase.ResolveFromFolderList(System.Collections.Specialized.StringCollection,System.String)">
- <summary>
- Searches for the given file in all paths in <paramref name="folderList" />.
- </summary>
- <param name="folderList">The folders to search.</param>
- <param name="fileName">The file to search for.</param>
- <returns>
- The path of the assembly if <paramref name="fileName" /> was found
- in <paramref name="folderList" />; otherwise, <see langword="null" />.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.AssemblyReferenceBase.ResolveFromFramework(System.String)">
- <summary>
- Resolves an assembly reference in the framework assembly directory
- of the target framework.
- </summary>
- <param name="fileName">The file to search for.</param>
- <returns>
- The full path of the assembly file if the assembly could be located
- in the framework assembly directory; otherwise, <see langword="null" />.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.AssemblyReferenceBase.ResolveFromRelativePath(System.String)">
- <summary>
- Resolves an assembly reference using a path relative to the project
- directory.
- </summary>
- <returns>
- The full path of the assembly, or <see langword="null"/> if
- <paramref name="relativePath"/> is <see langword="null"/> or an
- empty <see cref="T:System.String"/>.
- </returns>
- </member>
- <member name="P:NAnt.VSNet.AssemblyReferenceBase.CopyLocal">
- <summary>
- Gets a value indicating whether the output file(s) of this reference
- should be copied locally.
- </summary>
- <value>
- <see langword="true" /> if the output file(s) of this reference
- should be copied locally; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.VSNet.AssemblyReferenceBase.IsSystem">
- <summary>
- Gets a value indicating whether this reference represents a system
- assembly.
- </summary>
- <value>
- <see langword="true" /> if this reference represents a system
- assembly; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.VSNet.ProjectBase">
- <summary>
- Base class for all project classes.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.#ctor(System.Xml.XmlElement,NAnt.VSNet.Tasks.SolutionTask,System.CodeDom.Compiler.TempFileCollection,NAnt.Core.Util.GacCache,NAnt.VSNet.ReferencesResolver,System.IO.DirectoryInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.ProjectBase"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.GetOutputFiles(System.String,System.Collections.Hashtable)">
- <summary>
- Gets the complete set of output files for the project.
- configuration.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <param name="outputFiles">The set of output files to be updated.</param>
- <remarks>
- The key of the case-insensitive <see cref="T:System.Collections.Hashtable"/> is the
- full path of the output file and the value is the path relative to
- the output directory.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.IsManaged(System.String)">
- <summary>
- Gets a value indicating whether building the project for the specified
- build configuration results in managed output.
- </summary>
- <param name="configuration">The build configuration.</param>
- <returns>
- <see langword="true" /> if the project output for the given build
- configuration is managed; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.ExpandMacro(System.String)">
- <summary>
- Expands the given macro.
- </summary>
- <param name="macro">The macro to expand.</param>
- <returns>
- The expanded macro or <see langword="null" /> if the macro is not
- supported.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.DetermineProductVersion(System.Xml.XmlElement)">
- <summary>
- Returns the Visual Studio product version of the specified project
- XML fragment.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <returns>
- The Visual Studio product version of the specified project XML
- file.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The product version could not be determined.</para>
- <para>-or-</para>
- <para>The product version is not supported.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.VerifyProjectXml(System.Xml.XmlElement)">
- <summary>
- Verifies whether the specified XML fragment represents a valid project
- that is supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The XML fragment is not supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.</para>
- <para>-or-</para>
- <para>The XML fragment does not represent a valid project (for this <see cref="T:NAnt.VSNet.ProjectBase"/>).</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.Prepare(System.String)">
- <summary>
- Prepares the project for being built.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <remarks>
- The default implementation will ensure that none of the output files
- are marked read-only.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.CopyFile(System.IO.FileInfo,System.IO.FileInfo,NAnt.Core.Task)">
- <summary>
- Copies the specified file if the destination file does not exist, or
- the source file has been modified since it was previously copied.
- </summary>
- <param name="srcFile">The file to copy.</param>
- <param name="destFile">The destination file.</param>
- <param name="parent">The <see cref="T:NAnt.Core.Task"/> in which context the operation will be performed.</param>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.Log(NAnt.Core.Level,System.String)">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to be logged.</param>
- <remarks>
- The actual logging is delegated to the underlying task.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ProjectBase.Log(NAnt.Core.Level,System.String,System.Object[])">
- <summary>
- Logs a message with the given priority.
- </summary>
- <param name="messageLevel">The message priority at which the specified message is to be logged.</param>
- <param name="message">The message to log, containing zero or more format items.</param>
- <param name="args">An <see cref="T:System.Object"/> array containing zero or more objects to format.</param>
- <remarks>
- The actual logging is delegated to the underlying task.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ProductVersion">
- <summary>
- Gets the Visual Studio product version of the project.
- </summary>
- <value>
- The Visual Studio product version of the project.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.Name">
- <summary>
- Gets the name of the VS.NET project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.Type">
- <summary>
- Gets the type of the project.
- </summary>
- <value>
- The type of the project.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ProjectPath">
- <summary>
- Gets the path of the VS.NET project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ProjectDirectory">
- <summary>
- Gets the directory containing the VS.NET project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ProjectLocation">
- <summary>
- Get the location of the project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ObjectDir">
- <summary>
- Get the directory in which intermediate build output that is not
- specific to the build configuration will be stored.
- </summary>
- <remarks>
- <para>
- For <see cref="F:NAnt.VSNet.ProjectLocation.Local"/> projects, this is defined
- as <c><Project Directory<\obj</c>.
- </para>
- <para>
- For <see cref="F:NAnt.VSNet.ProjectLocation.Web"/> projects, this is defined
- as <c>%HOMEPATH%\VSWebCache\<Machine Name>\<Project Directory>\obj</c>.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.Guid">
- <summary>
- Gets or sets the unique identifier of the VS.NET project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ProjectConfigurations">
- <summary>
- Gets a case-insensitive list of project configurations.
- </summary>
- <remarks>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the name of the
- configuration and the value is a <see cref="T:NAnt.VSNet.ConfigurationBase"/>
- instance.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.BuildConfigurations">
- <summary>
- Gets a list of project configurations that can be build.
- </summary>
- <remarks>
- <para>
- Project configurations that are not in this list do not need to be
- compiled (unless the project was not loaded through a solution file).
- </para>
- <para>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the name of the
- configuration and the value is a <see cref="T:NAnt.VSNet.ConfigurationBase"/>
- instance.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ExtraOutputFiles">
- <summary>
- Gets the extra set of output files for the project.
- </summary>
- <value>
- The extra set of output files for the project.
- </value>
- <remarks>
- The key of the case-insensitive <see cref="T:System.Collections.Hashtable"/> is the
- full path of the output file and the value is the path relative to
- the output directory.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ProjectDependencies">
- <summary>
- Gets the set of projects that the project depends on.
- </summary>
- <value>
- The set of projects that the project depends on.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ProjectBase.ProductVersionNumber">
- <summary>
- TODO: refactor this !!!
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.IsManaged(System.String)">
- <summary>
- Gets a value indicating whether building the project for the specified
- build configuration results in managed output.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- <see langword="true" />.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.Prepare(System.String)">
- <summary>
- Prepares the project for being built.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <remarks>
- Ensures the configuration-level object directory exists and ensures
- that none of the output files are marked read-only.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.GetProcessStartInfo(NAnt.VSNet.ConfigurationBase,System.String)">
- <summary>
- Returns a <see cref="T:System.Diagnostics.ProcessStartInfo"/> for launching the compiler
- for this project.
- </summary>
- <param name="config">The configuration to build.</param>
- <param name="responseFile">The response file for the compiler.</param>
- <returns>
- A <see cref="T:System.Diagnostics.ProcessStartInfo"/> for launching the compiler for
- this project.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.DetermineProjectLocation(System.Xml.XmlElement)">
- <summary>
- Returns the project location from the specified project XML fragment.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <returns>
- The project location of the specified project XML file.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The project location could not be determined.</para>
- <para>-or-</para>
- <para>The project location is invalid.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.GetTypeLibraryPath(NAnt.VSNet.ConfigurationSettings)">
- <summary>
- Gets the absolute path of the type library for the project
- output.
- </summary>
- <param name="config">The configuration to build.</param>
- <returns>
- The absolute path of the type library for the project output.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.RegisterForComInterop(NAnt.VSNet.ConfigurationSettings,System.String)">
- <summary>
- Generates a type library for the specified assembly, registers it.
- </summary>
- <param name="config">The project configuration that is built.</param>
- <param name="typelibPath">The path of the type library to generate.</param>
- <remarks>
- The <c>regasm</c> tool is used to generate the type library.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.UnregisterForComInterop(NAnt.VSNet.ConfigurationSettings)">
- <summary>
- Unregister a type library for the specified assembly, and the types
- in that assembly.
- </summary>
- <param name="config">The project configuration that is built.</param>
- <remarks>
- The <c>regasm</c> tool is used to unregister the type library, and
- remove the COM registration for types in the specified assembly.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.GetLocalizedResources">
- <summary>
- Returns <see cref="T:System.Collections.Hashtable"/> containing culture-specific resources.
- </summary>
- <returns>
- A <see cref="T:System.Collections.Hashtable"/> containing culture-specific resources.
- </returns>
- <remarks>
- The key of the <see cref="T:System.Collections.Hashtable"/> is <see cref="T:System.Globalization.CultureInfo"/>
- and the value is an <see cref="T:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet"/> instance
- for that culture.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.CreateRegAsmTask">
- <summary>
- Creates and initializes a <see cref="T:NAnt.Win32.Tasks.RegAsmTask"/> instance.
- </summary>
- <returns>
- An initialized <see cref="T:NAnt.Win32.Tasks.RegAsmTask"/> instance.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.GetProductVersion(System.Xml.XmlNode)">
- <summary>
- Returns the Visual Studio product version of the specified project
- XML fragment.
- </summary>
- <param name="projectNode">XML fragment representing the project to check.</param>
- <returns>
- The Visual Studio product version of the specified project XML
- fragment.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The product version could not be determined.</para>
- <para>-or-</para>
- <para>The product version is not supported.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.GetProjectLocation(System.Xml.XmlNode)">
- <summary>
- Returns the <see cref="P:NAnt.VSNet.ManagedProjectBase.ProjectLocation"/> of the specified project
- XML fragment.
- </summary>
- <param name="projectNode">XML fragment representing the project to check.</param>
- <returns>
- The <see cref="P:NAnt.VSNet.ManagedProjectBase.ProjectLocation"/> of the specified project XML
- fragment.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The project location could not be determined.</para>
- <para>-or-</para>
- <para>The project location is invalid.</para>
- </exception>
- </member>
- <member name="F:NAnt.VSNet.ManagedProjectBase._sourceFiles">
- <summary>
- Holds a case-insensitive list of source files.
- </summary>
- <remarks>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the full path of the
- source file and the value is <see langword="null"/>.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.FileExtension">
- <summary>
- Gets the default file extension of sources for this project.
- </summary>
- <value>
- The default file extension of sources for this project.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.IsWebProject">
- <summary>
- Gets a value indicating if this is a web project.
- </summary>
- <value>
- <see langword="true"/> if this is a web project; otherwise,
- <see langword="false"/>.
- </value>
- <remarks>
- If the url of a web project has been mapped to a local path
- (using the <webmap> element), then this property will return
- <see langword="false"/> for a <see cref="F:NAnt.VSNet.ProjectLocation.Web"/>
- project.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.Name">
- <summary>
- Gets the name of the VS.NET project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.ProjectPath">
- <summary>
- Gets the path of the VS.NET project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.ProjectDirectory">
- <summary>
- Gets the directory containing the VS.NET project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.ProjectLocation">
- <summary>
- Get the location of the project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.Guid">
- <summary>
- Gets or sets the unique identifier of the VS.NET project.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet">
- <summary>
- Groups a set of <see cref="T:NAnt.VSNet.Resource"/> instances for a specific
- culture.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet.#ctor(System.Globalization.CultureInfo)">
- <summary>
- Initializes a new <see cref="T:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet"/> instance
- for the specified culture.
- </summary>
- <param name="culture">A <see cref="T:System.Globalization.CultureInfo"/>.</param>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet.GetBuildDirectory(NAnt.VSNet.ConfigurationSettings)">
- <summary>
- Gets the intermediate build directory in which the satellite
- assembly is built.
- </summary>
- <param name="projectConfig">The project build configuration.</param>
- <returns>
- The intermediate build directory in which the satellite assembly
- is built.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet.GetSatelliteAssemblyPath(NAnt.VSNet.ConfigurationSettings,NAnt.VSNet.ProjectSettings)">
- <summary>
- Gets a <see cref="T:System.IO.FileInfo"/> representing the path to the
- intermediate file location of the satellite assembly.
- </summary>
- <param name="projectConfig">The project build configuration.</param>
- <param name="projectSettings">The project settings.</param>
- <returns>
- A <see cref="T:System.IO.FileInfo"/> representing the path to the
- intermediate file location of the satellite assembly.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet.GetRelativePath(NAnt.VSNet.ProjectSettings)">
- <summary>
- Gets path of the satellite assembly, relative to the output
- directory.
- </summary>
- <param name="projectSettings">The project settings.</param>
- <returns>
- The path of the satellite assembly, relative to the output
- directory.
- </returns>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet.Culture">
- <summary>
- Gets the <see cref="T:System.Globalization.CultureInfo"/> of the
- <see cref="T:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet"/>.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ManagedProjectBase.LocalizedResourceSet.Resources">
- <summary>
- Gets the set of localized resources.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.CSharpProject.VerifyProjectXml(System.Xml.XmlElement)">
- <summary>
- Verifies whether the specified XML fragment represents a valid project
- that is supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The XML fragment is not supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.</para>
- <para>-or-</para>
- <para>The XML fragment does not represent a valid project (for this <see cref="T:NAnt.VSNet.ProjectBase"/>).</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.CSharpProject.DetermineProductVersion(System.Xml.XmlElement)">
- <summary>
- Returns the Visual Studio product version of the specified project
- XML fragment.
- </summary>
- <param name="docElement">The document element of the project.</param>
- <returns>
- The Visual Studio product version of the specified project XML
- fragment.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The product version could not be determined.</para>
- <para>-or-</para>
- <para>The product version is not supported.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.CSharpProject.GetProcessStartInfo(NAnt.VSNet.ConfigurationBase,System.String)">
- <summary>
- Returns a <see cref="T:System.Diagnostics.ProcessStartInfo"/> for launching the compiler
- for this project.
- </summary>
- <param name="config">The configuration to build.</param>
- <param name="responseFile">The response file for the compiler.</param>
- <returns>
- A <see cref="T:System.Diagnostics.ProcessStartInfo"/> for launching the compiler for
- this project.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.CSharpProject.DetermineProjectLocation(System.Xml.XmlElement)">
- <summary>
- Returns the project location from the specified project XML fragment.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <returns>
- The project location of the specified project XML file.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The project location could not be determined.</para>
- <para>-or-</para>
- <para>The project location is invalid.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.CSharpProject.IsSupported(System.Xml.XmlElement)">
- <summary>
- Returns a value indicating whether the project represented by the
- specified XML fragment is supported by <see cref="T:NAnt.VSNet.CSharpProject"/>.
- </summary>
- <param name="docElement">XML fragment representing the project to check.</param>
- <returns>
- <see langword="true"/> if <see cref="T:NAnt.VSNet.CSharpProject"/> supports
- the specified project; otherwise, <see langword="false"/>.
- </returns>
- <remarks>
- <para>
- A project is identified as as C# project, if the XML fragment at
- least has the following information:
- </para>
- <code>
- <![CDATA[
- <VisualStudioProject>
- <CSHARP
- ProductVersion="..."
- ....
- >
- ...
- </CSHARP>
- </VisualStudioProject>
- ]]>
- </code>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.CSharpProject.Type">
- <summary>
- Gets the type of the project.
- </summary>
- <value>
- The type of the project.
- </value>
- </member>
- <member name="P:NAnt.VSNet.CSharpProject.FileExtension">
- <summary>
- Gets the default file extension of sources for this project.
- </summary>
- <value>
- For C# projects, the default file extension is ".cs".
- </value>
- </member>
- <member name="M:NAnt.VSNet.ConfigurationBase.#ctor(NAnt.VSNet.ProjectBase)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.ConfigurationBase"/>
- class with the given <see cref="T:NAnt.VSNet.ProjectBase"/>.
- </summary>
- <param name="project">The project of the configuration.</param>
- </member>
- <member name="M:NAnt.VSNet.ConfigurationBase.ExpandMacro(System.String)">
- <summary>
- Expands the given macro.
- </summary>
- <param name="macro">The macro to expand.</param>
- <returns>
- The expanded macro.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The macro is not supported.</para>
- <para>-or-</para>
- <para>The macro is not implemented.</para>
- <para>-or-</para>
- <para>The macro cannot be expanded.</para>
- </exception>
- <exception cref="T:System.NotImplementedException">
- <para>Expansion of a given macro is not yet implemented.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.ConfigurationBase.EvaluateMacro(System.Text.RegularExpressions.Match)">
- <summary>
- Is called each time a regular expression match is found during a
- <see cref="M:System.Text.RegularExpressions.Regex.Replace(System.String,System.Text.RegularExpressions.MatchEvaluator)"/> operation.
- </summary>
- <param name="m">The <see cref="T:System.Text.RegularExpressions.Match"/> resulting from a single regular expression match during a <see cref="M:System.Text.RegularExpressions.Regex.Replace(System.String,System.Text.RegularExpressions.MatchEvaluator)"/>.</param>
- <returns>
- The expanded <see cref="T:System.Text.RegularExpressions.Match"/>.
- </returns>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.Project">
- <summary>
- Gets the project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.Name">
- <summary>
- Gets the name of the configuration.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.ObjectDir">
- <summary>
- Get the directory in which intermediate build output will be stored
- for this configuration.
- </summary>
- <remarks>
- <para>
- This is a directory relative to the project directory named
- <c>obj\<configuration name></c>.
- </para>
- <para>
- <c>.resx</c> and <c>.licx</c> files will only be recompiled if the
- compiled resource files in the <see cref="P:NAnt.VSNet.ConfigurationBase.ObjectDir"/> are not
- uptodate.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.OutputDir">
- <summary>
- Gets the output directory.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.OutputPath">
- <summary>
- Gets the path for the output file.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.BuildPath">
- <summary>
- Gets the path in which the output file will be created before its
- copied to the actual output path.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.RelativeOutputDir">
- <summary>
- Get the path of the output directory relative to the project
- directory.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.PlatformName">
- <summary>
- Gets the platform that the configuration targets.
- </summary>
- <value>
- The platform targeted by the configuration.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationBase.ExtraOutputFiles">
- <summary>
- Gets the set of output files that is specific to the project
- configuration.
- </summary>
- <value>
- The set of output files that is specific to the project
- configuration.
- </value>
- <remarks>
- The key of the case-insensitive <see cref="T:System.Collections.Hashtable"/> is the
- full path of the output file and the value is the path relative to
- the output directory.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationSettings.PlatformName">
- <summary>
- Gets the platform that the configuration targets.
- </summary>
- <value>
- The platform targeted by the configuration.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationSettings.BuildPath">
- <summary>
- Gets the path in which the output file will be created before its
- copied to the actual output path.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ConfigurationSettings.RegisterForComInterop">
- <summary>
- Gets a value indicating whether to register the project output for
- use with COM components.
- </summary>
- <value>
- <see langword="true" /> if the project output should be registered
- for use with COM components; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.VSNet.EverettSolution">
- <summary>
- Analyses Microsoft Visual Studio .NET 2003 (Everett) solution files.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.GenericSolution">
- <summary>
- Supports grouping of individual projects, and treating them as a solution.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.JSharpProject.VerifyProjectXml(System.Xml.XmlElement)">
- <summary>
- Verifies whether the specified XML fragment represents a valid project
- that is supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The XML fragment is not supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.</para>
- <para>-or-</para>
- <para>The XML fragment does not represent a valid project (for this <see cref="T:NAnt.VSNet.ProjectBase"/>).</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.JSharpProject.DetermineProductVersion(System.Xml.XmlElement)">
- <summary>
- Returns the Visual Studio product version of the specified project
- XML fragment.
- </summary>
- <param name="docElement">The document element of the project.</param>
- <returns>
- The Visual Studio product version of the specified project XML
- fragment.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The product version could not be determined.</para>
- <para>-or-</para>
- <para>The product version is not supported.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.JSharpProject.Prepare(System.String)">
- <summary>
- Prepares the project for being built.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <remarks>
- Ensures the configuration-level object directory exists and ensures
- that none of the output files are marked read-only.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.JSharpProject.GetProcessStartInfo(NAnt.VSNet.ConfigurationBase,System.String)">
- <summary>
- Returns a <see cref="T:System.Diagnostics.ProcessStartInfo"/> for launching the compiler
- for this project.
- </summary>
- <param name="config">The configuration to build.</param>
- <param name="responseFile">The response file for the compiler.</param>
- <returns>
- A <see cref="T:System.Diagnostics.ProcessStartInfo"/> for launching the compiler for
- this project.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.JSharpProject.DetermineProjectLocation(System.Xml.XmlElement)">
- <summary>
- Returns the project location from the specified project XML fragment.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <returns>
- The project location of the specified project XML file.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The project location could not be determined.</para>
- <para>-or-</para>
- <para>The project location is invalid.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.JSharpProject.IsSupported(System.Xml.XmlElement)">
- <summary>
- Returns a value indicating whether the project represented by the
- specified XML fragment is supported by <see cref="T:NAnt.VSNet.JSharpProject"/>.
- </summary>
- <param name="docElement">XML fragment representing the project to check.</param>
- <returns>
- <see langword="true"/> if <see cref="T:NAnt.VSNet.CSharpProject"/> supports
- the specified project; otherwise, <see langword="false"/>.
- </returns>
- <remarks>
- <para>
- A project is identified as as J# project, if the XML fragment at
- least has the following information:
- </para>
- <code>
- <![CDATA[
- <VisualStudioProject>
- <JSHARP
- ProductVersion="..."
- ....
- >
- ...
- </JSHARP>
- </VisualStudioProject>
- ]]>
- </code>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.JSharpProject.Type">
- <summary>
- Gets the type of the project.
- </summary>
- <value>
- The type of the project.
- </value>
- </member>
- <member name="P:NAnt.VSNet.JSharpProject.FileExtension">
- <summary>
- Gets the default file extension of sources for this project.
- </summary>
- <value>
- For J# projects, the default file extension is ".jsl".
- </value>
- </member>
- <member name="M:NAnt.VSNet.ManagedAssemblyReference.ResolveAssemblyReference">
- <summary>
- Resolves an assembly reference.
- </summary>
- <returns>
- The full path to the resolved assembly, or <see langword="null" />
- if the assembly reference could not be resolved.
- </returns>
- <remarks>
- <para>
- Visual Studio .NET uses the following search mechanism :
- </para>
- <list type="number">
- <item>
- <term>
- The project directory.
- </term>
- </item>
- <item>
- <term>
- The directories specified in the "ReferencePath" property,
- which is stored in the .USER file.
- </term>
- </item>
- <item>
- <term>
- The .NET Framework directory (see KB306149)
- </term>
- </item>
- <item>
- <term>
- <para>
- The directories specified under the following registry
- keys:
- </para>
- <list type="bullet">
- <item>
- <term>
- HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders
- </term>
- </item>
- <item>
- <term>
- HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFolders
- </term>
- </item>
- <item>
- <term>
- HKLM\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders
- </term>
- </item>
- <item>
- <term>
- HKCU\SOFTWARE\Microsoft\VisualStudio\<major version>.<minor version>\AssemblyFolders
- </term>
- </item>
- </list>
- <para>
- Future versions of Visual Studio .NET will also check
- in:
- </para>
- <list type="bullet">
- <item>
- <term>
- HKLM\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx
- </term>
- </item>
- <item>
- <term>
- HKCU\SOFTWARE\Microsoft\.NETFramework\AssemblyFoldersEx
- </term>
- </item>
- </list>
- </term>
- </item>
- <item>
- <term>
- The HintPath.
- </term>
- </item>
- </list>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ManagedAssemblyReference.Name">
- <summary>
- Gets the name of the referenced assembly.
- </summary>
- <value>
- The name of the referenced assembly, or <see langword="null" /> if
- the name could not be determined.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ManagedAssemblyReference.AssemblyFoldersKey">
- <summary>
- Gets the Visual Studio .NET AssemblyFolders registry key matching
- the current target framework.
- </summary>
- <value>
- The Visual Studio .NET AssemblyFolders registry key matching the
- current target framework.
- </value>
- <exception cref="T:NAnt.Core.BuildException">The current target framework is not supported.</exception>
- <remarks>
- We use the target framework instead of the product version of the
- containing project file to determine what registry key to scan, as
- we don't want to use assemblies meant for uplevel framework versions.
- </remarks>
- </member>
- <member name="T:NAnt.VSNet.ManagedOutputType">
- <summary>
- Indentifies the different output types of a managed project.
- </summary>
- <remarks>
- Visual Studio .NET does not support modules.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.ManagedOutputType.Library">
- <summary>
- A class library.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ManagedOutputType.Executable">
- <summary>
- A console application.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ManagedOutputType.WindowsExecutable">
- <summary>
- A Windows program.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectReferenceBase.GetPrimaryOutputFile(System.String)">
- <summary>
- Gets the output path of the reference, without taking the "copy local"
- setting into consideration.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The output path of the reference.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectReferenceBase.GetOutputFiles(System.String,System.Collections.Hashtable)">
- <summary>
- Gets the complete set of output files for the referenced project.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <param name="outputFiles">The set of output files to be updated.</param>
- <returns>
- The complete set of output files for the referenced project.
- </returns>
- <remarks>
- The key of the case-insensitive <see cref="T:System.Collections.Hashtable"/> is the
- full path of the output file and the value is the path relative to
- the output directory.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ProjectReferenceBase.GetAssemblyReferences(System.String)">
- <summary>
- Gets the complete set of assemblies that need to be referenced when
- a project references this project.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The complete set of assemblies that need to be referenced when a
- project references this project.
- </returns>
- <remarks>
- <para>
- 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.
- </para>
- <para>
- 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".
- </para>
- <para>
- 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.
- </para>
- <para>
- 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.
- </para>
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ProjectReferenceBase.GetTimestamp(System.String)">
- <summary>
- Gets the timestamp of the reference.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The timestamp of the reference.
- </returns>
- </member>
- <member name="P:NAnt.VSNet.ProjectReferenceBase.CopyLocal">
- <summary>
- Gets a value indicating whether the output file(s) of this reference
- should be copied locally.
- </summary>
- <value>
- <see langword="true" /> if the output file(s) of this reference
- should be copied locally; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ProjectReferenceBase.IsSystem">
- <summary>
- Gets a value indicating whether this reference represents a system
- assembly.
- </summary>
- <value>
- <see langword="false" /> as a project by itself can never be a
- system assembly.
- </value>
- </member>
- <member name="M:NAnt.VSNet.ManagedProjectReference.IsManaged(System.String)">
- <summary>
- Gets a value indicating whether the reference is managed for the
- specified configuration.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- <see langword="true" />.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.WrapperReferenceBase.GetPrimaryOutputFile(System.String)">
- <summary>
- Gets the path of the reference, without taking the "copy local"
- setting into consideration.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The output path of the reference.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.WrapperReferenceBase.GetOutputFiles(System.String,System.Collections.Hashtable)">
- <summary>
- Gets the complete set of output files for the referenced project.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <param name="outputFiles">The set of output files to be updated.</param>
- <remarks>
- The key of the case-insensitive <see cref="T:System.Collections.Hashtable"/> is the
- full path of the output file and the value is the path relative to
- the output directory.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.WrapperReferenceBase.GetAssemblyReferences(System.String)">
- <summary>
- Gets the complete set of assemblies that need to be referenced when
- a project references this component.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The complete set of assemblies that need to be referenced when a
- project references this component.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.WrapperReferenceBase.GetTimestamp(System.String)">
- <summary>
- Gets the timestamp of the reference.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- The timestamp of the reference.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.WrapperReferenceBase.Sync(NAnt.VSNet.ConfigurationBase)">
- <summary>
- 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.
- </summary>
- <param name="config">The project configuration.</param>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.CopyLocal">
- <summary>
- Gets a value indicating whether the output file(s) of this reference
- should be copied locally.
- </summary>
- <value>
- <see langword="false" /> if the reference wraps a Primary Interop
- Assembly; otherwise, <see langword="true" />.
- </value>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.IsSystem">
- <summary>
- Gets a value indicating whether this reference represents a system
- assembly.
- </summary>
- <value>
- <see langword="false" /> as none of the system assemblies are wrappers
- or Primary Interop Assemblies anyway.
- </value>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.WrapperTool">
- <summary>
- Gets the name of the tool that should be used to create the
- <see cref="P:NAnt.VSNet.WrapperReferenceBase.WrapperAssembly"/>.
- </summary>
- <value>
- The name of the tool that should be used to create the
- <see cref="P:NAnt.VSNet.WrapperReferenceBase.WrapperAssembly"/>.
- </value>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.WrapperAssembly">
- <summary>
- Gets the path of the wrapper assembly.
- </summary>
- <value>
- The path of the wrapper assembly.
- </value>
- <remarks>
- The wrapper assembly is stored in the object directory of the
- project.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.IsCreated">
- <summary>
- Gets a value indicating whether the wrapper assembly has already been
- created.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.PrimaryInteropAssembly">
- <summary>
- Gets the path of the Primary Interop Assembly.
- </summary>
- <value>
- The path of the Primary Interop Assembly, or <see langword="null" />
- if not available.
- </value>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.TypeLibVersion">
- <summary>
- Gets the hex version of the type library as defined in the definition
- of the reference.
- </summary>
- <value>
- The hex version of the type library.
- </value>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.TypeLibGuid">
- <summary>
- Gets the GUID of the type library as defined in the definition
- of the reference.
- </summary>
- <value>
- The GUID of the type library.
- </value>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.TypeLibLocale">
- <summary>
- Gets the locale of the type library in hex notation.
- </summary>
- <value>
- The locale of the type library.
- </value>
- </member>
- <member name="P:NAnt.VSNet.WrapperReferenceBase.TypeLibraryName">
- <summary>
- Gets the name of the type library.
- </summary>
- <value>
- The name of the type library.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ManagedWrapperReference.Name">
- <summary>
- Gets the name of the referenced assembly.
- </summary>
- <value>
- The name of the referenced assembly, or <see langword="null" /> if
- the name could not be determined.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ManagedWrapperReference.WrapperTool">
- <summary>
- Gets the name of the tool that should be used to create the
- <see cref="P:NAnt.VSNet.ManagedWrapperReference.WrapperAssembly"/>.
- </summary>
- <value>
- The name of the tool that should be used to create the
- <see cref="P:NAnt.VSNet.ManagedWrapperReference.WrapperAssembly"/>.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ManagedWrapperReference.WrapperAssembly">
- <summary>
- Gets the path of the wrapper assembly.
- </summary>
- <value>
- The path of the wrapper assembly.
- </value>
- <remarks>
- The wrapper assembly is stored in the object directory of the
- project.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ManagedWrapperReference.PrimaryInteropAssembly">
- <summary>
- Gets the path of the Primary Interop Assembly.
- </summary>
- <value>
- The path of the Primary Interop Assembly, or <see langword="null" />
- if not available.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ManagedWrapperReference.TypeLibVersion">
- <summary>
- Gets the hex version of the type library as defined in the definition
- of the reference.
- </summary>
- <value>
- The hex version of the type library.
- </value>
- <exception cref="T:NAnt.Core.BuildException">
- <para>
- The definition of the reference does not contain a "VersionMajor" attribute.
- </para>
- <para>-or</para>
- <para>
- The definition of the reference does not contain a "VersionMinor" attribute.
- </para>
- </exception>
- </member>
- <member name="P:NAnt.VSNet.ManagedWrapperReference.TypeLibGuid">
- <summary>
- Gets the GUID of the type library as defined in the definition
- of the reference.
- </summary>
- <value>
- The GUID of the type library.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ManagedWrapperReference.TypeLibLocale">
- <summary>
- Gets the locale of the type library in hex notation.
- </summary>
- <value>
- The locale of the type library.
- </value>
- </member>
- <member name="T:NAnt.VSNet.ProjectType">
- <summary>
- Specifies the type of the project.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProjectType.VB">
- <summary>
- A Visual Basic.NET project.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProjectType.CSharp">
- <summary>
- A Visual C# project.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProjectType.VisualC">
- <summary>
- A Visual C++ project.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProjectType.JSharp">
- <summary>
- A Visual J# project.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProjectType.MSBuild">
- <summary>
- MSBuild project.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.BuildResult">
- <summary>
- Specifies the result of the build.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.BuildResult.Failed">
- <summary>
- The build failed.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.BuildResult.Success">
- <summary>
- The build succeeded.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.BuildResult.SuccessOutputUpdated">
- <summary>
- The build succeeded and the output was updated.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProductVersion.Rainier">
- <summary>
- Visual Studio.NET 2002
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProductVersion.Everett">
- <summary>
- Visual Studio.NET 2003
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProductVersion.Whidbey">
- <summary>
- Visual Studio 2005
- </summary>
- </member>
- <member name="T:NAnt.VSNet.ProjectLocation">
- <summary>
- Indentifies the physical location of a managed project.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProjectLocation.Local">
- <summary>
- A local project.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProjectLocation.Web">
- <summary>
- A web project.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.ProjectBaseCollection">
- <summary>
- Contains a collection of <see cref="T:NAnt.VSNet.ProjectBase"/> elements.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.ProjectBaseCollection"/> class.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.#ctor(NAnt.VSNet.ProjectBaseCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.ProjectBaseCollection"/> class
- with the specified <see cref="T:NAnt.VSNet.ProjectBaseCollection"/> instance.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.#ctor(NAnt.VSNet.ProjectBase[])">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.ProjectBaseCollection"/> class
- with the specified array of <see cref="T:NAnt.VSNet.ProjectBase"/> instances.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.Add(NAnt.VSNet.ProjectBase)">
- <summary>
- Adds a <see cref="T:NAnt.VSNet.ProjectBase"/> to the end of the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.ProjectBase"/> to be added to the end of the collection.</param>
- <returns>The position into which the new element was inserted.</returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.AddRange(NAnt.VSNet.ProjectBase[])">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VSNet.ProjectBase"/> array to the end of the collection.
- </summary>
- <param name="items">The array of <see cref="T:NAnt.VSNet.ProjectBase"/> elements to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.AddRange(NAnt.VSNet.ProjectBaseCollection)">
- <summary>
- Adds the elements of a <see cref="T:NAnt.VSNet.ProjectBaseCollection"/> to the end of the collection.
- </summary>
- <param name="items">The <see cref="T:NAnt.VSNet.ProjectBaseCollection"/> to be added to the end of the collection.</param>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.Contains(NAnt.VSNet.ProjectBase)">
- <summary>
- Determines whether a <see cref="T:NAnt.VSNet.ProjectBase"/> is in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.ProjectBase"/> to locate in the collection.</param>
- <returns>
- <see langword="true"/> if <paramref name="item"/> is found in the
- collection; otherwise, <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.Contains(System.String)">
- <summary>
- Determines whether a <see cref="T:NAnt.VSNet.ProjectBase"/> with the specified
- GUID is in the collection, using a case-insensitive lookup.
- </summary>
- <param name="value">The GUID to locate in the collection.</param>
- <returns>
- <see langword="true"/> if a <see cref="T:NAnt.VSNet.ProjectBase"/> with GUID
- <paramref name="value"/> is found in the collection; otherwise,
- <see langword="false"/>.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.CopyTo(NAnt.VSNet.ProjectBase[],System.Int32)">
- <summary>
- Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
- </summary>
- <param name="array">The one-dimensional array that is the destination of the elements copied from the collection. The array must have zero-based indexing.</param>
- <param name="index">The zero-based index in <paramref name="array"/> at which copying begins.</param>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.IndexOf(NAnt.VSNet.ProjectBase)">
- <summary>
- Retrieves the index of a specified <see cref="T:NAnt.VSNet.ProjectBase"/> object in the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.ProjectBase"/> object for which the index is returned.</param>
- <returns>
- The index of the specified <see cref="T:NAnt.VSNet.ProjectBase"/>. If the <see cref="T:NAnt.VSNet.ProjectBase"/> is not currently a member of the collection, it returns -1.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.Insert(System.Int32,NAnt.VSNet.ProjectBase)">
- <summary>
- Inserts a <see cref="T:NAnt.VSNet.ProjectBase"/> into the collection at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The <see cref="T:NAnt.VSNet.ProjectBase"/> to insert.</param>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.GetEnumerator">
- <summary>
- Returns an enumerator that can iterate through the collection.
- </summary>
- <returns>
- A <see cref="T:NAnt.VSNet.ProjectBaseEnumerator"/> for the entire collection.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.Remove(NAnt.VSNet.ProjectBase)">
- <summary>
- Removes a member from the collection.
- </summary>
- <param name="item">The <see cref="T:NAnt.VSNet.ProjectBase"/> to remove from the collection.</param>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseCollection.Remove(System.String)">
- <summary>
- Remove items with the specified guid from the collection.
- </summary>
- <param name="guid">The guid of the project to remove from the collection.</param>
- </member>
- <member name="P:NAnt.VSNet.ProjectBaseCollection.Item(System.Int32)">
- <summary>
- Gets or sets the element at the specified index.
- </summary>
- <param name="index">The zero-based index of the element to get or set.</param>
- </member>
- <member name="P:NAnt.VSNet.ProjectBaseCollection.Item(System.String)">
- <summary>
- Gets the <see cref="T:NAnt.VSNet.ProjectBase"/> with the specified GUID.
- </summary>
- <param name="guid">The GUID of the <see cref="T:NAnt.VSNet.ProjectBase"/> to get.</param>
- <remarks>
- Performs a case-insensitive lookup.
- </remarks>
- </member>
- <member name="T:NAnt.VSNet.ProjectBaseEnumerator">
- <summary>
- Enumerates the <see cref="T:NAnt.VSNet.ProjectBase"/> elements of a <see cref="T:NAnt.VSNet.ProjectBaseCollection"/>.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseEnumerator.#ctor(NAnt.VSNet.ProjectBaseCollection)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.ProjectBaseEnumerator"/> class
- with the specified <see cref="T:NAnt.VSNet.ProjectBaseCollection"/>.
- </summary>
- <param name="arguments">The collection that should be enumerated.</param>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseEnumerator.MoveNext">
- <summary>
- Advances the enumerator to the next element of the collection.
- </summary>
- <returns>
- <see langword="true" /> if the enumerator was successfully advanced
- to the next element; <see langword="false" /> if the enumerator has
- passed the end of the collection.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ProjectBaseEnumerator.Reset">
- <summary>
- Sets the enumerator to its initial position, which is before the
- first element in the collection.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ProjectBaseEnumerator.Current">
- <summary>
- Gets the current element in the collection.
- </summary>
- <returns>
- The current element in the collection.
- </returns>
- </member>
- <member name="T:NAnt.VSNet.ProjectFactory">
- <summary>
- Factory class for VS.NET projects.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ProjectFactory.#ctor(NAnt.VSNet.Tasks.SolutionTask)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.ProjectFactory"/>
- class.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.ProjectFactory._cachedProjects">
- <summary>
- Holds a case-insensitive list of cached projects.
- </summary>
- <remarks>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the path of the project
- file (for web projects this can be a URL) and the value is a
- <see cref="T:NAnt.Core.Project"/> instance.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.ProjectFactory._cachedProjectGuids">
- <summary>
- Holds a case-insensitive list of cached project GUIDs.
- </summary>
- <remarks>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the path of the project
- file (for web projects this can be a URL) and the value is the GUID
- of the project.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.ProjectFactory._cachedProjectXml">
- <summary>
- Holds a case-insensitive list of cached project GUIDs.
- </summary>
- <remarks>
- The key of the <see cref="T:System.Collections.Hashtable"/> is the path of the project
- file (for web projects this can be a URL) and the value is the Xml
- of the project.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.ProjectSettings.GetOutputType(System.Xml.XmlElement)">
- <summary>
- Determines the output type of the project from its XML definition.
- </summary>
- <param name="settingsXml">The XML definition of the project settings.</param>
- <returns>
- The output type of the project.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>
- The output type of the project is not set in the specified XML
- definition.
- </para>
- <para>-or-</para>
- <para>
- The output type of the project is not supported.
- </para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.ProjectSettings.GetProjectGuid(System.String,System.Xml.XmlElement)">
- <summary>
- Gets the project GUID from the given <see cref="T:System.Xml.XmlElement"/>
- holding a <c><VisualStudioProject></c> node.
- </summary>
- <param name="projectFile">The path of the project file.</param>
- <param name="elemRoot">The <c><VisualStudioProject></c> node from which the project GUID should be retrieved.</param>
- <returns>
- The project GUID from specified <c><VisualStudioProject></c> node.
- </returns>
- </member>
- <member name="P:NAnt.VSNet.ProjectSettings.ApplicationIcon">
- <summary>
- Gets the .ico file to use as application icon.
- </summary>
- <value>
- The .ico file to use as application icon, or <see langword="null" />
- if no application icon should be used.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ProjectSettings.AssemblyOriginatorKeyFile">
- <summary>
- Gets the key file to use to sign ActiveX/COM wrappers.
- </summary>
- <value>
- The path of the key file to use to sign ActiveX/COM wrappers,
- relative to the project root directory, or <see langword="null" />
- if the wrapper assembly should not be signed using a key file.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ProjectSettings.AssemblyKeyContainerName">
- <summary>
- Gets the key name to use to sign ActiveX/COM wrappers.
- </summary>
- <value>
- The name of the key container to use to sign ActiveX/COM wrappers,
- or <see langword="null" /> if the wrapper assembly should not be
- signed using a key container.
- </value>
- </member>
- <member name="P:NAnt.VSNet.ProjectSettings.OutputType">
- <summary>
- Gets the output type of this project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ProjectSettings.RunPostBuildEvent">
- <summary>
- Designates when the <see cref="P:NAnt.VSNet.ProjectSettings.PostBuildEvent"/> command line should
- be run. Possible values are "OnBuildSuccess", "Always" or
- "OnOutputUpdated".
- </summary>
- </member>
- <member name="P:NAnt.VSNet.ProjectSettings.PreBuildEvent">
- <summary>
- Contains commands to be run before a build takes place.
- </summary>
- <remarks>
- Valid commands are those in a .bat file. For more info see MSDN.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.ProjectSettings.PostBuildEvent">
- <summary>
- Contains commands to be ran after a build has taken place.
- </summary>
- <remarks>
- Valid commands are those in a .bat file. For more info see MSDN.
- </remarks>
- </member>
- <member name="T:NAnt.VSNet.RainierSolution">
- <summary>
- Analyses Microsoft Visual Studio .NET 2002 (Rainier) solution files.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.ReferencesResolver.InitializeLifetimeService">
- <summary>
- Obtains a lifetime service object to control the lifetime policy for
- this instance.
- </summary>
- <returns>
- An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease"/> used to control the lifetime
- policy for this instance. This is the current lifetime service object
- for this instance if one exists; otherwise, a new lifetime service
- object initialized with a lease that will never time out.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.ReferencesResolver.GetAssemblyFileName(System.String)">
- <summary>
- Gets the file name of the assembly with the given assembly name.
- </summary>
- <param name="assemblyName">The assembly name of the assembly of which the file name should be returned.</param>
- <returns>
- The file name of the assembly with the given assembly name.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.Resource.Compile(System.String)">
- <summary>
- Compiles the resource file.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- A <see cref="T:System.IO.FileInfo"/> representing the compiled resource file.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.Resource.GetCompiledResourceFile(System.String)">
- <summary>
- Returns a <see cref="T:System.IO.FileInfo"/> representing the compiled resource
- file.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- A <see cref="T:System.IO.FileInfo"/> representing the compiled resource file.
- </returns>
- <remarks>
- Calling this method does not force compilation of the resource file.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.Resource.InputFile">
- <summary>
- Gets a <see cref="T:System.IO.FileInfo"/> representing the physical location
- of the resource file.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.Resource.LogicalFile">
- <summary>
- Gets a <see cref="T:System.IO.FileInfo"/> representing the logical location
- of the resource file in the project.
- </summary>
- <remarks>
- When the resource file is not linked, this matches the
- <see cref="P:NAnt.VSNet.Resource.InputFile"/>.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.Resource.IsResX">
- <summary>
- Gets a value indicating whether the resource is in fact a ResX file.
- </summary>
- <value>
- <see langword="true" /> if the resource is a ResX file; otherwise,
- <see langword="false" />.
- </value>
- </member>
- <member name="T:NAnt.VSNet.SolutionFactory">
- <summary>
- Factory class for VS.NET solutions.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.SolutionFactory.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.SolutionFactory"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.VBProject.VerifyProjectXml(System.Xml.XmlElement)">
- <summary>
- Verifies whether the specified XML fragment represents a valid project
- that is supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The XML fragment is not supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.</para>
- <para>-or-</para>
- <para>The XML fragment does not represent a valid project (for this <see cref="T:NAnt.VSNet.ProjectBase"/>).</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.VBProject.DetermineProductVersion(System.Xml.XmlElement)">
- <summary>
- Returns the Visual Studio product version of the specified project
- XML fragment.
- </summary>
- <param name="docElement">The document element of the project.</param>
- <returns>
- The Visual Studio product version of the specified project XML
- fragment.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The product version could not be determined.</para>
- <para>-or-</para>
- <para>The product version is not supported.</para>
- </exception>
- <remarks>
- This method is called from the <see cref="T:NAnt.VSNet.ProjectBase"/> ctor, and
- at that time we're not sure the XML that is passed in, is indeed a
- valid Visual Basic project.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.VBProject.DetermineProjectLocation(System.Xml.XmlElement)">
- <summary>
- Returns the project location from the specified project XML fragment.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <returns>
- The project location of the specified project XML file.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The project location could not be determined.</para>
- <para>-or-</para>
- <para>The project location is invalid.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.VBProject.GetProcessStartInfo(NAnt.VSNet.ConfigurationBase,System.String)">
- <summary>
- Returns a <see cref="T:System.Diagnostics.ProcessStartInfo"/> for launching the compiler
- for this project.
- </summary>
- <param name="config">The configuration to build.</param>
- <param name="responseFile">The response file for the compiler.</param>
- <returns>
- A <see cref="T:System.Diagnostics.ProcessStartInfo"/> for launching the compiler for
- this project.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.VBProject.IsSupported(System.Xml.XmlElement)">
- <summary>
- Returns a value indicating whether the project represented by the
- specified XML fragment is supported by <see cref="T:NAnt.VSNet.VBProject"/>.
- </summary>
- <param name="docElement">XML fragment representing the project to check.</param>
- <returns>
- <see langword="true"/> if <see cref="T:NAnt.VSNet.VBProject"/> supports the
- specified project; otherwise, <see langword="false"/>.
- </returns>
- <remarks>
- <para>
- A project is identified as as Visual Basic project, if the XML
- fragment at least has the following information:
- </para>
- <code>
- <![CDATA[
- <VisualStudioProject>
- <VisualBasic
- ProductVersion="..."
- ....
- >
- ...
- </VisualBasic>
- </VisualStudioProject>
- ]]>
- </code>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VBProject.Type">
- <summary>
- Gets the type of the project.
- </summary>
- <value>
- The type of the project.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VBProject.FileExtension">
- <summary>
- Gets the default file extension of sources for this project.
- </summary>
- <value>
- For VB projects, the default file extension is ".vb".
- </value>
- </member>
- <member name="T:NAnt.VSNet.VcArgumentMap">
- <summary>
- A mapping from properties in the .vcproj file to command line arguments.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.VcArgumentMap.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.VSNet.VcArgumentMap"/>
- class.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.VcArgumentMap.GetArgument(System.String,System.String,NAnt.VSNet.VcArgumentMap.ArgGroup)">
- <summary>
- Gets the argument string corresponding with a configuration property
- named <paramref name="propName" /> with value <paramref name="propValue" />.
- An ignore mask can be used to eliminate some arguments from the search.
- </summary>
- <param name="propName">The name of the configuration property.</param>
- <param name="propValue">The value of the configuration property.</param>
- <param name="useIgnoreGroup">Specify any groups that needs to be ignored.</param>
- <returns>
- The argument string corresponding with a configuration property
- named <paramref name="propName" /> with value <paramref name="propValue" />,
- or <see langword="null" /> if no corresponding argument exists.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.VcArgumentMap.CreateCLArgumentMap">
- <summary>
- Creates a mapping between configuration properties for the Visual
- C++ compiler and corresponding command-line arguments.
- </summary>
- <returns>
- A mapping between configuration properties for the Visual C++
- compiler and corresponding command-line arguments.
- </returns>
- <remarks>
- <para>
- The following configuration properties are processed by
- <see cref="T:NAnt.VSNet.VcProject"/>:
- </para>
- <list type="table">
- <listheader>
- <term>Category</term>
- <description>Property</description>
- </listheader>
- <item>
- <term>General</term>
- <description>Addtional Include Directories (/I[path])</description>
- </item>
- <item>
- <term>General</term>
- <description>Resolve #using References (/AI[path])</description>
- </item>
- <item>
- <term>Preprocessor</term>
- <description>Preprocessor Definitions (/D[macro])</description>
- </item>
- <item>
- <term>Code Generation</term>
- <description>Enable C++ Exceptions (/EHsc)</description>
- </item>
- <item>
- <term>Precompiled Headers</term>
- <description>Create/Use Precompiled Header</description>
- </item>
- <item>
- <term>Precompiled Headers</term>
- <description>Create/Use PCH Through File</description>
- </item>
- <item>
- <term>Precompiled Headers</term>
- <description>Precompiled Header File</description>
- </item>
- <item>
- <term>Output Files</term>
- <description>Assembler Output</description>
- </item>
- <item>
- <term>Output Files</term>
- <description>ASM List Location</description>
- </item>
- <item>
- <term>Browse Information</term>
- <description>Enable Browse Information</description>
- </item>
- <item>
- <term>Browse Information</term>
- <description>Browse File</description>
- </item>
- <item>
- <term>Advanced</term>
- <description>Force Includes (/FI[name])</description>
- </item>
- <item>
- <term>Advanced</term>
- <description>Force #using (/FU[name])</description>
- </item>
- <item>
- <term>Advanced</term>
- <description>Undefine Preprocessor Definitions (/U[macro])</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.VcArgumentMap.CreateLinkerArgumentMap">
- <summary>
- Creates a mapping between configuration properties for the Visual
- C++ linker and corresponding command-line arguments.
- </summary>
- <returns>
- A mapping between configuration properties for the Visual C++
- linker and corresponding command-line arguments.
- </returns>
- <remarks>
- <para>
- The following configuration properties are processed by
- <see cref="T:NAnt.VSNet.VcProject"/>:
- </para>
- <list type="table">
- <listheader>
- <term>Category</term>
- <description>Property</description>
- </listheader>
- <item>
- <term>General</term>
- <description>Output File (/OUT:[file])</description>
- </item>
- <item>
- <term>General</term>
- <description>Additional Library Directories (/LIBPATH:[dir])</description>
- </item>
- <item>
- <term>Input</term>
- <description>Additional Dependencies</description>
- </item>
- <item>
- <term>Input</term>
- <description>Add Module to Assembly (/ASSEMBLYMODULE:file)</description>
- </item>
- <item>
- <term>Input</term>
- <description>Embed Managed Resource File (/ASSEMBLYRESOURCE:file)</description>
- </item>
- <item>
- <term>Debugging</term>
- <description>Generate Debug Info (/DEBUG)</description>
- </item>
- <item>
- <term>Debugging</term>
- <description>Generate Program Database File (/PDB:name)</description>
- </item>
- <item>
- <term>Debugging</term>
- <description>Generate Map File (/MAP)</description>
- </item>
- <item>
- <term>Debugging</term>
- <description>Map File Name (/MAP:[filename])</description>
- </item>
- <item>
- <term>System</term>
- <description>Heap Reserve Size (/HEAP:reserve)</description>
- </item>
- <item>
- <term>System</term>
- <description>Heap Commit Size (/HEAP:reserve, commit)</description>
- </item>
- <item>
- <term>System</term>
- <description>Stack Reserve Size (/STACK:reserve)</description>
- </item>
- <item>
- <term>System</term>
- <description>Stack Commit Size (/STACK:reserve, commit)</description>
- </item>
- </list>
- <para>
- The following configuration properties are ignored:
- </para>
- <list type="table">
- <listheader>
- <term>Category</term>
- <description>Property</description>
- </listheader>
- <item>
- <term>General</term>
- <description>Show Progress (/VERBOSE, /VERBOSE:LIB)</description>
- </item>
- <item>
- <term>General</term>
- <description>Suppress Startup Banner (/NOLOGO)</description>
- </item>
- </list>
- <para>
- Support for the following configuration properties still needs to
- be implemented:
- </para>
- <list type="table">
- <listheader>
- <term>Category</term>
- <description>Property</description>
- </listheader>
- <item>
- <term>General</term>
- <description>Ignore Import Library</description>
- </item>
- <item>
- <term>General</term>
- <description>Register Output</description>
- </item>
- <item>
- <term>Input</term>
- <description>Delay Loaded DLLs (/DELAYLOAD:[dll_name])</description>
- </item>
- <item>
- <term>Embedded IDL</term>
- <description>MIDL Commands (/MIDL:[file])</description>
- </item>
- </list>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcArgumentMap.VcArgument.Name">
- <summary>
- Gets the name of the command-line argument.
- </summary>
- <value>
- The name of the command-line argument.
- </value>
- </member>
- <member name="T:NAnt.VSNet.VcArgumentMap.LinkerStringArgument">
- <summary>
- Represents a command-line arguments of which the trailing backslashes
- in the value should be duplicated.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.VcArgumentMap.QuotedLinkerStringArgument">
- <summary>
- Represents a command-line argument of which the value should be
- quoted, and of which trailing backslahes should be duplicated.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcArgumentMap.VcBoolArgument.Match">
- <summary>
- Gets the string that the configuration setting should match in
- order for the command line argument to be set.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.VcArgumentMap.ArgGroup">
- <summary>
- Allow us to assign an argument to a specific group.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.VcArgumentMap.ArgGroup.Unassigned">
- <summary>
- The argument is not assigned to any group.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.VcArgumentMap.ArgGroup.OptiIgnoreGroup">
- <summary>
- The argument is ignored when the optimization level is set to
- <b>Minimum Size</b> (1) or <b>Maximum Size</b> (2).
- </summary>
- </member>
- <member name="M:NAnt.VSNet.VcAssemblyReference.ResolveAssemblyReference">
- <summary>
- Resolves an assembly reference.
- </summary>
- <returns>
- The full path to the resolved assembly, or <see langword="null" />
- if the assembly reference could not be resolved.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.VcAssemblyReference.EvaluateMacro(System.Text.RegularExpressions.Match)">
- <summary>
- Is called each time a regular expression match is found during a
- <see cref="M:System.Text.RegularExpressions.Regex.Replace(System.String,System.Text.RegularExpressions.MatchEvaluator)"/> operation.
- </summary>
- <param name="m">The <see cref="T:System.Text.RegularExpressions.Match"/> resulting from a single regular expression match during a <see cref="M:System.Text.RegularExpressions.Regex.Replace(System.String,System.Text.RegularExpressions.MatchEvaluator)"/>.</param>
- <returns>
- The expanded <see cref="T:System.Text.RegularExpressions.Match"/>.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">The macro is not supported.</exception>
- <exception cref="T:System.NotImplementedException">Expansion of a given macro is not yet implemented.</exception>
- </member>
- <member name="P:NAnt.VSNet.VcAssemblyReference.Name">
- <summary>
- Gets the name of the referenced assembly.
- </summary>
- <value>
- The name of the referenced assembly, or <see langword="null" /> if
- the name could not be determined.
- </value>
- </member>
- <member name="T:NAnt.VSNet.VcConfigurationBase">
- <summary>
- A single build configuration for a Visual C++ project or for a specific
- file in the project.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.VcConfigurationBase.ExpandMacro(System.String)">
- <summary>
- Expands the given macro.
- </summary>
- <param name="macro">The macro to expand.</param>
- <returns>
- The expanded macro.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The macro is not supported.</para>
- <para>-or-</para>
- <para>The macro is not implemented.</para>
- <para>-or-</para>
- <para>The macro cannot be expanded.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.VcConfigurationBase.GetToolSetting(System.String,System.String)">
- <summary>
- Gets the value of a given setting for a specified tool.
- </summary>
- <param name="toolName">The name of the tool.</param>
- <param name="settingName">The name of the setting.</param>
- <returns>
- The value of a setting for the specified tool, or <see langword="null"/>
- if the setting is not defined for the specified tool.
- </returns>
- <remarks>
- An empty setting value, which is used as a means to override the
- project default, will be returned as a empty <see cref="T:System.String"/>.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.VcConfigurationBase.GetToolSetting(System.String,System.String,System.String)">
- <summary>
- Gets the value of a given setting for a specified tool.
- </summary>
- <param name="toolName">The name of the tool.</param>
- <param name="settingName">The name of the setting.</param>
- <param name="defaultValue">The value to return if setting is not defined.</param>
- <returns>
- The value of a setting for the specified tool, or
- <paramref name="defaultValue"/> if the setting is not defined for
- the specified tool.
- </returns>
- <remarks>
- An empty setting value, which is used as a means to override the
- project default, will be returned as a empty <see cref="T:System.String"/>.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcConfigurationBase.IntermediateDir">
- <summary>
- Gets the intermediate directory, specified relative to project
- directory.
- </summary>
- <value>
- The intermediate directory, specified relative to project directory.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcConfigurationBase.ReferencesPath">
- <summary>
- Gets a comma-separated list of directories to scan for assembly
- references.
- </summary>
- <value>
- A comma-separated list of directories to scan for assembly
- references, or <see langword="null" /> if no additional directories
- should scanned.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcConfigurationBase.FullName">
- <summary>
- Gets the name of the configuration, including the platform it
- targets.
- </summary>
- <value>
- Tthe name of the configuration, including the platform it targets.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcConfigurationBase.OutputDir">
- <summary>
- Gets the output directory.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcConfigurationBase.BuildPath">
- <summary>
- Gets the path in which the output file will be created before its
- copied to the actual output path.
- </summary>
- <remarks>
- For Visual C++ projects, the output file will be immediately
- created in the output path.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcConfigurationBase.Name">
- <summary>
- Gets the name of the configuration.
- </summary>
- <value>
- The name of the configuration.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcConfigurationBase.PlatformName">
- <summary>
- Gets the platform that the configuration targets.
- </summary>
- <value>
- The platform targeted by the configuration.
- </value>
- </member>
- <member name="T:NAnt.VSNet.VcFileConfiguration">
- <summary>
- Represents the configuration of a file.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.VcFileConfiguration.ExpandMacro(System.String)">
- <summary>
- Expands the given macro.
- </summary>
- <param name="macro">The macro to expand.</param>
- <returns>
- The expanded macro.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The macro is not supported.</para>
- <para>-or-</para>
- <para>The macro is not implemented.</para>
- <para>-or-</para>
- <para>The macro cannot be expanded.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.VcFileConfiguration.GetToolSetting(System.String,System.String,System.String)">
- <summary>
- Gets the value of a given setting for a specified tool.
- </summary>
- <param name="toolName">The name of the tool.</param>
- <param name="settingName">The name of the setting.</param>
- <param name="projectDefault">The value to return if setting is not defined in both the file and project configuration.</param>
- <returns>
- The value of a setting for the specified tool, or
- <paramref name="defaultValue"/> if the setting is not defined in
- both the file and project configuration.
- </returns>
- <remarks>
- <para>
- If the setting is not defined in the file configuration, then
- the project level setting will be used.
- </para>
- <para>
- An empty setting value, which is used as a means to override the
- project default, will be returned as a empty <see cref="T:System.String"/>.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcFileConfiguration.ExcludeFromBuild">
- <summary>
- Gets a value indication whether the file should be excluded from
- the build for this configuration.
- </summary>
- <value>
- <see langword="true" /> if the file should be excluded from the
- build for this configuration; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcFileConfiguration.RelativePath">
- <summary>
- Gets the relative path of the file.
- </summary>
- <value>
- The path of the file relative to the project directory.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcFileConfiguration.RelativeOutputDir">
- <summary>
- Get the path of the output directory relative to the project
- directory.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcFileConfiguration.IntermediateDir">
- <summary>
- Gets the intermediate directory, specified relative to project
- directory.
- </summary>
- <value>
- The intermediate directory, specified relative to project directory.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcFileConfiguration.OutputPath">
- <summary>
- Gets the path for the output file.
- </summary>
- <value>
- The path for the output file, or <see langword="null" /> if there's
- no output file for this configuration.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcFileConfiguration.ReferencesPath">
- <summary>
- Gets a comma-separated list of directories to scan for assembly
- references.
- </summary>
- <value>
- A comma-separated list of directories to scan for assembly
- references, or <see langword="null" /> if no additional directories
- should scanned.
- </value>
- </member>
- <member name="T:NAnt.VSNet.VcProject">
- <summary>
- Visual C++ project.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.VcProject.IsManaged(System.String)">
- <summary>
- Gets a value indicating whether building the project for the specified
- build configuration results in managed output.
- </summary>
- <param name="solutionConfiguration">The solution configuration that is built.</param>
- <returns>
- <see langword="true" /> 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,
- <see langword="false" />.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.VcProject.VerifyProjectXml(System.Xml.XmlElement)">
- <summary>
- Verifies whether the specified XML fragment represents a valid project
- that is supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.
- </summary>
- <param name="docElement">XML fragment representing the project file.</param>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The XML fragment is not supported by this <see cref="T:NAnt.VSNet.ProjectBase"/>.</para>
- <para>-or-</para>
- <para>The XML fragment does not represent a valid project (for this <see cref="T:NAnt.VSNet.ProjectBase"/>).</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.VcProject.DetermineProductVersion(System.Xml.XmlElement)">
- <summary>
- Returns the Visual Studio product version of the specified project
- XML fragment.
- </summary>
- <param name="docElement">The document element of the project.</param>
- <returns>
- The Visual Studio product version of the specified project XML
- fragment.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The product version could not be determined.</para>
- <para>-or-</para>
- <para>The product version is not supported.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.VcProject.ExpandMacro(System.String)">
- <summary>
- Expands the given macro.
- </summary>
- <param name="macro">The macro to expand.</param>
- <returns>
- The expanded macro or <see langword="null" /> if the macro is not
- supported.
- </returns>
- </member>
- <member name="M:NAnt.VSNet.VcProject.BuildResourceFiles(System.Collections.ArrayList,NAnt.VSNet.VcProjectConfiguration,NAnt.VSNet.VcConfigurationBase)">
- <summary>
- Build resource files for the given configuration.
- </summary>
- <param name="fileNames">The resource files to build.</param>
- <param name="projectConfig">The project configuration.</param>
- <param name="fileConfig">The build configuration.</param>
- <remarks>
- TODO: refactor this as we should always get only one element in the
- <paramref name="fileNames" /> list. Each res file should be built
- with its own file configuration.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.VcProject.BuildIDLFiles(System.Collections.ArrayList,NAnt.VSNet.VcProjectConfiguration,NAnt.VSNet.VcConfigurationBase)">
- <summary>
- Build Interface Definition Language files for the given
- configuration.
- </summary>
- <param name="fileNames">The IDL files to build.</param>
- <param name="projectConfig">The project configuration.</param>
- <param name="fileConfig">The build configuration.</param>
- <remarks>
- TODO: refactor this as we should always get only one element in the
- <paramref name="fileNames" /> list. Each IDL file should be built
- with its own file configuration.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.VcProject.MergeToolSetting(NAnt.VSNet.VcProjectConfiguration,NAnt.VSNet.VcConfigurationBase,System.String,System.String)">
- <summary>
- Merges the specified tool setting of <paramref name="projectConfig" />
- with <paramref name="fileConfig" />.
- </summary>
- <remarks>
- The merge is suppressed when the flag $(noinherit) is defined in
- <paramref name="fileConfig" />.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.VcProject.GetObjectFile(NAnt.VSNet.VcConfigurationBase)">
- <summary>
- Gets the absolute path to the object file or directory.
- </summary>
- <param name="fileConfig">The build configuration</param>
- <returns>
- The absolute path to the object file or directory, or
- </returns>
- <remarks>
- We use an absolute path for the object file, otherwise
- <c><cl></c> assumes a location relative to the output
- directory - not the project directory.
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.VcProject.IsSupported(System.Xml.XmlElement)">
- <summary>
- Returns a value indicating whether the project represented by the
- specified XML fragment is supported by <see cref="T:NAnt.VSNet.VcProject"/>.
- </summary>
- <param name="docElement">XML fragment representing the project to check.</param>
- <returns>
- <see langword="true"/> if <see cref="T:NAnt.VSNet.VcProject"/> supports the
- specified project; otherwise, <see langword="false"/>.
- </returns>
- <remarks>
- <para>
- A project is identified as as Visual C++ project, if the XML
- fragment at least has the following information:
- </para>
- <code>
- <![CDATA[
- <VisualStudioProject
- ProjectType="Visual C++"
- Version="..."
- ...
- >
- </VisualStudioProject>
- ]]>
- </code>
- </remarks>
- </member>
- <member name="M:NAnt.VSNet.VcProject.CleanPath(System.String)">
- <summary>
- Removes leading and trailing quotes from the specified path.
- </summary>
- <param name="path">The path to clean.</param>
- </member>
- <member name="M:NAnt.VSNet.VcProject.GetProductVersion(System.Xml.XmlElement)">
- <summary>
- Returns the Visual Studio product version of the specified project
- XML fragment.
- </summary>
- <param name="docElement">XML fragment representing the project to check.</param>
- <returns>
- The Visual Studio product version of the specified project XML
- fragment.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The product version could not be determined.</para>
- <para>-or-</para>
- <para>The product version is not supported.</para>
- </exception>
- </member>
- <member name="F:NAnt.VSNet.VcProject._projectFiles">
- <summary>
- Holds the files included in the project.
- </summary>
- <remarks>
- <para>
- For project files with no specific file configuration, the relative
- path is added to the list.
- </para>
- <para>
- For project files that have a specific file configuration, a
- <see cref="T:System.Collections.Hashtable"/> containing the <see cref="T:NAnt.VSNet.VcFileConfiguration"/>
- instance representing the file configurations is added.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcProject.Name">
- <summary>
- Gets the name of the Visual C++ project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProject.Type">
- <summary>
- Gets the type of the project.
- </summary>
- <value>
- The type of the project.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcProject.ProjectPath">
- <summary>
- Gets the path of the Visual C++ project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProject.ProjectDirectory">
- <summary>
- Gets the directory containing the VS.NET project.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProject.ProjectLocation">
- <summary>
- Get the location of the project.
- </summary>
- <value>
- <see cref="F:NAnt.VSNet.ProjectLocation.Local"/>.
- </value>
- <remarks>
- For now, we only support local Visual C++ projects.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcProject.ObjectDir">
- <summary>
- Get the directory in which intermediate build output that is not
- specific to the build configuration will be stored.
- </summary>
- <remarks>
- This is a directory relative to the project directory,
- named <c>temp\</c>.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcProject.Guid">
- <summary>
- Gets or sets the unique identifier of the Visual C++ project.
- </summary>
- </member>
- <member name="T:NAnt.VSNet.VcProjectConfiguration">
- <summary>
- Represents a Visual C++ project configuration.
- </summary>
- </member>
- <member name="M:NAnt.VSNet.VcProjectConfiguration.ExpandMacro(System.String)">
- <summary>
- Expands the given macro.
- </summary>
- <param name="macro">The macro to expand.</param>
- <returns>
- The expanded macro.
- </returns>
- <exception cref="T:NAnt.Core.BuildException">
- <para>The macro is not supported.</para>
- <para>-or-</para>
- <para>The macro is not implemented.</para>
- <para>-or-</para>
- <para>The macro cannot be expanded.</para>
- </exception>
- <exception cref="T:System.NotImplementedException">
- <para>Expansion of a given macro is not yet implemented.</para>
- </exception>
- </member>
- <member name="M:NAnt.VSNet.VcProjectConfiguration.GetXmlAttributeValue(System.Xml.XmlNode,System.String)">
- <summary>
- Gets the value of the specified attribute from the specified node.
- </summary>
- <param name="xmlNode">The node of which the attribute value should be retrieved.</param>
- <param name="attributeName">The attribute of which the value should be returned.</param>
- <returns>
- The value of the attribute with the specified name or <see langword="null" />
- if the attribute does not exist or has no value.
- </returns>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration._outputPath">
- <summary>
- Holds the output path for this build configuration.
- </summary>
- <remarks>
- Lazy initialized by <see cref="M:NAnt.VSNet.VcProjectConfiguration.Initialize"/>.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration._objFiles">
- <summary>
- Holds list of files to link in the order in which they are defined
- in the project file.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration._sourceConfigs">
- <summary>
- Holds the C++ sources for each build configuration.
- </summary>
- <remarks>
- The key of the hashtable is a build configuration, and the
- value is an ArrayList holding the C++ source files for that
- build configuration.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration._rcConfigs">
- <summary>
- Holds the resources for each build configuration.
- </summary>
- <remarks>
- The key of the hashtable is a build configuration, and the
- value is an ArrayList holding the resources files for that
- build configuration.
- </remarks>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration._idlConfigs">
- <summary>
- Holds the IDL files for each build configuration.
- </summary>
- <remarks>
- The key of the hashtable is a build configuration, and the
- value is an ArrayList holding the IDL files for that build
- configuration.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.CharacterSet">
- <summary>
- Tells the compiler which character set to use.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.ManagedExtensions">
- <summary>
- Gets a value indicating whether Managed Extensions for C++ are
- enabled.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.UseOfMFC">
- <summary>
- Gets a value indicating how MFC is used by the configuration.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.UseOfATL">
- <summary>
- Gets a value indicating how ATL is used by the configuration.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.ObjFiles">
- <summary>
- Gets the list of files to link in the order in which they are
- defined in the project file.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.SourceConfigs">
- <summary>
- Holds the C++ sources for each build configuration.
- </summary>
- <remarks>
- The key of the hashtable is a build configuration, and the
- value is an ArrayList holding the C++ source files for that
- build configuration.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.RcConfigs">
- <summary>
- Gets the resources for each build configuration.
- </summary>
- <remarks>
- The key of the hashtable is a build configuration, and the
- value is an ArrayList holding the resources files for that
- build configuration.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.IdlConfigs">
- <summary>
- Get the IDL files for each build configuration.
- </summary>
- <remarks>
- The key of the hashtable is a build configuration, and the
- value is an ArrayList holding the IDL files for that build
- configuration.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.TargetPath">
- <summary>
- Gets the target path for usage in macro expansion.
- </summary>
- <value>
- The target path, or a zero-length string if there's no output file
- for this configuration.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.ObjectDir">
- <summary>
- Get the directory in which intermediate build output will be stored
- for this configuration.
- </summary>
- <remarks>
- <para>
- This is a directory relative to the project directory named
- <c>obj\<configuration name></c>.
- </para>
- <para>
- <c>.resx</c> and <c>.licx</c> files will only be recompiled if the
- compiled resource files in the <see cref="P:NAnt.VSNet.VcProjectConfiguration.ObjectDir"/> are not
- uptodate.
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.RelativeOutputDir">
- <summary>
- Get the path of the output directory relative to the project
- directory.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.IntermediateDir">
- <summary>
- Gets the intermediate directory, specified relative to project
- directory.
- </summary>
- <value>
- The intermediate directory, specified relative to project directory.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.OutputPath">
- <summary>
- Gets the absolute path for the output file.
- </summary>
- <value>
- The absolute path for the output file, or <see langword="null" />
- if there's no output file for this configuration.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.ReferencesPath">
- <summary>
- Gets a comma-separated list of directories to scan for assembly
- references.
- </summary>
- <value>
- A comma-separated list of directories to scan for assembly
- references, or <see langword="null" /> if no additional directories
- should scanned.
- </value>
- </member>
- <member name="T:NAnt.VSNet.VcProjectConfiguration.ConfigurationType">
- <summary>
- The type of output for a given configuration.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration.ConfigurationType.Makefile">
- <summary>
- A Makefile.
- </summary>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration.ConfigurationType.Application">
- <summary>
- Application (.exe).
- </summary>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration.ConfigurationType.DynamicLibrary">
- <summary>
- Dynamic Library (.dll).
- </summary>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration.ConfigurationType.StaticLibrary">
- <summary>
- Static Library (.lib).
- </summary>
- </member>
- <member name="F:NAnt.VSNet.VcProjectConfiguration.ConfigurationType.Utility">
- <summary>
- Utility.
- </summary>
- </member>
- <member name="P:NAnt.VSNet.VcProjectConfiguration.LinkerConfig.ImportLibrary">
- <summary>
- Gets a <see cref="T:System.IO.FileInfo"/> instance representing the
- absolute path to the import library to generate.
- </summary>
- <value>
- A <see cref="T:System.IO.FileInfo"/> representing the absolute path to the
- import library to generate, or <see langword="null"/> if no
- import library must be generated.
- </value>
- </member>
- <member name="M:NAnt.VSNet.VcProjectReference.IsManaged(System.String)">
- <summary>
- Gets a value indicating whether the reference is managed for the
- specified configuration.
- </summary>
- <param name="config">The build configuration of the reference.</param>
- <returns>
- <see langword="true" /> if the reference is managed for the
- specified configuration; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.VSNet.VcWrapperReference.Name">
- <summary>
- Gets the name of the referenced assembly.
- </summary>
- <value>
- The name of the referenced assembly.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcWrapperReference.WrapperTool">
- <summary>
- Gets the name of the tool that should be used to create the
- <see cref="P:NAnt.VSNet.VcWrapperReference.WrapperAssembly"/>.
- </summary>
- <value>
- The name of the tool that should be used to create the
- <see cref="P:NAnt.VSNet.VcWrapperReference.WrapperAssembly"/>.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcWrapperReference.WrapperAssembly">
- <summary>
- Gets the path of the wrapper assembly.
- </summary>
- <value>
- The path of the wrapper assembly.
- </value>
- <remarks>
- The wrapper assembly is stored in the object directory of the
- project.
- </remarks>
- </member>
- <member name="P:NAnt.VSNet.VcWrapperReference.PrimaryInteropAssembly">
- <summary>
- Gets the path of the Primary Interop Assembly.
- </summary>
- <value>
- The path of the Primary Interop Assembly, or <see langword="null" />
- if not available.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcWrapperReference.TypeLibVersion">
- <summary>
- Gets the hex version of the type library as defined in the definition
- of the reference.
- </summary>
- <value>
- The hex version of the type library.
- </value>
- <exception cref="T:NAnt.Core.BuildException">The definition of the reference does not contain a "ControlVersion" attribute.</exception>
- </member>
- <member name="P:NAnt.VSNet.VcWrapperReference.TypeLibGuid">
- <summary>
- Gets the GUID of the type library as defined in the definition
- of the reference.
- </summary>
- <value>
- The GUID of the type library.
- </value>
- </member>
- <member name="P:NAnt.VSNet.VcWrapperReference.TypeLibLocale">
- <summary>
- Gets the locale of the type library in hex notation.
- </summary>
- <value>
- The locale of the type library.
- </value>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.Win32Tasks.dll
Binary file
slips/build/tools/nant/bin/NAnt.Win32Tasks.xml
@@ -1,690 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt.Win32Tasks</name>
- </assembly>
- <members>
- <member name="T:NAnt.Win32.Functions.CygpathFunctions">
- <summary>
- Groups a set of functions that convert Windows native filenames to
- Cygwin POSIX-style pathnames and vice versa.
- </summary>
- <remarks>
- 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.
- </remarks>
- </member>
- <member name="M:NAnt.Win32.Functions.CygpathFunctions.#ctor(NAnt.Core.Project,NAnt.Core.PropertyDictionary)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Win32.Functions.CygpathFunctions"/>
- class with the specified <see cref="T:NAnt.Core.Project"/> and properties.
- </summary>
- <param name="project">The <see cref="T:NAnt.Core.Project"/> in which the class is used.</param>
- <param name="properties">The set of properties to use for macro expansion.</param>
- </member>
- <member name="M:NAnt.Win32.Functions.CygpathFunctions.GetDosPath(System.String)">
- <summary>
- Gets the DOS (short) form of the specified path.
- </summary>
- <param name="path">The path to convert.</param>
- <returns>
- The DOS (short) form of the specified path.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>cygpath</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> could not be converted to a short form.</exception>
- </member>
- <member name="M:NAnt.Win32.Functions.CygpathFunctions.GetUnixPath(System.String)">
- <summary>
- Gets the Unix form of the specified path.
- </summary>
- <param name="path">The path to convert.</param>
- <returns>
- The Unix form of the specified path.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>cygpath</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> could not be converted to a Unix form.</exception>
- </member>
- <member name="M:NAnt.Win32.Functions.CygpathFunctions.GetWindowsPath(System.String)">
- <summary>
- Gets the Windows form of the specified path.
- </summary>
- <param name="path">The path to convert.</param>
- <returns>
- The Windows form of the specified path.
- </returns>
- <exception cref="T:System.ComponentModel.Win32Exception"><c>cygpath</c> could not be started.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="path"/> could not be converted to a Windows form.</exception>
- </member>
- <member name="M:NAnt.Win32.Functions.CygpathFunctions.RunCygpathString(NAnt.Core.Types.Argument[])">
- <summary>
- Runs cygpath with the specified arguments and returns the result
- as a <see cref="T:System.String"/>.
- </summary>
- <param name="args">The arguments to pass to cygpath.</param>
- <returns>
- The result of running cygpath with the specified arguments.
- </returns>
- </member>
- <member name="M:NAnt.Win32.Functions.CygpathFunctions.GetTask(System.IO.Stream)">
- <summary>
- Factory method to return a new instance of ExecTask
- </summary>
- <param name="stream"></param>
- <returns></returns>
- </member>
- <member name="T:NAnt.Win32.Tasks.AxImpTask">
- <summary>
- Generates a Windows Forms Control that wraps ActiveX Controls defined
- in an OCX.
- </summary>
- <example>
- <code>
- <![CDATA[
- <aximp ocx="MyControl.ocx" output="MyFormsControl.dll" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Win32.Tasks.AxImpTask.ExecuteTask">
- <summary>
- Import the ActiveX control.
- </summary>
- </member>
- <member name="M:NAnt.Win32.Tasks.AxImpTask.NeedsCompiling">
- <summary>
- Determines whether the assembly needs to be created again.
- </summary>
- <returns>
- <see langword="true" /> if the assembly needs to be created again;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.OcxFile">
- <summary>
- Filename of the .ocx file.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.OutputFile">
- <summary>
- Filename of the generated assembly.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.PublicKeyFile">
- <summary>
- Specifies the file containing the public key to use to sign the
- resulting assembly.
- </summary>
- <value>
- The file containing the public key to use to sign the resulting
- assembly.
- </value>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.KeyFile">
- <summary>
- Specifies the publisher's official public/private key pair with which
- the resulting assembly should be signed with a strong name.
- </summary>
- <value>
- The keyfile to use to sign the resulting assembly with a strong name.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.KeyContainer">
- <summary>
- 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.
- </summary>
- <value>
- The key container containing a public/private key pair that should
- be used to sign the resulting assembly.
- </value>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.DelaySign">
- <summary>
- Specifies to sign the resulting control using delayed signing.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.GenerateSource">
- <summary>
- Determines whether C# source code for the Windows Form wrapper should
- be generated. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.RcwFile">
- <summary>
- Assembly to use for Runtime Callable Wrapper rather than generating
- new one [.NET 1.1 or higher].
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.SupportsRcw">
- <summary>
- Indicates whether <c>aximp</c> supports using an existing Runtime
- Callable Wrapper for a given target framework. The default is
- <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.AxImpTask.ProgramArguments">
- <summary>
- Gets the command-line arguments for the external program.
- </summary>
- <value>
- The command-line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.Win32.Tasks.ReadRegistryTask">
- <summary>
- Reads a value or set of values from the Windows Registry into one or
- more NAnt properties.
- </summary>
- <example>
- <para>Read a single value from the registry.</para>
- <code>
- <![CDATA[
- <readregistry property="sdkRoot" key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot" hive="LocalMachine" />
- ]]>
- </code>
- <para>Read all the registry values in a key.</para>
- <code>
- <![CDATA[
- <readregistry prefix="dotNetFX" key="SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot" hive="LocalMachine" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Win32.Tasks.ReadRegistryTask.ExecuteTask">
- <summary>
- read the specified registry value
- </summary>
- </member>
- <member name="M:NAnt.Win32.Tasks.ReadRegistryTask.LookupRegKey(System.String,Microsoft.Win32.RegistryHive[])">
- <summary>
- Returns the hive for a given key.
- </summary>
- <param name="key"></param>
- <param name="registries"></param>
- <returns>
- The hive for a given key.
- </returns>
- </member>
- <member name="M:NAnt.Win32.Tasks.ReadRegistryTask.GetHiveKey(Microsoft.Win32.RegistryHive)">
- <summary>
- Returns the key for a given registry hive.
- </summary>
- <param name="hive">The registry hive to return the key for.</param>
- <returns>
- The key for a given registry hive.
- </returns>
- </member>
- <member name="P:NAnt.Win32.Tasks.ReadRegistryTask.PropertyName">
- <summary>
- <para>The property to set to the specified registry key value.</para>
- <para>If this attribute is used then a single value will be read.</para>
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.ReadRegistryTask.PropertyPrefix">
- <summary>
- <para>The prefix to use for the specified registry key values.</para>
- <para>If this attribute is used then all registry values will be read and stored as properties with this prefix.</para>
- </summary>
- <example>
- <para>Registry values a, b, c will be turned into prefixa, prefixb, prefixc named properties</para>
- </example>
- </member>
- <member name="P:NAnt.Win32.Tasks.ReadRegistryTask.RegistryKey">
- <summary>
- The registry key to read, including the path.
- </summary>
- <example>
- SOFTWARE\Microsoft\.NETFramework\sdkInstallRoot
- </example>
- </member>
- <member name="P:NAnt.Win32.Tasks.ReadRegistryTask.RegistryHiveName">
- <summary>
- Space separated list of registry hives to search for <see cref="P:NAnt.Win32.Tasks.ReadRegistryTask.RegistryKey"/>.
- For a list of possible values, see <see cref="T:Microsoft.Win32.RegistryHive"/>. The
- default is <see cref="F:Microsoft.Win32.RegistryHive.LocalMachine"/>.
- </summary>
- <remarks>
- <seealso cref="T:Microsoft.Win32.RegistryHive"/>
- </remarks>
- </member>
- <member name="T:NAnt.Win32.Tasks.RegAsmTask">
- <summary>
- Registers an assembly, or set of assemblies for use from COM clients.
- </summary>
- <remarks>
- <para>
- Refer to the <see href="ms-help://MS.VSCC/MS.MSDNVS/cptools/html/cpgrfassemblyregistrationtoolregasmexe.htm">Regasm</see>
- documentation for more information on the regasm tool.
- </para>
- </remarks>
- <example>
- <para>
- Register types in a single assembly.
- </para>
- <code>
- <![CDATA[
- <regasm assembly="myAssembly.dll" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Register types of an assembly and generate a type library containing
- definitions of accessible types defined within the assembly.
- </para>
- <code>
- <![CDATA[
- <regasm assembly="myAssembly.dll" typelib="myAssembly.tlb" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- Register types of set of assemblies at once, while specifying a set
- of reference assemblies.
- </para>
- <code>
- <![CDATA[
- <regasm codebase="true">
- <assemblies>
- <include name="OutlookAddin.dll" />
- <include name="OfficeCoreAddin.dll" />
- </assemblies>
- <references>
- <include name="CommonTypes.dll" />
- </references>
- </regasm>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Win32.Tasks.RegAsmTask.PrepareProcess(System.Diagnostics.Process)">
- <summary>
- Updates the <see cref="T:System.Diagnostics.ProcessStartInfo"/> of the specified
- <see cref="T:System.Diagnostics.Process"/>.
- </summary>
- <param name="process">The <see cref="T:System.Diagnostics.Process"/> of which the <see cref="T:System.Diagnostics.ProcessStartInfo"/> should be updated.</param>
- </member>
- <member name="M:NAnt.Win32.Tasks.RegAsmTask.ExecuteTask">
- <summary>
- Registers or unregisters a single assembly, or a group of assemblies.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.AssemblyFile">
- <summary>
- The name of the file to register. This is provided as an alternate
- to using the task's <see cref="P:NAnt.Win32.Tasks.RegAsmTask.Assemblies"/>.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.RegistryFile">
- <summary>
- Registry file to export to instead of entering the types directly
- into the registry.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.CodeBase">
- <summary>
- Set the code base registry setting.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.Registered">
- <summary>
- Only refer to already registered type libraries.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.TypeLib">
- <summary>
- Export the assemblies to the specified type library and register it.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.Unregister">
- <summary>
- Unregister the assembly. The default is <see langword="false" />.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.Assemblies">
- <summary>
- The set of assemblies to register, or unregister.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.References">
- <summary>
- The set of assembly references.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.BaseDirectory">
- <summary>
- Gets the working directory for the application.
- </summary>
- <value>
- The working directory for the application.
- </value>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.ProgramArguments">
- <summary>
- Gets the command line arguments for the external program.
- </summary>
- <value>
- The command line arguments for the external program.
- </value>
- </member>
- <member name="P:NAnt.Win32.Tasks.RegAsmTask.ProgramFileName">
- <summary>
- Gets the filename of the external program to start.
- </summary>
- <value>
- The filename of the external program.
- </value>
- <remarks>
- Override in derived classes to explicitly set the location of the
- external tool.
- </remarks>
- </member>
- <member name="T:NAnt.Win32.Tasks.TlbExpTask">
- <summary>
- Exports a .NET assembly to a type library that can be used from unmanaged
- code (wraps Microsoft's <c>tlbexp.exe</c>).
- </summary>
- <remarks>
- <para>
- <see href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryexportertlbexpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</see>
- </para>
- </remarks>
- <example>
- <para>Export <c>DotNetAssembly.dll</c> to <c>LegacyCOM.dll</c>.</para>
- <code>
- <![CDATA[
- <tlbexp assembly="DotNetAssembly.dll" output="LegacyCOM.dll" />
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Win32.Tasks.TlbExpTask.ExecuteTask">
- <summary>
- Exports the type library.
- </summary>
- </member>
- <member name="M:NAnt.Win32.Tasks.TlbExpTask.NeedsCompiling">
- <summary>
- Determines whether the assembly needs to be exported to a type
- library again.
- </summary>
- <returns>
- <see langword="true" /> if the assembly needs to be exported to a
- type library; otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbExpTask.AssemblyFile">
- <summary>
- Specifies the assembly for which to export a type library.
- </summary>
- <value>
- The assembly for which to export a type library.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryexportertlbexpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbExpTask.OutputFile">
- <summary>
- Specifies the name of the type library file to generate.
- </summary>
- <value>
- The name of the type library file to generate.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryexportertlbexpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbExpTask.NamesFile">
- <summary>
- Specifies the file used to determine capitalization of names in a
- type library.
- </summary>
- <value>
- The file used to determine capitalization of names in a type library.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryexportertlbexpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbExpTask.ProgramArguments">
- <summary>
- Gets the command line arguments for the external program.
- </summary>
- <value>
- The command line arguments for the external program.
- </value>
- </member>
- <member name="T:NAnt.Win32.Tasks.TlbImpTask">
- <summary>
- Imports a type library to a .NET assembly (wraps Microsoft's <c>tlbimp.exe</c>).
- </summary>
- <remarks>
- <para>
- This task lets you easily create interop assemblies. By default, it will
- not reimport if the underlying COM TypeLib or reference has not changed.
- </para>
- <para>
- <see href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</see>
- </para>
- </remarks>
- <example>
- <para>Import <c>LegacyCOM.dll</c> to <c>DotNetAssembly.dll</c>.</para>
- <code>
- <![CDATA[
- <tlbimp typelib="LegacyCOM.dll" output="DotNetAssembly.dll" />
- ]]>
- </code>
- </example>
- <example>
- <para>
- 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.
- </para>
- <code>
- <![CDATA[
- <tlbimp typelib="msvidctl.dll" output="Interop.MSVidCtlLib.dll" transform="dispret">
- <references basedir="Interop">
- <include name="Interop.TunerLib.dll" />
- </references>
- </tlbimp>
- ]]>
- </code>
- </example>
- </member>
- <member name="M:NAnt.Win32.Tasks.TlbImpTask.ExecuteTask">
- <summary>
- Imports the type library to a .NET assembly.
- </summary>
- </member>
- <member name="M:NAnt.Win32.Tasks.TlbImpTask.ExtractTypeLibPath(System.String)">
- <summary>
- Returns the path of the type library, removing the identifier of
- the type library from the specified string.
- </summary>
- <param name="path">The path from which to extract the path of the type library.</param>
- <returns>
- The path of the type library without the type library identifier.
- </returns>
- <remarks>
- An example of a path which includes the identifier of the type
- library (in this case "2") is
- <c>C:\WINDOWS\system32\msvidctl.dll\2</c>.
- </remarks>
- </member>
- <member name="M:NAnt.Win32.Tasks.TlbImpTask.NeedsCompiling">
- <summary>
- Determines whether the type library needs to be imported again.
- </summary>
- <returns>
- <see langword="true" /> if the type library needs to be imported;
- otherwise, <see langword="false" />.
- </returns>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.OutputFile">
- <summary>
- Specifies the name of the output file.
- </summary>
- <value>
- The name of the output file.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.Namespace">
- <summary>
- Specifies the namespace in which to produce the assembly.
- </summary>
- <value>
- The namespace in which to produce the assembly.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.AsmVersion">
- <summary>
- Specifies the version number of the assembly to produce.
- </summary>
- <remarks>
- <value>
- The version number of the assembly to produce.
- </value>
- <para>
- The version number should be in the format major.minor.build.revision.
- </para>
- <para>
- <a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a>
- </para>
- </remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.DelaySign">
- <summary>
- Specifies whether the resulting assembly should be signed with a
- strong name using delayed signing. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if the resulting assembly should be signed
- with a strong name using delayed signing; otherwise, <see langword="false" />.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.Primary">
- <summary>
- Specifies whether a primary interop assembly should be produced for
- the specified type library. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if a primary interop assembly should be
- produced; otherwise, <see langword="false" />.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.PublicKeyFile">
- <summary>
- Specifies the file containing the public key to use to sign the
- resulting assembly.
- </summary>
- <value>
- The file containing the public key to use to sign the resulting
- assembly.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.KeyFile">
- <summary>
- Specifies the publisher's official public/private key pair with which
- the resulting assembly should be signed with a strong name.
- </summary>
- <value>
- The keyfile to use to sign the resulting assembly with a strong name.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.KeyContainer">
- <summary>
- 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.
- </summary>
- <value>
- The key container containing a public/private key pair that should
- be used to sign the resulting assembly.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.References">
- <summary>
- Specifies the assembly files to use to resolve references to types
- defined outside the current type library.
- </summary>
- <value>
- The assembly files to use to resolve references to types defined
- outside the current type library.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.StrictRef">
- <summary>
- 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 <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if a type library should not be imported if
- all references cannot be resolved; otherwise, <see langword="false" />.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.SysArray">
- <summary>
- Specifies whether to import a COM style SafeArray as a managed
- <see cref="T:System.Array"/> class type. The default is <see langword="false"/>.
- </summary>
- <value>
- <see langword="true"/> if a COM style SafeArray should be imported
- as a managed <see cref="T:System.Array"/> class type; otherwise,
- <see langword="false"/>.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.Transform">
- <summary>
- Specifies how to transform the metadata [.NET 1.1 or higher].
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.TypeLib">
- <summary>
- Specifies the source type library that gets passed to the type
- library importer.
- </summary>
- <value>
- The source type library that gets passed to the type library
- importer.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.Unsafe">
- <summary>
- Specifies whether interfaces should be produced without .NET Framework
- security checks. The default is <see langword="false" />.
- </summary>
- <value>
- <see langword="true" /> if interfaces without .NET Framework security
- checks should be produced; otherwise, <see langword="false" />.
- </value>
- <remarks><a href="ms-help://MS.NETFrameworkSDK/cptools/html/cpgrftypelibraryimportertlbimpexe.htm">See the Microsoft.NET Framework SDK documentation for details.</a></remarks>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.SupportsTransform">
- <summary>
- Indicates whether <c>tlbimp</c> supports transforming metadata for
- a given target framework. The default is <see langword="true" />.
- </summary>
- </member>
- <member name="P:NAnt.Win32.Tasks.TlbImpTask.ProgramArguments">
- <summary>
- Gets the command line arguments for the external program.
- </summary>
- <value>
- The command line arguments for the external program.
- </value>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NAnt.xml
@@ -1,78 +0,0 @@
-<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>NAnt</name>
- </assembly>
- <members>
- <member name="T:NAnt.Console.ConsoleStub">
- <summary>
- Stub used to created <see cref="T:System.AppDomain"/> and launch real <c>ConsoleDriver</c>
- class in Core assembly.
- </summary>
- </member>
- <member name="M:NAnt.Console.ConsoleStub.Main(System.String[])">
- <summary>
- Entry point for executable
- </summary>
- <param name="args">Command Line arguments</param>
- <returns>The result of the real execution</returns>
- </member>
- <member name="M:NAnt.Console.ConsoleStub.ConstructPrivateBinPath(NAnt.Console.ConsoleStub.Framework,System.String)">
- <summary>
- Constructs the privatebinpath.
- </summary>
- <remarks>
- <para>
- 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).
- </para>
- </remarks>
- <param name="runtimeFramework">The runtime framework.</param>
- <param name="baseDir">The base directory of the domain.</param>
- <returns>
- The privatebinpath.
- </returns>
- </member>
- <member name="M:NAnt.Console.ConsoleStub.GetRelativePath(System.String,System.String)">
- <summary>
- Given an absolute directory and an absolute file name, returns a
- relative file name.
- </summary>
- <param name="basePath">An absolute directory.</param>
- <param name="absolutePath">An absolute file name.</param>
- <returns>
- A relative file name for the given absolute file name.
- </returns>
- </member>
- <member name="T:NAnt.Console.ConsoleStub.HelperArguments">
- <summary>
- Helper class for invoking the application entry point in NAnt.Core
- and passing the command-line arguments.
- </summary>
- </member>
- <member name="M:NAnt.Console.ConsoleStub.HelperArguments.#ctor(System.String[],System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:NAnt.Console.ConsoleStub.HelperArguments"/>
- class with the specified command-line arguments.
- </summary>
- <param name="args">The commandline arguments passed to NAnt.exe.</param>
- <param name="probePaths">Directories relative to the base directory of the AppDomain to probe for missing assembly references.</param>
- </member>
- <member name="M:NAnt.Console.ConsoleStub.HelperArguments.CallConsoleRunner">
- <summary>
- Invokes the application entry point in NAnt.Core.
- </summary>
- </member>
- <member name="P:NAnt.Console.ConsoleStub.HelperArguments.ExitCode">
- <summary>
- Gets the status that the build process returned when it exited.
- </summary>
- <value>
- The code that the build process specified when it terminated.
- </value>
- </member>
- </members>
-</doc>
slips/build/tools/nant/bin/NDoc.Documenter.NAnt.dll
Binary file
slips/build/tools/nant/bin/scvs.exe
Binary file
slips/build/tools/nant/bin/SLiNgshoT.Core.dll
Binary file
slips/build/tools/nant/bin/SLiNgshoT.exe
Binary file
slips/build/tools/nant/bin/SourceSafe.Interop.dll
Binary file
slips/build/tools/nant/bin/Vitreo.Nant.dll
Binary file