Vbc Class

Definition

Namespace:

Microsoft.Build.Tasks

Assembly:

Microsoft.Build.Tasks.v4.0.dll

Implements the Vbc task. Use the Vbc element in your project file to create and execute this task. For usage and parameter information, see Vbc Task.

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

public ref class Vbc : Microsoft::Build::Tasks::ManagedCompiler

public class Vbc : Microsoft.Build.Tasks.ManagedCompiler

type Vbc = class
    inherit ManagedCompiler

Public Class Vbc
Inherits ManagedCompiler

Inheritance

Object

Task

ToolTask

ToolTaskExtension

ManagedCompiler

Vbc

Constructors

Vbc()

This API supports the product infrastructure and is not intended to be used directly from your code. Initializes a new instance of the Vbc class.

Properties

AdditionalLibPaths	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the additional folders in which to look for assemblies. (Inherited from ManagedCompiler)
AddModules	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the modules for the compiler to make available to the project you are currently compiling. (Inherited from ManagedCompiler)
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)
BaseAddress	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the base address of the DLL.
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)
BuildEngine3	Retrieves the IBuildEngine3 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine4	Retrieves the IBuildEngine4 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine5	Retrieves the IBuildEngine5 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine6	Retrieves the IBuildEngine6 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine7	Retrieves the IBuildEngine7 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine8	Retrieves the IBuildEngine8 version of the build engine interface provided by the host. (Inherited from Task)
BuildEngine9	Retrieves the IBuildEngine9 version of the build engine interface provided by the host. (Inherited from Task)
canBeIncremental	ToolTask is not incremental by default. When a derived class overrides SkipTaskExecution, then Question feature can take into effect. (Inherited from ToolTask)
CodePage	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the code page to use for all source code files in the compilation. (Inherited from ManagedCompiler)
DebugType	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the debug type. (Inherited from ManagedCompiler)
DefineConstants	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the conditional compiler constants. (Inherited from ManagedCompiler)
DelaySign	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether the public key is placed in the assembly. (Inherited from ManagedCompiler)
DisabledWarnings	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets one or more warnings to suppress that are specified by the numeric part of the warning identifier.
DocumentationFile	This API supports the product infrastructure and is not intended to be used directly from your code. Turns on documentation comments processing and gets or sets the output documentation XML file.
EchoOff	When set to true, it passes /Q to the cmd.exe command line such that the command line does not get echo-ed on stdout (Inherited from ToolTask)
EmitDebugInformation	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether the compiler generates debugging information. (Inherited from ManagedCompiler)
EnvironmentOverride	Obsolete. Gets the Path override value. (Inherited from ToolTask)
EnvironmentVariables	Array of equals-separated pairs of environment variables that should be passed to the spawned executable, in addition to (or selectively overriding) the regular environment block. (Inherited from ToolTask)
ErrorReport	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a string value that specifies how the task will report internal compiler errors.
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)
FailIfNotIncremental	(Inherited from ToolTask)
FileAlignment	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating where to align the sections of the output file. (Inherited from ManagedCompiler)
GenerateDocumentation	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether to process documentation comments to an XML file.
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)
HighEntropyVA	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the HighEntropyVA attribute. (Inherited from ManagedCompiler)
HostCompilerSupportsAllParameters	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether the host compiler supports all task parameters. (Inherited from ManagedCompiler)
HostObject	The build engine sets this property if the host IDE has associated a host object with this particular task. (Inherited from Task)
Imports	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the item collections to import namespaces from.
KeyContainer	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the cryptographic key container. (Inherited from ManagedCompiler)
KeyFile	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the file name containing the cryptographic key. (Inherited from ManagedCompiler)
LangVersion	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the language version.
LinkResources	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the .NET Framework resource files to link to the output file. (Inherited from ManagedCompiler)
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)
LogStandardErrorAsError	Should ALL messages received on the standard error stream be logged as errors. (Inherited from ToolTask)
MainEntryPoint	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the class or module that contains the main entry point. (Inherited from ManagedCompiler)
ModuleAssemblyName	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the assembly that this module will be a part of.
NoConfig	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether the compiler should use the default response file. (Inherited from ManagedCompiler)
NoLogo	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether to suppress the compiler banner information. (Inherited from ManagedCompiler)
NoStandardLib	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether the compiler should not reference the standard libraries.
NoVBRuntimeReference	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether the compiler should compile without a reference to the Visual Basic Runtime Library.
NoWarnings	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether the task will suppress all warnings.
NoWin32Manifest	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether an external UAC manifest is generated for the application. (Inherited from ManagedCompiler)
Optimize	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether to enable compiler optimizations. (Inherited from ManagedCompiler)
OptionCompare	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a string value that specifies how string comparisons are made.
OptionExplicit	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether explicit declaration of variables is required.
OptionInfer	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether to use local type inference in variable declarations.
OptionStrict	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether the task enforces strict type semantics to restrict implicit type conversions.
OptionStrictType	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value for the OptionStrict property. Currently, the value can be set to "custom" and specifies whether the task generates warnings for implicit narrowing type conversions.
OutputAssembly	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the name of the output file. (Inherited from ManagedCompiler)
PdbFile	This API supports the product infrastructure and is not intended to be used directly from your code. The path to the .Pdb file.
Platform	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the Platform attribute. (Inherited from ManagedCompiler)
Prefer32Bit	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the Prefer32Bit attribute. (Inherited from ManagedCompiler)
References	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the items from which the compiler will import public type information. (Inherited from ManagedCompiler)
RemoveIntegerChecks	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether to disable integer overflow error checks.
Resources	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the .NET Framework resources to embed in the output file. (Inherited from ManagedCompiler)
ResponseFileEncoding	Overridable property specifying the encoding of the response file, UTF8 by default (Inherited from ToolTask)
ResponseFiles	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the response files that contain commands for the task. (Inherited from ManagedCompiler)
RootNamespace	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the root namespace for all type declarations.
SdkPath	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the location of mscorlib.dll and microsoft.visualbasic.dll.
Sources	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the source files to compile. (Inherited from ManagedCompiler)
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)
StandardErrorImportanceToUse	The actual importance at which standard error messages will be logged. (Inherited from ToolTask)
StandardErrorLoggingImportance	Importance with which to log text from the standard error stream. (Inherited from ToolTask)
StandardOutputEncoding	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the encoding of the captured task standard output stream. (Inherited from ManagedCompiler)
StandardOutputImportance	Task Parameter: Importance with which to log text from the standard out stream. (Inherited from ToolTask)
StandardOutputImportanceToUse	The actual importance at which standard out messages will be logged. (Inherited from ToolTask)
StandardOutputLoggingImportance	Importance with which to log text from in the standard out stream. (Inherited from ToolTask)
SubsystemVersion	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the SubsystemVersion attribute value. (Inherited from ManagedCompiler)
TargetCompactFramework	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether to target the .NET Compact Framework.
TargetType	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the file format of the output file. (Inherited from ManagedCompiler)
TaskProcessTerminationTimeout	A timeout to wait for a task to terminate before killing it. In milliseconds. (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)
ToolCanceled	Used to signal when a tool has been cancelled. (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 tool executable file (vbc.exe).
ToolPath	Project-visible property allows the user to override the path to the executable. (Inherited from ToolTask)
TreatWarningsAsErrors	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether warnings are treated as errors. (Inherited from ManagedCompiler)
UseCommandProcessor	When set to true, the tool task will create a batch file for the command-line and execute that using the command-processor, rather than executing the command directly. (Inherited from ToolTask)
UsedCommandLineTool	This API supports the product infrastructure and is not intended to be used directly from your code. Whether the command line compiler was invoked, instead of the host object compiler. (Inherited from ManagedCompiler)
UseHostCompilerIfAvailable	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Boolean value that specifies whether to use the in-process compiler object, if available. Used only by Visual Studio.
UseNewLineSeparatorInResponseFile	When set to true, the response file will use new lines instead of spaces to separate arguments. (Inherited from ToolTaskExtension)
UseUtf8Encoding	Whether or not to use UTF8 encoding for the cmd file and console window. Values: Always, Never, Detect If set to Detect, the current code page will be used unless it cannot represent the Command string. In that case, UTF-8 is used. (Inherited from ToolTask)
Utf8Output	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a value indicating whether compiler output is logged using UTF-8 encoding. (Inherited from ManagedCompiler)
VBRuntime	This API supports the product infrastructure and is not intended to be used directly from your code. Specifies whether to compile with the default Visual Basic runtime.
VBRuntimePath	This API supports the product infrastructure and is not intended to be used directly from your code. The path to the Visual Basic runtime to use.
Verbosity	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the verbosity of the compiler's output, which can be Quiet, Normal, or Verbose.
WarningsAsErrors	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a list of warnings to treat as errors.
WarningsNotAsErrors	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a list of warnings that are not treated as errors.
Win32Icon	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the icon file name. (Inherited from ManagedCompiler)
Win32Manifest	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the Win32 manifest. (Inherited from ManagedCompiler)
Win32Resource	This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets a Win32 resource (.res) file to insert in the output file. (Inherited from ManagedCompiler)
YieldDuringToolExecution	When set to true, this task will yield the node when its task is executing. (Inherited from ToolTask)

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 command line tool must run directly from the command line and not from a response file. (Inherited from ManagedCompiler)
AddResponseFileCommands(CommandLineBuilderExtension)	This API supports the product infrastructure and is not intended to be used directly from your code. Fills the specified commandLine parameter with switches and other information that can go into a response file.
AdjustCommandsForOperatingSystem(String)	Replace backslashes with OS-specific path separators, except when likely that the backslash is intentional. (Inherited from ToolTask)
CallHostObjectToExecute()	This API supports the product infrastructure and is not intended to be used directly from your code. Compiles the project through the host object.
Cancel()	Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination. (Inherited from ToolTask)
CheckAllReferencesExistOnDisk()	This API supports the product infrastructure and is not intended to be used directly from your code. Verifies that all specified references exist on disk. (Inherited from ManagedCompiler)
CheckHostObjectSupport(String, Boolean)	This API supports the product infrastructure and is not intended to be used directly from your code. Logs a message if the specified parameter is not supported by the host compiler. (Inherited from ManagedCompiler)
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. Override Execute so that we can move the PDB file, if we need to, after the compiler is done.
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 tool.
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)
GetProcessStartInfo(String, String, String)	Initializes the information required to spawn the process executing the tool. (Inherited from ToolTask)
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()	This API supports the product infrastructure and is not intended to be used directly from your code. Handles the return code from the compiler. (Inherited from ManagedCompiler)
InitializeHostObject()	This API supports the product infrastructure and is not intended to be used directly from your code. Returns a host object initialization status value that indicates what the next action should be.
ListHasNoDuplicateItems(ITaskItem[], String)	This API supports the product infrastructure and is not intended to be used directly from your code. Determines if any duplicate items exist in the specified task parameter. (Inherited from ManagedCompiler)
LogEventsFromTextOutput(String, MessageImportance)	This API supports the product infrastructure and is not intended to be used directly from your code. This method intercepts the lines to be logged coming from STDOUT from VBC.
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)
ProcessStarted()	Overridable function called after Start() in ExecuteTool(String, String, String) (Inherited from ToolTask)
ReceiveExitNotification(Object, EventArgs)	Signals when the tool exits. The Process object executing the tool calls this method when the tool exits. (Inherited from ToolTask)
ReceiveStandardErrorData(Object, DataReceivedEventArgs)	Queues up the output from the stderr stream of the process executing the tool, and signals the availability of the data. The Process object executing the tool calls this method for every line of text that the tool writes to stderr. (Inherited from ToolTask)
ReceiveStandardOutputData(Object, DataReceivedEventArgs)	Queues up the output from the stdout stream of the process executing the tool, and signals the availability of the data. The Process object executing the tool calls this method for every line of text that the tool writes to stdout. (Inherited from ToolTask)
ResponseFileEscape(String)	Overridable method to escape content of the response file (Inherited from ToolTask)
SkipTaskExecution()	Returns true if task execution is not necessary. Executed after ValidateParameters (Inherited from ToolTask)
StartToolProcess(Process)	We expect tasks to override this method if they need information about the tool process or its process events during task execution. Implementation should make sure that the task is started in this method. Starts the process during task execution. (Inherited from ToolTask)
UseAlternateCommandLineToolToExecute()	This API supports the product infrastructure and is not intended to be used directly from your code. If an alternate tool name or tool path was specified in the project file, then that tool is used rather than the host compiler for integrated development environment (IDE) builds. (Inherited from ManagedCompiler)
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 Boolean value that indicates whether task execution should proceed.