MetadataReference.CreateFromFile 方法

定义

命名空间:

Microsoft.CodeAnalysis

程序集:

Microsoft.CodeAnalysis.dll

包:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

MetadataReference.cs

创建对存储在文件中的程序集或独立模块的引用。 将文件的内容读取到内存中。

public static Microsoft.CodeAnalysis.PortableExecutableReference CreateFromFile (string path, Microsoft.CodeAnalysis.MetadataReferenceProperties properties = default, Microsoft.CodeAnalysis.DocumentationProvider? documentation = default);

static member CreateFromFile : string * Microsoft.CodeAnalysis.MetadataReferenceProperties * Microsoft.CodeAnalysis.DocumentationProvider -> Microsoft.CodeAnalysis.PortableExecutableReference

Public Shared Function CreateFromFile (path As String, Optional properties As MetadataReferenceProperties = Nothing, Optional documentation As DocumentationProvider = Nothing) As PortableExecutableReference

参数

path

String

程序集文件的路径。

properties

MetadataReferenceProperties

引用属性 (外部别名、类型嵌入、 MetadataImageKind) 。

documentation

DocumentationProvider

为在引用中找到的符号提供 XML 文档。

返回

PortableExecutableReference

例外

ArgumentNullException

path 为 null。

ArgumentException

path 无效。

IOException

读取文件时出错。

注解

性能注意事项：

建议在创建对同一文件的多个引用时使用 CreateFromFile(String) 或 CreateFromFile(String) API。 Metadata重用对象允许跨这些引用共享数据。

该方法将文件的整个内容急切地读取到本机堆中。 当生成的引用无法访问并且 GC 收集它时，将释放本机内存块。 若要减少引用的内存占用，/或管理生存期确定性地用于 CreateFromFile(String) 创建 IDisposable 元数据对象并 GetReference(DocumentationProvider, ImmutableArray<String>, Boolean, String, String) 获取对它的引用。