ManagedCompiler Class

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

Defines the properties and methods common to managed compiler tasks.

Namespace:  Microsoft.Build.Tasks
Assembly:  Microsoft.Build.Tasks.v4.0 (in Microsoft.Build.Tasks.v4.0.dll)

[StrongNameIdentityPermissionAttribute(SecurityAction.InheritanceDemand, PublicKey = "002400000480000094000000060200000024000052534131000400000100010007d1fa57c4aed9f0a32e84aa0faefd0de9e8fd6aec8f87fb03766c834c99921eb23be79ad9d5dcc1dd9ad236132102900b723cf980957fc4e177108fc607774f29e8320e92ea05ece4e821c0a5efe8f1645c4c0c93c1ab99285d622caa652c1dfad63d745d6f2de5f17e5eaf0fc4963d261c8a12436518206dc093344d5ad293")]
public abstract class ManagedCompiler : ToolTaskExtension

The ManagedCompiler type exposes the following members.

  NameDescription
Protected methodManagedCompilerInfrastructure. Initializes a new instance of the ManagedCompiler class.
Top

  NameDescription
Public propertyAdditionalLibPathsInfrastructure. Gets or sets the additional folders in which to look for assemblies.
Public propertyAddModulesInfrastructure. Gets or sets the modules for the compiler to make available to the project you are currently compiling.
Protected propertyBagInfrastructure. Gets the collection of parameters used by the derived task class. (Inherited from ToolTaskExtension.)
Public propertyBuildEngineGets or sets the instance of the IBuildEngine object used by the task. (Inherited from Task.)
Public propertyBuildEngine2Gets the instance of the IBuildEngine2 object used by the task. (Inherited from Task.)
Public propertyBuildEngine3Gets the instance of the IBuildEngine3 object used by the task. (Inherited from Task.)
Public propertyBuildEngine4Gets the instance of the IBuildEngine4 object used by the task. (Inherited from Task.)
Public propertyCodePageInfrastructure. Gets or sets the code page to use for all source code files in the compilation.
Public propertyDebugTypeInfrastructure. Gets or sets the debug type.
Public propertyDefineConstantsInfrastructure. Gets or sets the conditional compiler constants.
Public propertyDelaySignInfrastructure. Gets or sets a value indicating whether the public key is placed in the assembly.
Public propertyEchoOffIndicates that command line echoing is turned off. (Inherited from ToolTask.)
Public propertyEmitDebugInformationInfrastructure. Gets or sets a value indicating whether the compiler generates debugging information.
Protected propertyEnvironmentOverride 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.)
Public propertyEnvironmentVariablesArray 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.)
Public propertyExitCodeGets the returned exit code of the executable file. (Inherited from ToolTask.)
Public propertyFileAlignmentInfrastructure. Gets or sets a value indicating where to align the sections of the output file.
Protected propertyHasLoggedErrorsInfrastructure. Returns whether this ToolTask has logged any errors. (Inherited from ToolTaskExtension.)
Protected propertyHelpKeywordPrefixGets or sets the prefix used to compose Help keywords from resource names. (Inherited from Task.)
Public propertyHighEntropyVAGets or sets the HighEntropyVA attribute.
Protected propertyHostCompilerSupportsAllParametersInfrastructure. Gets or sets a value indicating wheter the host compilter supports all task parameters.
Public propertyHostObjectGets or sets the host object associated with the task. (Inherited from Task.)
Public propertyKeyContainerInfrastructure. Gets or sets the name of the cryptographic key container.
Public propertyKeyFileInfrastructure. Gets or sets the file name containing the cryptographic key.
Public propertyLinkResourcesInfrastructure. Gets or sets the .NET Framework resource files to link to the output file.
Public propertyLogGets an instance of a TaskLoggingHelperExtension class containing task logging methods. (Inherited from ToolTaskExtension.)
Public propertyLogStandardErrorAsErrorShould ALL messages received on the standard error stream be logged as errors. (Inherited from ToolTask.)
Public propertyMainEntryPointInfrastructure. Gets or sets the class or module that contains the main entry point.
Public propertyNoConfigInfrastructure. Gets or sets a value indicating whether the compiler should use the default response file.
Public propertyNoLogoInfrastructure. Gets or sets a value indicating whether to suppress the compiler banner information.
Public propertyNoWin32ManifestInfrastructure. Gets or sets a Boolean value that specifies whether an external UAC manifest is generated for the application.
Public propertyOptimizeInfrastructure. Gets or sets a value indicating whether to enable compiler optimizations.
Public propertyOutputAssemblyInfrastructure. Gets or sets the name of the output file.
Public propertyPlatformGets or sets the Platform attribute.
Public propertyPrefer32BitGets or sets the Prefer32Bit attribute.
Public propertyReferencesInfrastructure. Gets or sets the items from which the compiler will import public type information.
Public propertyResourcesInfrastructure. Gets or sets the .NET Framework resources to embed in the output file.
Protected propertyResponseFileEncodingGets the Encoding of the response file. (Inherited from ToolTask.)
Public propertyResponseFilesInfrastructure. Gets or sets the response files that contain commands for the task.
Public propertySourcesInfrastructure. Gets or sets the source files to compile.
Protected propertyStandardErrorEncodingGets the Encoding of the standard error stream of the task. (Inherited from ToolTask.)
Public propertyStandardErrorImportanceTask Parameter: Importance with which to log text from the standard error stream. (Inherited from ToolTask.)
Protected propertyStandardErrorImportanceToUseGets the actual importance at which standard error messages will be logged. (Inherited from ToolTask.)
Protected propertyStandardErrorLoggingImportanceGets the MessageImportance with which to log errors. (Inherited from ToolTask.)
Protected propertyStandardOutputEncodingInfrastructure. Gets or sets the encoding of the captured task standard output stream. (Overrides ToolTask.StandardOutputEncoding.)
Public propertyStandardOutputImportanceTask Parameter: Importance with which to log text from the standard out stream. (Inherited from ToolTask.)
Protected propertyStandardOutputImportanceToUseGets the actual importance at which standard out messages will be logged. (Inherited from ToolTask.)
Protected propertyStandardOutputLoggingImportanceGets the MessageImportance with which to log errors. (Inherited from ToolTask.)
Public propertySubsystemVersionGets or sets the SubsystemVersion attribute value.
Public propertyTargetTypeInfrastructure. Gets or sets the file format of the output file.
Protected propertyTaskProcessTerminationTimeoutA timeout to wait for a task to terminate before killing it. In milliseconds. (Inherited from ToolTask.)
Protected propertyTaskResourcesGets or sets the culture-specific resources associated with the task. (Inherited from Task.)
Public propertyTimeoutGets or sets the amount of time after which the task executable is terminated. (Inherited from ToolTask.)
Protected propertyToolCanceledUsed to signal when a tool has been cancelled. (Inherited from ToolTask.)
Public propertyToolExeProjects may set this to override a task's ToolName. Tasks may override this to prevent that. (Inherited from ToolTask.)
Protected propertyToolNameGets the name of the executable file to run. (Inherited from ToolTask.)
Public propertyToolPathGets or sets the path of the executable file to run. (Inherited from ToolTask.)
Public propertyTreatWarningsAsErrorsInfrastructure. Gets or sets a value indicating whether warnings are treated as errors.
Public propertyUseCommandProcessorGets 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.)
Protected propertyUsedCommandLineToolWhether the command line compiler was invoked, instead of the host object compiler.
Public propertyUtf8OutputInfrastructure. Gets or sets a value indicating whether compiler output is logged using UTF-8 encoding.
Public propertyWin32IconInfrastructure. Gets or sets the icon file name.
Public propertyWin32ManifestInfrastructure. Gets or sets the Win32 manifest.
Public propertyWin32ResourceInfrastructure. Gets or sets a Win32 resource (.res) file to insert in the output file.
Public propertyYieldDuringToolExecutionIndicates if the task will yield the node during tool execution. (Inherited from ToolTask.)
Top

  NameDescription
Protected methodAddCommandLineCommandsInfrastructure. Generates command line arguments that the command line tool must run directly from the command line and not from a response file. (Overrides ToolTaskExtension.AddCommandLineCommands(CommandLineBuilderExtension).)
Protected methodAddResponseFileCommandsInfrastructure. Fills the specified commandLine parameter with the switches and other information that can go into a response file. (Overrides ToolTaskExtension.AddResponseFileCommands(CommandLineBuilderExtension).)
Protected methodCallHostObjectToExecuteCalls the host object to perform the work of the task. (Inherited from ToolTask.)
Public methodCancelCancels the process executing the task by asking it to close nicely, then after a short period, forcing termination. (Inherited from ToolTask.)
Protected methodCheckAllReferencesExistOnDiskInfrastructure. Verifies that all specified references exist on disk.
Protected methodCheckHostObjectSupportInfrastructure. Logs a message if the specified parameter is not supported by the host compiler.
Protected methodDeleteTempFileDeletes the specified temporary file. (Inherited from ToolTask.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodExecuteRuns the exectuable file with the specified task parameters. (Inherited from ToolTask.)
Protected methodExecuteToolCreates a temporoary response (.rsp) file and runs the executable file. (Inherited from ToolTask.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGenerateCommandLineCommandsInfrastructure. 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.)
Protected methodGenerateFullPathToToolReturns the fully qualified path to the executable file. (Inherited from ToolTask.)
Protected methodGenerateResponseFileCommandsInfrastructure. Gets the switch used by the command line tool to specify the response file. (Inherited from ToolTaskExtension.)
Protected methodGetBoolParameterWithDefaultInfrastructure. Gets the value of the specified Boolean parameter. (Inherited from ToolTaskExtension.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Protected methodGetIntParameterWithDefaultInfrastructure. Gets the value of the specified integer parameter. (Inherited from ToolTaskExtension.)
Protected methodGetProcessStartInfoInitializes the information required to spawn the process executing the tool. (Inherited from ToolTask.)
Protected methodGetResponseFileSwitchReturns the command line switch used by the executable file to specifiy a response (.rsp) file. (Inherited from ToolTask.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodGetWorkingDirectoryReturns the directory in which to run the executable file. (Inherited from ToolTask.)
Protected methodHandleTaskExecutionErrorsInfrastructure. Handles the return code from the compiler. (Overrides ToolTask.HandleTaskExecutionErrors().)
Protected methodInitializeHostObjectInitializes the host object of the task. (Inherited from ToolTask.)
Protected methodListHasNoDuplicateItemsInfrastructure. Determines if any duplicate items exist in the specified task parameter.
Protected methodLogEventsFromTextOutputParses a single line of text to identify any errors or warnings in canonical format. (Inherited from ToolTask.)
Protected methodLogPathToToolLogs the tool name and path to all registered loggers. (Inherited from ToolTask.)
Protected methodLogToolCommandLogs the starting point of the run to all registered loggers. (Inherited from ToolTask.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodResponseFileEscapeOverridable method to escape the content of the response file. (Inherited from ToolTask.)
Protected methodSkipTaskExecutionIndicates whether task execution should be skipped. (Inherited from ToolTask.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodUseAlternateCommandLineToolToExecuteInfrastructure. 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.
Protected methodValidateParametersInfrastructure. Validates the task parameters. (Overrides ToolTask.ValidateParameters().)
Top

Notes to Inheritors

This class uses the StrongNameIdentityPermissionAttribute attribute and cannot be inherited.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft