VCBuild Class

Reference

Definition

Namespace:: Microsoft.Build.Tasks

Assembly:: Microsoft.Build.Tasks.dll

Assemblies:: Microsoft.Build.Tasks.dll, Microsoft.Build.Tasks.v3.5.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Implements the VCBuild task. Use the VCBuild element in your project file to create and execute this task.

This API supports the product infrastructure and is not intended to be used directly from your code.

public ref class VCBuild : Microsoft::Build::Tasks::ToolTaskExtension

public class VCBuild : Microsoft.Build.Tasks.ToolTaskExtension

type VCBuild = class
    inherit ToolTaskExtension

Public Class VCBuild
Inherits ToolTaskExtension

Inheritance: Object

Task

ToolTask

ToolTaskExtension
VCBuild

Constructors

VCBuild()

Initializes a new instance of the VCBuild class.

Properties

AdditionalLibPaths	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets additional paths to append to the LIBPATH environment variable before executing vcbuild.exe.
AdditionalLinkLibraryPaths	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets additional reference paths to append to the LIB environment variable.
AdditionalOptions	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets additional options you want to specify to the VCBuild tool.
Bag	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the collection of parameters used by the derived task class. (Inherited from ToolTaskExtension)
BuildEngine	The build engine automatically sets this property to allow tasks to call back into it. (Inherited from Task)
BuildEngine2	The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2. (Inherited from Task)
Clean	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the `VCBuild` task outputs only clean build outputs.
Configuration	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the configuration and platform to build with, such as `Debug\|Win32`.
EnvironmentOverride	This API supports the product infrastructure and is not intended to be used directly from your code. Overrides the LIBPATH environment variable with AdditionalLibPaths and returns the new environment variables.
ExitCode	The return code of the spawned process. If the task logged any errors, but the process had an exit code of 0 (success), this will be set to -1. (Inherited from ToolTask)
HasLoggedErrors	This API supports the product infrastructure and is not intended to be used directly from your code. Whether this ToolTaskExtension has logged any errors (Inherited from ToolTaskExtension)
HelpKeywordPrefix	Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method. (Inherited from Task)
HostObject	The build engine sets this property if the host IDE has associated a host object with this particular task. (Inherited from Task)
Log	This API supports the product infrastructure and is not intended to be used directly from your code. Gets an instance of a TaskLoggingHelperExtension class containing task logging methods. (Inherited from ToolTaskExtension)
Override	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the location of a VCBuild property sheet file that overrides project file settings.
Platform	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the platform to build for.
Projects	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the projects to build.
Rebuild	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether the task performs a clean build of outputs before performing a build.
ResponseFileEncoding	Overridable property specifying the encoding of the response file, UTF8 by default (Inherited from ToolTask)
SolutionFile	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the full path to the solution file when building solutions, which is used to resolve solution-related Visual C++ project macros.
StandardErrorEncoding	Overridable property specifying the encoding of the captured task standard error stream (Inherited from ToolTask)
StandardErrorImportance	Task Parameter: Importance with which to log text from the standard error stream. (Inherited from ToolTask)
StandardErrorLoggingImportance	Importance with which to log text from the standard error stream. (Inherited from ToolTask)
StandardOutputEncoding	Overridable property specifying the encoding of the captured task standard output stream (Inherited from ToolTask)
StandardOutputImportance	Task Parameter: Importance with which to log text from the standard out stream. (Inherited from ToolTask)
StandardOutputLoggingImportance	Importance with which to log text from in the standard out stream. (Inherited from ToolTask)
TaskResources	Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings. (Inherited from Task)
Timeout	Project visible property that allows the user to specify an amount of time after which the task executable is terminated. (Inherited from ToolTask)
ToolExe	Projects may set this to override a task's ToolName. Tasks may override this to prevent that. (Inherited from ToolTask)
ToolName	This API supports the product infrastructure and is not intended to be used directly from your code. Gets the name of the VCBuild tool (vcbuild.exe).
ToolPath	Project-visible property allows the user to override the path to the executable. (Inherited from ToolTask)
UseEnvironment	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value that indicates whether to use environment variables for INCLUDE and LIB paths.
UserEnvironment	This API supports the product infrastructure and is not intended to be used directly from your code. This property is obsolete.

Methods

AddCommandLineCommands(CommandLineBuilderExtension)	This API supports the product infrastructure and is not intended to be used directly from your code. Generates command-line arguments that the VCBuild tool must run directly from the command line and not from a response file.
AddResponseFileCommands(CommandLineBuilderExtension)	This API supports the product infrastructure and is not intended to be used directly from your code. Fills the provided CommandLineBuilderExtension with those switches and other information that can go into a response file. (Inherited from ToolTaskExtension)
CallHostObjectToExecute()	We expect the tasks to override this method, if they support host objects. The implementation should call into the host object to perform the real work of the task. For example, for compiler tasks like Csc and Vbc, this method would call Compile() on the host object. (Inherited from ToolTask)
DeleteTempFile(String)	Delete temporary file. If the delete fails for some reason (e.g. file locked by anti-virus) then the call will not throw an exception. Instead a warning will be logged, but the build will not fail. (Inherited from ToolTask)
Execute()	This API supports the product infrastructure and is not intended to be used directly from your code. Executes the `VCBuild` task.
ExecuteTool(String, String, String)	Writes out a temporary response file and shell-executes the tool requested. Enables concurrent logging of the output of the tool. (Inherited from ToolTask)
GenerateCommandLineCommands()	This API supports the product infrastructure and is not intended to be used directly from your code. Returns a string with those switches and other information that can't go into a response file and must go directly onto the command line. Called after ValidateParameters and SkipTaskExecution (Inherited from ToolTaskExtension)
GenerateFullPathToTool()	This API supports the product infrastructure and is not intended to be used directly from your code. Returns the full file path of the VCBuild tool (vcbuild.exe).
GenerateResponseFileCommands()	This API supports the product infrastructure and is not intended to be used directly from your code. Returns the command line switch used by the tool executable to specify the response file Will only be called if the task returned a non empty string from GetResponseFileCommands Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands (Inherited from ToolTaskExtension)
GetBoolParameterWithDefault(String, Boolean)	This API supports the product infrastructure and is not intended to be used directly from your code. Get a bool parameter and return a default if its not present in the hash table. (Inherited from ToolTaskExtension)
GetIntParameterWithDefault(String, Int32)	This API supports the product infrastructure and is not intended to be used directly from your code. Get an int parameter and return a default if its not present in the hash table. (Inherited from ToolTaskExtension)
GetResponseFileSwitch(String)	Returns the command line switch used by the tool executable to specify the response file. Will only be called if the task returned a non empty string from GetResponseFileCommands Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands (Inherited from ToolTask)
GetWorkingDirectory()	Gets the working directory to use for the process. Should return null if ToolTask should use the current directory. (Inherited from ToolTask)
HandleTaskExecutionErrors()	Allows tool to handle the return code. This method will only be called with non-zero exitCode. (Inherited from ToolTask)
InitializeHostObject()	We expect tasks to override this method if they support host objects. The implementation should make sure that the host object is ready to perform the real work of the task. (Inherited from ToolTask)
LogEventsFromTextOutput(String, MessageImportance)	Calls a method on the TaskLoggingHelper to parse a single line of text to see if there are any errors or warnings in canonical format. This can be overridden by the derived class if necessary. (Inherited from ToolTask)
LogPathToTool(String, String)	Logs the tool name and the path from where it is being run. (Inherited from ToolTask)
LogToolCommand(String)	Logs the actual command line about to be executed (or what the task wants the log to show) (Inherited from ToolTask)
SkipTaskExecution()	Returns true if task execution is not necessary. Executed after ValidateParameters (Inherited from ToolTask)
ValidateParameters()	This API supports the product infrastructure and is not intended to be used directly from your code. Validates input parameters and logs errors or warnings, if any. Returns a value that indicates whether task execution should proceed.

Applies to

Compartir a través de