This documentation is archived and is not being maintained.
Vbc Class
Visual Studio 2010
This API supports the .NET Framework infrastructure and is not intended to be used directly from your code.
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.
Assembly: Microsoft.Build.Tasks.v4.0 (in Microsoft.Build.Tasks.v4.0.dll)
The Vbc type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | AdditionalLibPaths | Infrastructure. Gets or sets the additional folders in which to look for assemblies. (Inherited from ManagedCompiler.) |
![]() | AddModules | Infrastructure. Gets or sets the modules for the compiler to make available to the project you are currently compiling. (Inherited from ManagedCompiler.) |
![]() | Bag | Infrastructure. Gets the collection of parameters used by the derived task class. (Inherited from ToolTaskExtension.) |
![]() | BaseAddress | Infrastructure. Gets or sets the base address of the DLL. |
![]() | BuildEngine | Gets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.) |
![]() | BuildEngine2 | Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.) |
![]() | BuildEngine3 | Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.) |
![]() | CodePage | Infrastructure. Gets or sets the code page to use for all source code files in the compilation. (Inherited from ManagedCompiler.) |
![]() | DebugType | Infrastructure. Gets or sets the debug type. (Inherited from ManagedCompiler.) |
![]() | DefineConstants | Infrastructure. Gets or sets the conditional compiler constants. (Inherited from ManagedCompiler.) |
![]() | DelaySign | Infrastructure. Gets or sets a value indicating whether the public key is placed in the assembly. (Inherited from ManagedCompiler.) |
![]() | DisabledWarnings | Infrastructure. Gets or sets one or more warnings to suppress that are specified by the numeric part of the warning identifier. |
![]() | DocumentationFile | Infrastructure. Turns on documentation comments processing and gets or sets the output documentation XML file. |
![]() | EchoOff | Indicates that command line echoing is turned off. (Inherited from ToolTask.) |
![]() | EmitDebugInformation | Infrastructure. Gets or sets a value indicating whether the compiler generates debugging information. (Inherited from ManagedCompiler.) |
![]() | EnvironmentOverride | Obsolete. Gets a set of environment variable name-value pairs. Designed to be overridden in a custom task class (derived from ToolTask) to return a set of new or altered environment variables to create the execution context of the associated tool. (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 | Infrastructure. Gets or sets a string value that specifies how the task will report internal compiler errors. |
![]() | ExitCode | Gets the returned exit code of the executable file. (Inherited from ToolTask.) |
![]() | FileAlignment | Infrastructure. Gets or sets a value indicating where to align the sections of the output file. (Inherited from ManagedCompiler.) |
![]() | GenerateDocumentation | Infrastructure. Gets or sets a Boolean value that specifies whether to process documentation comments to an XML file. |
![]() | HasLoggedErrors | Infrastructure. Returns whether this ToolTask has logged any errors. (Inherited from ToolTaskExtension.) |
![]() | HelpKeywordPrefix | Gets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.) |
![]() | HostCompilerSupportsAllParameters | Infrastructure. Gets or sets a value indicating wheter the host compilter supports all task parameters. (Inherited from ManagedCompiler.) |
![]() | HostObject | Gets or sets the host object associated with the task. (Inherited from Task.) |
![]() | Imports | Infrastructure. Gets or sets the item collections to import namespaces from. |
![]() | KeyContainer | Infrastructure. Gets or sets the name of the cryptographic key container. (Inherited from ManagedCompiler.) |
![]() | KeyFile | Infrastructure. Gets or sets the file name containing the cryptographic key. (Inherited from ManagedCompiler.) |
![]() | LangVersion | Gets or sets the language version. |
![]() | LinkResources | Infrastructure. Gets or sets the .NET Framework resource files to link to the output file. (Inherited from ManagedCompiler.) |
![]() | Log | 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 | Infrastructure. Gets or sets the class or module that contains the main entry point. (Inherited from ManagedCompiler.) |
![]() | ModuleAssemblyName | Infrastructure. Gets or sets the name of the assembly that this module will be a part of. |
![]() | NoConfig | Infrastructure. Gets or sets a value indicating whether the compiler should use the default response file. (Inherited from ManagedCompiler.) |
![]() | NoLogo | Infrastructure. Gets or sets a value indicating whether to suppress the compiler banner information. (Inherited from ManagedCompiler.) |
![]() | NoStandardLib | Infrastructure. Gets or sets a Boolean value that specifies whether the compiler should not reference the standard libraries. |
![]() | NoVBRuntimeReference | Infrastructure. Gets or sets a Boolean value that specifies whether the compiler should compile without a reference to the Visual Basic Runtime Library. |
![]() | NoWarnings | Infrastructure. Gets or sets a Boolean value that specifies whether the task will suppress all warnings. |
![]() | NoWin32Manifest | Infrastructure. Gets or sets a Boolean value that specifies whether an external UAC manifest is generated for the application. (Inherited from ManagedCompiler.) |
![]() | Optimize | Infrastructure. Gets or sets a value indicating whether to enable compiler optimizations. (Inherited from ManagedCompiler.) |
![]() | OptionCompare | Infrastructure. Gets or sets a string value that specifies how string comparisons are made. |
![]() | OptionExplicit | Infrastructure. Gets or sets a Boolean value that specifies whether explicit declaration of variables is required. |
![]() | OptionInfer | Infrastructure. Gets or sets a Boolean value that specifies whether to use local type inference in variable declarations. |
![]() | OptionStrict | Infrastructure. Gets or sets a Boolean value that specifies whether the task enforces strict type semantics to restrict implicit type conversions. |
![]() | OptionStrictType | Infrastructure. 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 | Infrastructure. Gets or sets the name of the output file. (Inherited from ManagedCompiler.) |
![]() | Platform | Infrastructure. Gets or sets the processor platform to be targeted by the output file. |
![]() | References | Infrastructure. Gets or sets the items from which the compiler will import public type information. (Inherited from ManagedCompiler.) |
![]() | RemoveIntegerChecks | Infrastructure. Gets or sets a Boolean value that specifies whether to disable integer overflow error checks. |
![]() | Resources | Infrastructure. Gets or sets the .NET Framework resources to embed in the output file. (Inherited from ManagedCompiler.) |
![]() | ResponseFileEncoding | Gets the Encoding of the response file. (Inherited from ToolTask.) |
![]() | ResponseFiles | Infrastructure. Gets or sets the response files that contain commands for the task. (Inherited from ManagedCompiler.) |
![]() | RootNamespace | Infrastructure. Gets or sets the root namespace for all type declarations. |
![]() | SdkPath | Infrastructure. Gets or sets the location of mscorlib.dll and microsoft.visualbasic.dll. |
![]() | Sources | Infrastructure. Gets or sets the source files to compile. (Inherited from ManagedCompiler.) |
![]() | StandardErrorEncoding | Gets the Encoding of the standard error stream of the task. (Inherited from ToolTask.) |
![]() | StandardErrorImportance | Task Parameter: Importance with which to log text from the standard error stream. (Inherited from ToolTask.) |
![]() | StandardErrorImportanceToUse | Gets the actual importance at which standard error messages will be logged. (Inherited from ToolTask.) |
![]() | StandardErrorLoggingImportance | Gets the MessageImportance with which to log errors. (Inherited from ToolTask.) |
![]() | StandardOutputEncoding | Infrastructure. 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 | Gets the actual importance at which standard out messages will be logged. (Inherited from ToolTask.) |
![]() | StandardOutputLoggingImportance | Gets the MessageImportance with which to log errors. (Inherited from ToolTask.) |
![]() | TargetCompactFramework | Infrastructure. Gets or sets a Boolean value that specifies whether to target the .NET Compact Framework. |
![]() | TargetType | Infrastructure. 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 culture-specific resources associated with the task. (Inherited from Task.) |
![]() | Timeout | Gets or sets the 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 | Infrastructure. Gets the name of the tool executable file (vbc.exe). (Overrides ToolTask::ToolName.) |
![]() | ToolPath | Gets or sets the path of the executable file to run. (Inherited from ToolTask.) |
![]() | TreatWarningsAsErrors | Infrastructure. Gets or sets a value indicating whether warnings are treated as errors. (Inherited from ManagedCompiler.) |
![]() | UseCommandProcessor | Gets or sets a switch that specifies whether 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 | Whether the command line compiler was invoked, instead of the host object compiler. (Inherited from ManagedCompiler.) |
![]() | UseHostCompilerIfAvailable | Infrastructure. Gets or sets a Boolean value that specifies whether to use the in-process compiler object, if available. Used only by Visual Studio. |
![]() | Utf8Output | Infrastructure. Gets or sets a value indicating whether compiler output is logged using UTF-8 encoding. (Inherited from ManagedCompiler.) |
![]() | Verbosity | Infrastructure. Gets or sets the verbosity of the compiler’s output, which can be Quiet, Normal, or Verbose. |
![]() | WarningsAsErrors | Infrastructure. Gets or sets a list of warnings to treat as errors. |
![]() | WarningsNotAsErrors | Infrastructure. Gets or sets a list of warnings that are not treated as errors. |
![]() | Win32Icon | Infrastructure. Gets or sets the icon file name. (Inherited from ManagedCompiler.) |
![]() | Win32Manifest | Infrastructure. Gets or sets the Win32 manifest. (Inherited from ManagedCompiler.) |
![]() | Win32Resource | Infrastructure. Gets or sets a Win32 resource (.res) file to insert in the output file. (Inherited from ManagedCompiler.) |
![]() | YieldDuringToolExecution | Indicates if the task will yield the node during tool execution. (Inherited from ToolTask.) |
| Name | Description | |
|---|---|---|
![]() | AddCommandLineCommands | Infrastructure. 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 | Infrastructure. Fills the specified commandLine parameter with switches and other information that can go into a response file. (Overrides ManagedCompiler::AddResponseFileCommands(CommandLineBuilderExtension).) |
![]() | CallHostObjectToExecute | Infrastructure. Compiles the project through the host object. (Overrides ToolTask::CallHostObjectToExecute().) |
![]() | Cancel | Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination. (Inherited from ToolTask.) |
![]() | CheckAllReferencesExistOnDisk | Infrastructure. Verifies that all specified references exist on disk. (Inherited from ManagedCompiler.) |
![]() | CheckHostObjectSupport | Infrastructure. Logs a message if the specified parameter is not supported by the host compiler. (Inherited from ManagedCompiler.) |
![]() | DeleteTempFile | Deletes the specified temporary file. (Inherited from ToolTask.) |
![]() | Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Execute | Runs the exectuable file with the specified task parameters. (Inherited from ToolTask.) |
![]() | ExecuteTool | Creates a temporoary response (.rsp) file and runs the executable file. (Inherited from ToolTask.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GenerateCommandLineCommands | Infrastructure. Gets the switches and other information that the command line tool must run directly from the command line and not from a response file. (Inherited from ToolTaskExtension.) |
![]() | GenerateFullPathToTool | Infrastructure. Returns the full file path of the tool. (Overrides ToolTask::GenerateFullPathToTool().) |
![]() | GenerateResponseFileCommands | Infrastructure. Gets the switch used by the command line tool to specify the response file. (Inherited from ToolTaskExtension.) |
![]() | GetBoolParameterWithDefault | Infrastructure. Gets the value of the specified Boolean parameter. (Inherited from ToolTaskExtension.) |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetIntParameterWithDefault | Infrastructure. Gets the value of the specified integer parameter. (Inherited from ToolTaskExtension.) |
![]() | GetProcessStartInfo | Initializes the information required to spawn the process executing the tool. (Inherited from ToolTask.) |
![]() | GetResponseFileSwitch | Returns the command line switch used by the executable file to specifiy a response (.rsp) file. (Inherited from ToolTask.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetWorkingDirectory | Returns the directory in which to run the executable file. (Inherited from ToolTask.) |
![]() | HandleTaskExecutionErrors | Infrastructure. Handles the return code from the compiler. (Inherited from ManagedCompiler.) |
![]() | InitializeHostObject | Infrastructure. Returns a host object initialization status value that indicates what the next action should be. (Overrides ToolTask::InitializeHostObject().) |
![]() | ListHasNoDuplicateItems | Infrastructure. Determines if any duplicate items exist in the specified task parameter. (Inherited from ManagedCompiler.) |
![]() | LogEventsFromTextOutput | This method intercepts the lines to be logged coming from STDOUT from VBC. (Overrides ToolTask::LogEventsFromTextOutput(String, MessageImportance).) |
![]() | LogPathToTool | Logs the tool name and path to all registered loggers. (Inherited from ToolTask.) |
![]() | LogToolCommand | Logs the starting point of the run to all registered loggers. (Inherited from ToolTask.) |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | SkipTaskExecution | Indicates whether task execution should be skipped. (Inherited from ToolTask.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | UseAlternateCommandLineToolToExecute | Infrastructure. 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 | Infrastructure. Validates input parameters and logs errors or warnings, if any. Returns a Boolean value that indicates whether task execution should proceed. (Overrides ManagedCompiler::ValidateParameters().) |
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show:
