NAnt SDK Documentation - v0.92

ExecTask Members

ExecTask overview

Public Instance Constructors

ExecTask Constructor Initializes a new instance of the ExecTask class.

Public Instance Properties

Arguments (inherited from ExternalProgramBase) The command-line arguments for the external program.
BaseDirectory The directory the program is in.
CommandLine (inherited from ExternalProgramBase) Gets the command-line arguments, separated by spaces.
CommandLineArguments 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 Arguments elements instead.
EnvironmentSet Environment variables to pass to the program.
ErrorWriter (inherited from ExternalProgramBase) Gets or sets the TextWriter to which error output of the external program will be written.
ExeName (inherited from ExternalProgramBase) The name of the executable that should be used to launch the external program.
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.
FileName The program to execute without command arguments.
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 Specifies whether the external program is a managed application which should be executed using a runtime engine, if configured. The default is false.
Name (inherited from Task) The name of the task.
NamespaceManager (inherited from Element) Gets or sets the XmlNamespaceManager.
Output The file to which the standard output will be redirected.
OutputAppend Gets or sets a value indicating whether output should be appended to the output file. The default is false.
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.
ProcessIdProperty The name of a property in which the unique identifier of the spawned application should be stored. Only of interest if Spawn is true.
ProgramArguments Gets the command-line arguments for the external program.
ProgramFileName 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.
ResultProperty The name of a property in which the exit code of the program should be stored. Only of interest if FailOnError is false. If the exit code of the program is "-1000" then the program could not be started, or did not exit (in time).
Spawn 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.
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.
UseRuntimeEngineObsolete. Specifies whether the external program should be executed using a runtime engine, if configured. The default is false.
Verbose (inherited from Task) Determines whether the task should report detailed build log messages. The default is false.
WorkingDirectory The directory in which the command will be executed.

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.
Location (inherited from Element) Gets or sets the location in the build file where the element is defined.
ProcessId (inherited from ExternalProgramBase) Gets the unique identifier for the spawned application.
XmlNode (inherited from Element) Gets or sets the XML node of the element.

Protected Instance Methods

CopyTo (inherited from Element) Copies all instance data of the Element to a given Element.
ExecuteTask Executes the external program.
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.
InitializeOverloaded. Performs additional checks after the task has been initialized.
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 
StartProcess (inherited from ExternalProgramBase) Starts the process and handles errors.

See Also

ExecTask Class | NAnt.Core.Tasks Namespace