AL 类

定义

此类定义了 "AL" XMake 任务,使用 al.exe 可以将模块和资源文件链接到程序集。This class defines the "AL" XMake task, which enables using al.exe to link modules and resource files into assemblies.

此 API 支持产品基础结构,不能在代码中直接使用。

public ref class AL : Microsoft::Build::Tasks::ToolTaskExtension
public class AL : Microsoft.Build.Tasks.ToolTaskExtension
type AL = class
    inherit ToolTaskExtension
Public Class AL
Inherits ToolTaskExtension
继承

构造函数

AL()

此 API 支持产品基础结构,不能在代码中直接使用。

初始化 AL 类的新实例。Initializes a new instance of the AL class.

属性

AlgorithmId

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一种算法来对多文件程序集中的所有文件(包含程序集清单的文件除外)进行哈希处理。Gets or sets an algorithm to hash all files in a multifile assembly except the file that contains the assembly manifest.

Bag

此 API 支持产品基础结构,不能在代码中直接使用。

获取派生任务类所使用参数的集合。Gets the collection of parameters used by the derived task class.

(继承自 ToolTaskExtension)
BaseAddress

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一个地址,运行时将在用户计算机上的此地址加载 DLL。Gets or sets the address at which a DLL will be loaded on the user's computer at run time.

BuildEngine

生成引擎自动设置此属性,以允许任务回调到其中。The build engine automatically sets this property to allow tasks to call back into it.

(继承自 Task)
BuildEngine2

生成引擎自动设置此属性,以允许任务回调到其中。The build engine automatically sets this property to allow tasks to call back into it. 这是一个便捷属性,因此从此类继承的任务作者不必将值从 IBuildEngine 强制转换为 IBuildEngine2。This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(继承自 Task)
BuildEngine3

检索主机提供的生成引擎接口的 IBuildEngine3 版本。Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(继承自 Task)
BuildEngine4

检索主机提供的生成引擎接口的 IBuildEngine4 版本。Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(继承自 Task)
BuildEngine5

检索主机提供的生成引擎接口的 IBuildEngine5 版本。Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(继承自 Task)
BuildEngine6

检索主机提供的生成引擎接口的 IBuildEngine6 版本。Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(继承自 Task)
CompanyName

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 Company 字段。Gets or sets the Company field in the assembly.

Configuration

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 Configuration 字段。Gets or sets the Configuration field in the assembly.

Copyright

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 Copyright 字段。Gets or sets the Copyright field in the assembly.

Culture

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置要与程序集关联的区域性字符串。Gets or sets the culture string to associate with the assembly.

DelaySign

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一个布尔值,该值指示是仅将公钥放在程序集 (true) 中还是对程序集 (false) 进行完全签名。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).

Description

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 Description 字段。Gets or sets the Description field in the assembly.

EchoOff

当设置为 true 时,它将 / Q 传递到 cmd.exe 命令行,这样命令行不会在 stdout 上得到回显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

(继承自 ToolTask)
EmbedResources

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置要在包含程序集清单的映像中嵌入的资源。Gets or sets the resources to embed in the image that contains the assembly manifest.

EnvironmentOverride
已过时。

获取路径替代值。Gets the Path override value.

(继承自 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.

(继承自 ToolTask)
EvidenceFile

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置要在资源名称为 Security.Evidence 的程序集中嵌入的文件。Gets or sets the file to embed in the assembly with the resource name of Security.Evidence.

ExitCode

生成的进程的返回码。The return code of the spawned process. 如果任务记录了任何错误,但进程的退出代码为 0(成功),这设置为 -1。If the task logged any errors, but the process had an exit code of 0 (success), this will be set to -1.

(继承自 ToolTask)
FileVersion

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 File Version 字段。Gets or sets the File Version field in the assembly.

Flags

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 Flags 字段。Gets or sets the Flags field in the assembly.

GenerateFullPaths

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一个布尔值,该值指示是否使任务对错误消息中报告的任何文件都使用绝对路径。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.

HasLoggedErrors

此 API 支持产品基础结构,不能在代码中直接使用。

此 ToolTaskExtension 是否记录了任何错误Whether this ToolTaskExtension has logged any errors

(继承自 ToolTaskExtension)
HelpKeywordPrefix

获取或设置前缀,该前缀用于通过字符串资源名称组成 help 关键字。Gets or sets the prefix used to compose help keywords from string resource names. 如果任务没有与消息关联的 help 关键字,则可以忽略此属性或将其设置为 null。If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. 如果前缀设置为空字符串,则字符串资源名称将逐字用作 help 关键字。If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. 有关如何使用此前缀的示例,请参阅 TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) 方法。For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(继承自 Task)
HostObject

如果主机 IDE 具有与此特定任务关联的主机对象,则生成引擎会设置此属性。The build engine sets this property if the host IDE has associated a host object with this particular task.

(继承自 Task)
KeyContainer

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置保存密钥对的容器。Gets or sets a container that holds a key pair.

KeyFile

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一个文件,该文件包含密钥对或只包含用于对程序集进行签名的公钥。Gets or sets a file that contains a key pair or just a public key to sign an assembly.

LinkResources

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置要链接到程序集的资源文件。Gets or sets the resource files to link to an assembly.

Log

此 API 支持产品基础结构,不能在代码中直接使用。

获取包含任务日志记录方法的 TaskLoggingHelperExtension 类的实例。Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(继承自 ToolTaskExtension)
LogStandardErrorAsError

应将标准错误流上接收的所有消息作为错误记录。Should ALL messages received on the standard error stream be logged as errors.

(继承自 ToolTask)
MainEntryPoint

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置用作将模块转换为可执行文件时的入口点的方法的完全限定名称 (class.method**)。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.

OutputAssembly

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置此任务生成的文件的名称。Gets or sets the name of the file generated by this task.

Platform

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一个字符串,该字符串限制可运行此代码的平台;必需是下面的某一项:x86Itaniumx64anycpuGets or sets a string that limits which platform this code can run on; must be one of x86, Itanium, x64, or anycpu.

Prefer32Bit

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一个值,此值指示任务是否在 32 位平台上运行。Gets or sets a value that indicates whether the task runs on a 32-bit platform.

ProductName

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 Product 字段。Gets or sets the Product field in the assembly.

ProductVersion

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 ProductVersion 字段。Gets or sets the ProductVersion field in the assembly.

ResponseFileEncoding

用于指定响应文件编码的可替代属性,默认为 UTF8Overridable property specifying the encoding of the response file, UTF8 by default

(继承自 ToolTask)
ResponseFiles

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一些响应文件的名称,这些文件含有 AL 工具的命令。Gets or sets the names of the response files that contain commands for the AL tool.

SdkToolsPath

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置 SDK 工具的路径。Gets or sets the path to the SDK tools.

SourceModules

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置要编译到程序集中的模块。Gets or sets the modules to be compiled into an assembly.

StandardErrorEncoding

可重写的属性,用于指定捕获的任务标准错误流的编码值Overridable property specifying the encoding of the captured task standard error stream

(继承自 ToolTask)
StandardErrorImportance

任务参数:用于从标准错误流记录文本的重要性。Task Parameter: Importance with which to log text from the standard error stream.

(继承自 ToolTask)
StandardErrorImportanceToUse

记录标准错误消息时使用的实际重要性。The actual importance at which standard error messages will be logged.

(继承自 ToolTask)
StandardErrorLoggingImportance

用于从标准错误流记录文本的重要性。Importance with which to log text from the standard error stream.

(继承自 ToolTask)
StandardOutputEncoding

可重写的属性,用于指定捕获的任务标准输出流的编码值Overridable property specifying the encoding of the captured task standard output stream

(继承自 ToolTask)
StandardOutputImportance

任务参数:关于记录标准输出流的文本的重要性。Task Parameter: Importance with which to log text from the standard out stream.

(继承自 ToolTask)
StandardOutputImportanceToUse

记录标准输出消息时使用的实际重要性。The actual importance at which standard out messages will be logged.

(继承自 ToolTask)
StandardOutputLoggingImportance

从标准输出流中记录文本时使用的重要性。Importance with which to log text from in the standard out stream.

(继承自 ToolTask)
TargetType

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置输出文件的文件格式:library(代码库)、exe(控制台应用程序)或 win(基于 Windows 的应用程序)。Gets or sets the file format of the output file: library (code library), exe (console application), or win (Windows-based application).

TaskProcessTerminationTimeout

在取消任务之前等待该任务终止所需的超时。A timeout to wait for a task to terminate before killing it. 以毫秒为单位。In milliseconds.

(继承自 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.

(继承自 Task)
TemplateFile

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集,除区域性字段之外的所有程序集元数据都从该程序集继承。Gets or sets the assembly from which to inherit all assembly metadata, except the culture field.

Timeout

项目可见属性,使用户可以指定终止任务可执行文件前留出的时间。Project visible property that allows the user to specify an amount of time after which the task executable is terminated.

(继承自 ToolTask)
Title

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 Title 字段。Gets or sets the Title field in the assembly.

ToolCanceled

用于在已取消某个工具时发出信号。Used to signal when a tool has been cancelled.

(继承自 ToolTask)
ToolExe

项目可以设置此值以重写任务的 ToolName。Projects may set this to override a task's ToolName. 任务可能会重写此内容以避免这种情况。Tasks may override this to prevent that.

(继承自 ToolTask)
ToolName

此 API 支持产品基础结构,不能在代码中直接使用。

返回要执行的工具的名称。Return the name of the tool to execute.

ToolPath

项目可见属性允许用户替代可执行文件的路径。Project-visible property allows the user to override the path to the executable.

(继承自 ToolTask)
Trademark

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置程序集中的 Trademark 字段。Gets or sets the Trademark field in the assembly.

UseCommandProcessor

当设置为 true 时,工具任务将为命令行创建一个批处理文件并使用命令处理器执行该文件,而不是直接执行该命令。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.

(继承自 ToolTask)
UseNewLineSeparatorInResponseFile

当设置为 true 时,响应文件将使用新行分隔参数,而不再使用空格。When set to true, the response file will use new lines instead of spaces to separate arguments.

(继承自 ToolTaskExtension)
Version

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置此程序集的版本信息。Gets or sets the version information for this assembly.

Win32Icon

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置要在程序集中插入的 .ico 文件。Gets or sets the .ico file to insert in the assembly.

Win32Resource

此 API 支持产品基础结构,不能在代码中直接使用。

获取或设置一个要插入到输出文件中的 Win32 资源(.res 文件)。Gets or sets a Win32 resource (.res file) to insert in the output file.

YieldDuringToolExecution

当设置为 true 时,此任务会在其任务执行时生成节点。When set to true, this task will yield the node when its task is executing.

(继承自 ToolTask)

方法

AddCommandLineCommands(CommandLineBuilderExtension)

此 API 支持产品基础结构,不能在代码中直接使用。

使用不能进入响应文件且必须直接转到命令行的开关和其他信息填充所提供的 CommandLineBuilderExtension。Fills the provided CommandLineBuilderExtension with those switches and other information that can't go into a response file and must go directly onto the command line.

(继承自 ToolTaskExtension)
AddResponseFileCommands(CommandLineBuilderExtension)

此 API 支持产品基础结构,不能在代码中直接使用。

使用可以进入响应文件的开关和其他信息填充所提供的 CommandLineBuilderExtension。Fills the provided CommandLineBuilderExtension with those 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.

(继承自 ToolTask)
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. 例如,对于 Csc 和 Vbc 等编译器任务,此方法将在宿主对象上调用 Compile()。For example, for compiler tasks like Csc and Vbc, this method would call Compile() on the host object.

(继承自 ToolTask)
Cancel()

通过以下方式取消正在执行任务的进程:请求该进程正常关闭,在经过短时间的等待之后,强制终止该进程。Cancels the process executing the task by asking it to close nicely, then after a short period, forcing termination.

(继承自 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.

(继承自 ToolTask)
Equals(Object)

确定指定对象是否等于当前对象。Determines whether the specified object is equal to the current object.

(继承自 Object)
Execute()

此 API 支持产品基础结构,不能在代码中直接使用。

执行 AL 任务。Executes the AL task.

ExecuteTool(String, String, String)

写出一个临时响应文件,然后通过 shell 执行请求的工具。Writes out a temporary response file and shell-executes the tool requested. 启用工具输出的并发记录。Enables concurrent logging of the output of the tool.

(继承自 ToolTask)
GenerateCommandLineCommands()

此 API 支持产品基础结构,不能在代码中直接使用。

返回一个字符串,其中包含不能进入响应文件且必须直接转到命令行的开关和其他信息。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. 在 ValidateParameters 和 SkipTaskExecution 之后调用Called after ValidateParameters and SkipTaskExecution

(继承自 ToolTaskExtension)
GenerateFullPathToTool()

此 API 支持产品基础结构,不能在代码中直接使用。

返回要执行的工具的路径Return the path of the tool to execute

GenerateResponseFileCommands()

此 API 支持产品基础结构,不能在代码中直接使用。

返回工具可执行文件使用的命令行开关以指定响应文件,仅在任务从 GetResponseFileCommands 返回非空字符串时调用它,在 ValidateParameters、SkipTaskExecution 和 GetResponseFileCommands 之后调用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

(继承自 ToolTaskExtension)
GetBoolParameterWithDefault(String, Boolean)

此 API 支持产品基础结构,不能在代码中直接使用。

哈希表中不存在值时,则获取一个布尔参数并返回默认值。Get a bool parameter and return a default if its not present in the hash table.

(继承自 ToolTaskExtension)
GetHashCode()

用作默认哈希函数。Serves as the default hash function.

(继承自 Object)
GetIntParameterWithDefault(String, Int32)

此 API 支持产品基础结构,不能在代码中直接使用。

哈希表中不存在值时,则获取一个 int 参数并返回默认值。Get an int parameter and return a default if its not present in the hash table.

(继承自 ToolTaskExtension)
GetProcessStartInfo(String, String, String)

初始化生成执行该工具的进程所需的信息。Initializes the information required to spawn the process executing the tool.

(继承自 ToolTask)
GetResponseFileSwitch(String)

返回工具可执行文件用来指定响应文件的命令行开关。Returns the command line switch used by the tool executable to specify the response file. 将仅在任务从 GetResponseFileCommands 返回非空字符串时调用。在 ValidateParameters、SkipTaskExecution 和 GetResponseFileCommands 之后调用Will only be called if the task returned a non empty string from GetResponseFileCommands Called after ValidateParameters, SkipTaskExecution and GetResponseFileCommands

(继承自 ToolTask)
GetType()

获取当前实例的 TypeGets the Type of the current instance.

(继承自 Object)
GetWorkingDirectory()

获取要用于进程的工作目录。Gets the working directory to use for the process. 如果 ToolTask 应使用当前目录,则返回 null。Should return null if ToolTask should use the current directory.

(继承自 ToolTask)
HandleTaskExecutionErrors()

允许工具处理返回代码。Allows tool to handle the return code. 此方法将仅在 exitCode 为非零的情况下调用。This method will only be called with non-zero exitCode.

(继承自 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.

(继承自 ToolTask)
LogEventsFromTextOutput(String, MessageImportance)

在 TaskLoggingHelper 上调用方法以解析一行文本,以查看是否存在有关规范格式的错误或警告。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.

(继承自 ToolTask)
LogPathToTool(String, String)

记录工具名称和运行路径。Logs the tool name and the path from where it is being run.

(继承自 ToolTask)
LogToolCommand(String)

记录要执行的实际命令行(或任务希望日志显示的内容)Logs the actual command line about to be executed (or what the task wants the log to show)

(继承自 ToolTask)
MemberwiseClone()

创建当前 Object 的浅表副本。Creates a shallow copy of the current Object.

(继承自 Object)
ProcessStarted()

ExecuteTool(String, String, String) 中的 Start() 之后调用的可替代函数Overridable function called after Start() in ExecuteTool(String, String, String)

(继承自 ToolTask)
ResponseFileEscape(String)

用来转义响应文件的可替代方法Overridable method to escape content of the response file

(继承自 ToolTask)
SkipTaskExecution()

如果并非一定要执行任务,则返回 true。Returns true if task execution is not necessary. 在 ValidateParameters 后执行Executed after ValidateParameters

(继承自 ToolTask)
ToString()

返回表示当前对象的字符串。Returns a string that represents the current object.

(继承自 Object)
ValidateParameters()

在派生类中实现Implemented in the derived class

(继承自 ToolTask)

适用于