MetadataReference.CreateFromFile メソッド

定義

ファイルに格納されているアセンブリまたはスタンドアロン モジュールへの参照を作成します。 ファイルの内容をメモリに読み取ります。

public static Microsoft.CodeAnalysis.PortableExecutableReference CreateFromFile (string path, Microsoft.CodeAnalysis.MetadataReferenceProperties properties = default, Microsoft.CodeAnalysis.DocumentationProvider documentation = default);
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

参照プロパティ (extern エイリアス、型埋め込み、 MetadataImageKind)。

documentation
DocumentationProvider

リファレンスにあるシンボルの XML ドキュメントを提供します。

戻り値

例外

path が null です。

path が無効です。

ファイルの読み取り中にエラーが発生しました。

注釈

パフォーマンスに関する考慮事項:

同じファイルへの複数の参照を作成する場合は、API をCreateFromFile(String)使用CreateFromFile(String)することをお勧めします。 オブジェクトを再利用すると Metadata 、これらの参照間でデータを共有できます。

このメソッドは、ファイルの内容全体をネイティブ ヒープに熱心に読み取ります。 生成された参照が到達不能になり、GC によって収集されると、ネイティブ メモリ ブロックが解放されます。 参照のメモリ フットプリントを減らすか、メタデータ オブジェクトGetReference(DocumentationProvider, ImmutableArray<String>, Boolean, String, String)を作成IDisposableし、そのオブジェクトへの参照を取得するために使用CreateFromFile(String)する有効期間を決定論的に管理します。

適用対象