NAnt SDK Documentation - v0.92

ClTask Members

ClTask overview

Public Static (Shared) Methods

GetObjOutputFile Determines the file name of the OBJ file for the specified source file.
QuoteArgumentValue Quotes an argument value and duplicates trailing backslahes.

Public Instance Constructors

ClTask Constructor Initializes a new instance of the ClTask class.

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.
CharacterSet Tells the compiler to use the specified character set.
CommandLine (inherited from ExternalProgramBase) Gets the command-line arguments, separated by spaces.
Defines Macro definitions to pass to cl.exe. Each entry will generate a /D
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.
ForcedUsingFiles Specifies metadata files to reference in this compilation as an alternative to passing a file name to #using in source code.
IfDefined (inherited from Task) If true then the task will be executed; otherwise, skipped. The default is true.
IncludeDirs The list of directories in which to search for include files.
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.
ManagedExtensions Specifies whether Managed Extensions for C++ should be enabled. The default is false.
MetaDataIncludeDirs Directories that the compiler will search to resolve file references passed to the #using directive.
Name (inherited from Task) The name of the task.
NamespaceManager (inherited from Element) Gets or sets the XmlNamespaceManager.
ObjectFile A name to override the default object file name; can be either a file or directory name. The default is the output directory.
Options Options to pass to the compiler.
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.
OutputDir Directory where all output files are placed.
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.
PchFile Specifies the path and/or name of the generated precompiled header file - given either relative to OutputDir or as an absolute path.
PchMode The mode in which the specified PchFile (if any) is used. The default is Use.
PchThroughFile The path of the boundary file when generating/using the specified PchFile. If a precompiled header file is not specified then this attribute is ignored.
ProgramArguments Gets the command-line arguments for the external program.
ProgramDatabaseFile A name for the compiler-generated PDB file; can be either a file or directory name. The default is the output directory.
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.
Sources The list of files to compile.
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.
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.
Undefines Macro undefines (/U) to pass to cl.exe.
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.
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.
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 Compiles the sources.
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.
NeedsCompiling Determines if the sources need to be compiled.
PrepareProcess (inherited from ExternalProgramBase) Updates the ProcessStartInfo of the specified Process.
StartProcess (inherited from ExternalProgramBase) Starts the process and handles errors.

See Also

ClTask Class | NAnt.VisualCpp.Tasks Namespace