Export (0) Print
Expand All

AL Class

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

Implements the AL task. Use the AL element in your project file to create and execute this task. For usage and parameter information, see AL (Assembly Linker) Task.

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

public class AL : ToolTaskExtension

The AL type exposes the following members.

  NameDescription
Public methodALInfrastructure. Initializes a new instance of the AL class.
Top

  NameDescription
Public propertyAlgorithmIdInfrastructure. Gets or sets an algorithm to hash all files in a multifile assembly except the file that contains the assembly manifest.
Protected propertyBagInfrastructure. Gets the collection of parameters used by the derived task class. (Inherited from ToolTaskExtension.)
Public propertyBaseAddressInfrastructure. Gets or sets the address at which a DLL will be loaded on the user’s computer at run time.
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 propertyCompanyNameInfrastructure. Gets or sets the Company field in the assembly.
Public propertyConfigurationInfrastructure. Gets or sets the Configuration field in the assembly.
Public propertyCopyrightInfrastructure. Gets or sets the Copyright field in the assembly.
Public propertyCultureInfrastructure. Gets or sets the culture string to associate with the assembly.
Public propertyDelaySignInfrastructure. Gets or sets a Boolean value that indicates whether to place only the public key in the assembly (true) or to fully sign the assembly (false).
Public propertyDescriptionInfrastructure. Gets or sets the Description field in the assembly.
Public propertyEchoOffIndicates that command line echoing is turned off. (Inherited from ToolTask.)
Public propertyEmbedResourcesInfrastructure. Gets or sets the resources to embed in the image that contains the assembly manifest.
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 propertyEvidenceFileInfrastructure. Gets or sets the file to embed in the assembly with the resource name of Security.Evidence.
Public propertyExitCodeGets the returned exit code of the executable file. (Inherited from ToolTask.)
Public propertyFileVersionInfrastructure. Gets or sets the File Version field in the assembly.
Public propertyFlagsInfrastructure. Gets or sets the Flags field in the assembly.
Public propertyGenerateFullPathsInfrastructure. Gets or sets a Boolean value that indicates whether to cause the task to use the absolute path for any files that are reported in an error message.
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 propertyHostObjectGets or sets the host object associated with the task. (Inherited from Task.)
Public propertyKeyContainerInfrastructure. Gets or sets a container that holds a key pair.
Public propertyKeyFileInfrastructure. Gets or sets a file that contains a key pair or just a public key to sign an assembly.
Public propertyLinkResourcesInfrastructure. Gets or sets the resource files to link to an assembly.
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 fully qualified name (class.method) of the method to use as an entry point when converting a module to an executable file.
Public propertyOutputAssemblyInfrastructure. Gets or sets the name of the file generated by this task.
Public propertyPlatformInfrastructure. Gets or sets a string that limits which platform this code can run on; must be one of x86, Itanium, x64, or anycpu.
Public propertyPrefer32BitGets or sets a flag indicating whether the task runs on a 32 bit platform.
Public propertyProductNameInfrastructure. Gets or sets the Product field in the assembly.
Public propertyProductVersionInfrastructure. Gets or sets the ProductVersion field in the assembly.
Protected propertyResponseFileEncodingGets the Encoding of the response file. (Inherited from ToolTask.)
Public propertyResponseFilesGets or sets the names of the response files that contain commands for the AL tool.
Public propertySdkToolsPathGets or sets the path to the SDK tools.
Public propertySourceModulesInfrastructure. Gets or sets the modules to be compiled into an assembly.
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 propertyStandardOutputEncodingGets the Encoding of the standard output stream of the task. (Inherited from ToolTask.)
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 propertyTargetTypeInfrastructure. Gets or sets the file format of the output file: library (code library), exe (console application), or win (Windows-based application).
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 propertyTemplateFileInfrastructure. Gets or sets the assembly from which to inherit all assembly metadata, except the culture field.
Public propertyTimeoutGets or sets the amount of time after which the task executable is terminated. (Inherited from ToolTask.)
Public propertyTitleInfrastructure. Gets or sets the Title field in the assembly.
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 tool (Al.exe). (Overrides ToolTask.ToolName.)
Public propertyToolPathGets or sets the path of the executable file to run. (Inherited from ToolTask.)
Public propertyTrademarkInfrastructure. Gets or sets the Trademark field in the assembly.
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.)
Public propertyVersionInfrastructure. Gets or sets the version information for this assembly.
Public propertyWin32IconInfrastructure. Gets or sets the .ico file to insert in the assembly.
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. Fills the specified CommandLineBuilderExtension with the switches and other information that the command line tool must run from the command line and not from a response file. (Inherited from ToolTaskExtension.)
Protected methodAddResponseFileCommandsInfrastructure. Fills the specified commandLine parameter with 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 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 methodExecuteInfrastructure. Executes the AL task. (Overrides ToolTask.Execute().)
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 methodGenerateFullPathToToolInfrastructure. Returns the full file path to the AL tool. (Overrides ToolTask.GenerateFullPathToTool().)
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 methodHandleTaskExecutionErrorsHandles execution errors raised by the executable file. (Inherited from ToolTask.)
Protected methodInitializeHostObjectInitializes the host object of the task. (Inherited from ToolTask.)
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 methodValidateParametersIndicates whether all task paratmeters are valid. (Inherited from ToolTask.)
Top

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft