NAnt SDK Documentation - v0.92 |

# TagTask Members

TagTask overview

#### Public Instance Constructors

TagTask Constructor | Initializes a new instance of the TagTask class.

#### Public Instance Properties

ActOnDate | Indicates the revision date of the file that the tag should be applied to.
ActOnTag | Indicates the repository Tag that is acted on for the tag command. Note if MoveIfExists is true then the tag specified is moved to the revision of the file on the HEAD of the branch specified.
Arguments (inherited from ExternalProgramBase) | The command-line arguments for the external program.
BaseDirectory (inherited from ExternalProgramBase) | Gets the working directory for the application.
CommandLine (inherited from ExternalProgramBase) | Gets the command-line arguments, separated by spaces.
CommandLineArguments (inherited from AbstractSourceControlTask) | 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.
CommandName | The name of the cvs command that is going to be executed.
CommandOptions (inherited from AbstractSourceControlTask) | 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.
CompressionLevel (inherited from AbstractCvsTask) | Compression level to use for all net traffic. This should be a value from 1-9. NOTE: This is not available on sharpcvslib.
CvsFileSet (inherited from AbstractCvsTask) | Used to specify the version control system (VCS) files that are going to be acted on.
CvsFullPath (inherited from AbstractCvsTask) | 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.
DestinationDirectory (inherited from AbstractSourceControlTask) | Destination directory for the local sandbox. If destination is not specified then the current directory is used.
ErrorWriter (inherited from ExternalProgramBase) | Gets or sets the TextWriter to which error output of the external program will be written.
ExeName (inherited from AbstractCvsTask) | The name of the cvs executable.
ExitCode (inherited from ExternalProgramBase) | Gets the value that the process specified when it terminated.
FailIfModified | Indicates whether the head revision should be used if the ActOnTag or the ActOnDate tags are not found.
FailOnError (inherited from Task) | Determines if task failure stops the build, or is just reported. The default is true.
ForceHead | Indicates whether the head revision should be used if the revision specified by ActOnTag or the ActOnDate tags are not found.
GlobalOptions (inherited from AbstractSourceControlTask) | Holds a collection of globally available options.
IfDefined (inherited from Task) | If true then the task will be executed; otherwise, skipped. The default is true.
LogPrefix (inherited from Task) | Obsolete. The prefix used when sending messages to the log.
Managed (inherited from ExternalProgramBase) | Specifies whether the external program should be treated as a managed application, possibly forcing it to be executed under the currently targeted version of the CLR.
Module | Not used
MoveIfExists | Indicates whether the tag specified in Tag should be moved to the current file revision. If the tag does not exist then it is created.
Name (inherited from Task) | The name of the task.
NamespaceManager (inherited from Element) | Gets or sets the XmlNamespaceManager.
Output (inherited from ExternalProgramBase) | Gets the file to which the standard output should be redirected.
OutputAppend (inherited from ExternalProgramBase) | Gets a value indicating whether output will be appended to the Output.
OutputWriter (inherited from ExternalProgramBase) | Gets or sets the TextWriter to which standard output messages of the external program will be written.
Parent (inherited from Element) | Gets or sets the parent of the element.
PassFile (inherited from AbstractSourceControlTask) | The full path to the cached password file. If not specified then the environment variables are used to try and locate the file.
Password (inherited from AbstractSourceControlTask) | Obsolete. The password for logging in to the repository.
ProgramArguments (inherited from AbstractSourceControlTask) | Get the command line arguments for the task.
ProgramFileName (inherited from ExternalProgramBase) | Gets the filename of the external program to start.
Project (inherited from Element) | Gets or sets the Project to which this element belongs.
Properties (inherited from Element) | Gets the properties local to this Element and the Project.
Quiet (inherited from AbstractCvsTask) | Indicates if the output from the cvs command should be supressed. The default is false.
ReadOnly (inherited from AbstractCvsTask) | true if the sandbox files should be checked out in read only mode. The default is false.
ReadWrite (inherited from AbstractCvsTask) | true if the sandbox files should be checked out in read/write mode. The default is true.
ReallyQuiet (inherited from AbstractCvsTask) | Indicates if the output from the cvs command should be stopped. The default is false.
Recursive | If a directory is specified indicates whether sub-directories should also be processed.
Remove | Indicates whether the tag specified in Tag should be removed or not.
Root (inherited from AbstractCvsTask) | The cvs root variable has the following components:
    [protocol]:[username]@[servername]:[server path]
protocol: ext, pserver, ssh (sharpcvslib); if you are not using sharpcvslib consult your cvs documentation. username: [username] servername: cvs.sourceforge.net server path: /cvsroot/nant
Spawn (inherited from ExternalProgramBase) | 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 false.
Ssh (inherited from AbstractCvsTask) | The executable to use for ssh communication.
Tag | The name of the tag to assign or remove.
Threshold (inherited from Task) | Gets or sets the log threshold for this Task. By default the threshold of a task is Debug, causing no messages to be filtered in the task itself.
TimeOut (inherited from ExternalProgramBase) | The maximum amount of time the application is allowed to execute, expressed in milliseconds. Defaults to no time-out.
UnlessDefined (inherited from Task) | Opposite of IfDefined. If false then the task will be executed; otherwise, skipped. The default is false.
UseRuntimeEngine (inherited from ExternalProgramBase) | Obsolete. Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false.
UseSharpCvsLib (inherited from AbstractCvsTask) | true if the SharpCvsLib binaries that come bundled with NAnt should be used to perform the cvs commands, false otherwise. You may also specify an override value for all cvs tasks instead of specifying a value for each. To do this set the property `sourcecontrol.usesharpcvslib` to false. If you choose not to use SharpCvsLib to checkout from cvs you will need to include a cvs.exe binary in your path.
VcsFileSet (inherited from AbstractCvsTask) | Get the cvs file set.
Verbose (inherited from Task) | Determines whether the task should report detailed build log messages. The default is false.

#### Public Instance Methods

Equals (inherited from Object) | Determines whether the specified Object is equal to the current Object.
Execute (inherited from Task) | Executes the task unless it is skipped.
GetHashCode (inherited from Object) | Serves as a hash function for a particular type.
GetLocation (inherited from Element) | Retrieves the location in the build file where the element is defined.
GetType (inherited from Object) | Gets the Type of the current instance.
Initialize (inherited from Element) | Overloaded. Performs default initialization.
InitializeTaskConfiguration (inherited from Task) | Initializes the configuration of the task using configuration settings retrieved from the NAnt configuration file.
IsLogEnabledFor (inherited from Task) | Determines whether build output is enabled for the given Level.
Log (inherited from Task) | Overloaded. Logs a message with the given priority.
ToString (inherited from Object) | Returns a String that represents the current Object.

#### Protected Instance Properties

CustomXmlProcessing (inherited from Element) | Gets a value indicating whether the element is performing additional processing using the XmlNode that was used to initialize the element.
IsModuleNeeded | 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.
Location (inherited from Element) | Gets or sets the location in the build file where the element is defined.
PassFileName (inherited from AbstractCvsTask) | The name of the pass file, or `.cvspass` at the time of this writing.
ProcessId (inherited from ExternalProgramBase) | Gets the unique identifier for the spawned application.
SshEnv (inherited from AbstractCvsTask) | The environment name for the ssh variable.
VcsExeName (inherited from AbstractCvsTask) | The name of the cvs binary, or `cvs.exe` at the time this was written.
VcsHome (inherited from AbstractSourceControlTask) | 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.
VcsHomeEnv (inherited from AbstractCvsTask) | The name of the version control system specific home environment variable.
XmlNode (inherited from Element) | Gets or sets the XML node of the element.

#### Protected Instance Methods

AddArg (inherited from AbstractCvsTask) | 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.
AppendFiles (inherited from AbstractSourceControlTask) | 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.
AppendSubCommandArgs | Append the tag information to the commandline.
CopyTo (inherited from Element) | Copies all instance data of the Element to a given Element.
DeriveVcsFromEnvironment (inherited from AbstractSourceControlTask) | Derive the location of the version control system from the environment variable
    PATH
.
ExecuteTask (inherited from ExternalProgramBase) | Starts the external process and captures its output.
Finalize (inherited from Object) | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
GetAttributeConfigurationNode (inherited from Task) | Overloaded. Locates the XML node for the specified attribute in either the configuration section of the extension assembly or the.project.
GetAttributeConfigurationNode (inherited from Element) | Overloaded. Locates the XML node for the specified attribute in the project configuration node.
Initialize (inherited from Task) | Overloaded. Initializes the task.
InitializeElement (inherited from Element) | Obsolete. Derived classes should override to this method to provide extra initialization and validation not covered by the base class.
InitializeTask (inherited from Task) | Obsolete. Initializes the task.
InitializeXml (inherited from Element) | Initializes all build attributes and child elements.
MemberwiseClone (inherited from Object) | Creates a shallow copy of the current Object.
PrepareProcess (inherited from AbstractCvsTask) | Build up the command line arguments, determine which executable is being used and find the path to that executable and set the working directory.
SetCommandOption (inherited from AbstractSourceControlTask) | Adds a new command option if none exists. If one does exist then the use switch is toggled on or of.
SetEnvironment (inherited from AbstractSourceControlTask) | Set up the environment variables for a process.
SetGlobalOption (inherited from AbstractSourceControlTask) | Adds a new global option if none exists. If one does exist then the use switch is toggled on or of.
StartProcess (inherited from ExternalProgramBase) | Starts the process and handles errors.
ToCvsDateTimeString (inherited from AbstractCvsTask) | Converts a date value to a string representation that can be interpreted by cvs.

#### See Also

TagTask Class | NAnt.SourceControl.Tasks Namespace