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) 取得其參考。