NAnt SDK Documentation - v0.92 |

# UpdateTask Properties

The properties of the UpdateTask class are listed below. For a complete list of UpdateTask class members, see the UpdateTask Members topic.

#### Public Instance Properties

Arguments (inherited from ExternalProgramBase) | The command-line arguments for the external program.
BaseDirectory (inherited from ExternalProgramBase) | Gets the working directory for the application.
BuildDirs | If true. new directories will be created on the local sandbox. The default is true.
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.
Date | Specify the revision date to update to. The version of the file that existed at the date specified is retrieved.
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.
FailOnError (inherited from Task) | Determines if task failure stops the build, or is just reported. The default is true.
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 (inherited from AbstractCvsTask) | The module to perform an operation on.
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.
OverwriteLocal | If true the local copy of the file will be overwritten with the copy from the remote repository. The default is false.
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.
PruneEmpty | If true empty directories copied down from the remote repository will be removed from the local sandbox. The default is true.
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 | Specifies if the command should be executed recursively. The default is true.
Revision | Specify the revision to update the file to. This corresponds to the "sticky-tag" of the file.
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.
StickyTag | Sticky tag or revision to update the local file to.
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.

#### 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.

#### See Also

UpdateTask Class | NAnt.SourceControl.Tasks Namespace