NAnt SDK Documentation - v0.92 |

# AbstractSourceControlTask Members

AbstractSourceControlTask overview

#### Protected Static (Shared) Fields

AppData | Used on windows to specify the location of application data.
CvsPassFileVariable | The environment variable that holds the location of the .cvspass file.
EnvHome | Name of the environmental variable specifying a users' home in a *nix environment.
PathVariable | The environment variable that holds path information.
PropExeName | Property name used to specify the source control executable. This is used as a readonly property.

#### 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.
CommandLine (inherited from ExternalProgramBase) | Gets the command-line arguments, separated by spaces.
CommandLineArguments | 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 command that is going to be executed.
CommandOptions | 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.
DestinationDirectory | 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 | The name of the version control system 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 | 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.
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 | The full path to the cached password file. If not specified then the environment variables are used to try and locate the file.
Password | Obsolete. The password for logging in to the repository.
ProgramArguments | 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.
Root | The root variable contains information on how to locate a repository. Although this information is in different formats it typically must define the following:
server location
protocol used to communicate with the repository
repository location on the server
project location in the repository
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 | The executable to use for ssh communication.
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.
VcsFileSet | Used to specify the version control system (VCS) files that are going to be acted on.
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 Constructors

AbstractSourceControlTask Constructor | Initializes a new instance of the AbstractCvsTask class.

#### 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.
Location (inherited from Element) | Gets or sets the location in the build file where the element is defined.
PassFileName | The name of the passfile, overriden for each version control system (VCS).
ProcessId (inherited from ExternalProgramBase) | Gets the unique identifier for the spawned application.
SshEnv | The environment name for the ssh variable.
VcsExeName | The name of the version control system (VCS) executable file.
VcsHome | 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 | The environment variable that defines where the version control system (VCS) home variable is kept.
XmlNode (inherited from Element) | Gets or sets the XML node of the element.

#### Protected Instance Methods

AppendFiles | 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.
CopyTo (inherited from Element) | Copies all instance data of the Element to a given Element.
DeriveVcsFromEnvironment | 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 | 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 | Adds a new command option if none exists. If one does exist then the use switch is toggled on or of.
SetEnvironment | Set up the environment variables for a process.
SetGlobalOption | 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.

#### See Also

AbstractSourceControlTask Class | NAnt.SourceControl.Tasks Namespace