MetadataReference.CreateFromImage Método

Definição

Namespace:

Microsoft.CodeAnalysis

Assembly:

Microsoft.CodeAnalysis.dll

Pacote:

Microsoft.CodeAnalysis.Common v4.12.0

Sobrecargas

CreateFromImage(IEnumerable<Byte>, MetadataReferenceProperties, DocumentationProvider, String)	Cria uma referência a um assembly de módulo único ou a um módulo autônomo armazenado na memória.
CreateFromImage(ImmutableArray<Byte>, MetadataReferenceProperties, DocumentationProvider, String)	Cria uma referência a um assembly de módulo único ou a um módulo autônomo armazenado na memória.

CreateFromImage(IEnumerable<Byte>, MetadataReferenceProperties, DocumentationProvider, String)

Origem:

MetadataReference.cs

Cria uma referência a um assembly de módulo único ou a um módulo autônomo armazenado na memória.

public static Microsoft.CodeAnalysis.PortableExecutableReference CreateFromImage (System.Collections.Generic.IEnumerable<byte> peImage, Microsoft.CodeAnalysis.MetadataReferenceProperties properties = default, Microsoft.CodeAnalysis.DocumentationProvider? documentation = default, string? filePath = default);

static member CreateFromImage : seq<byte> * Microsoft.CodeAnalysis.MetadataReferenceProperties * Microsoft.CodeAnalysis.DocumentationProvider * string -> Microsoft.CodeAnalysis.PortableExecutableReference

Public Shared Function CreateFromImage (peImage As IEnumerable(Of Byte), Optional properties As MetadataReferenceProperties = Nothing, Optional documentation As DocumentationProvider = Nothing, Optional filePath As String = Nothing) As PortableExecutableReference

Parâmetros

peImage

IEnumerable<Byte>

Imagem do assembly.

properties

MetadataReferenceProperties

Propriedades de referência (aliases extern, inserção de tipo, MetadataImageKind).

documentation

DocumentationProvider

Fornece documentação XML para o símbolo encontrado na referência.

filePath

String

Caminho opcional que descreve o local dos metadados. O arquivo não precisa existir no disco. O caminho é opaco para o compilador.

Retornos

PortableExecutableReference

Exceções

ArgumentNullException

peImage é nulo.

Comentários

Considerações sobre desempenho:

É recomendável usar CreateFromImage(IEnumerable<Byte>) ou CreateFromImage(IEnumerable<Byte>) API ao criar várias referências aos mesmos metadados. Reutilizá-lo Metadata para criar várias referências permite o compartilhamento de dados entre essas referências.

O método faz uma cópia dos dados e os fixa. Para evitar que uma cópia use uma sobrecarga que leve um ImmutableArray<T>. A memória fixada é liberada quando a referência resultante se torna inacessível e o GC a coleta. Para controlar o tempo de vida da memória fixada, use CreateFromStream(Stream, PEStreamOptions) deterministicamente para criar um IDisposable objeto de metadados e GetReference(DocumentationProvider, ImmutableArray<String>, Boolean, String, String) para obter uma referência a ele.

CreateFromImage(ImmutableArray<Byte>, MetadataReferenceProperties, DocumentationProvider, String)

Origem:

MetadataReference.cs

Cria uma referência a um assembly de módulo único ou a um módulo autônomo armazenado na memória.

public static Microsoft.CodeAnalysis.PortableExecutableReference CreateFromImage (System.Collections.Immutable.ImmutableArray<byte> peImage, Microsoft.CodeAnalysis.MetadataReferenceProperties properties = default, Microsoft.CodeAnalysis.DocumentationProvider? documentation = default, string? filePath = default);

static member CreateFromImage : System.Collections.Immutable.ImmutableArray<byte> * Microsoft.CodeAnalysis.MetadataReferenceProperties * Microsoft.CodeAnalysis.DocumentationProvider * string -> Microsoft.CodeAnalysis.PortableExecutableReference

Public Shared Function CreateFromImage (peImage As ImmutableArray(Of Byte), Optional properties As MetadataReferenceProperties = Nothing, Optional documentation As DocumentationProvider = Nothing, Optional filePath As String = Nothing) As PortableExecutableReference

Parâmetros

peImage

ImmutableArray<Byte>

Imagem do assembly.

properties

MetadataReferenceProperties

Propriedades de referência (aliases extern, inserção de tipo, MetadataImageKind).

documentation

DocumentationProvider

Fornece documentação XML para o símbolo encontrado na referência.

filePath

String

Caminho opcional que descreve o local dos metadados. O arquivo não precisa existir no disco. O caminho é opaco para o compilador.

Retornos

PortableExecutableReference

Exceções

ArgumentNullException

peImage é nulo.

Comentários

Considerações sobre desempenho:

É recomendável usar CreateFromImage(ImmutableArray<Byte>) ou CreateFromImage(ImmutableArray<Byte>) API ao criar várias referências aos mesmos metadados. Reutilizá-lo Metadata para criar várias referências permite o compartilhamento de dados entre essas referências.

O método fixa peImage no heap gerenciado. A memória fixada é liberada quando a referência resultante se torna inacessível e o GC a coleta. Para controlar o tempo de vida da memória fixada, use CreateFromImage(ImmutableArray<Byte>) deterministicamente para criar um IDisposable objeto de metadados e GetReference(DocumentationProvider, ImmutableArray<String>, Boolean, String, String) para obter uma referência a ele.

O método cria uma referência a um assembly de módulo único. Para criar uma referência a um assembly de vários módulos ou a um módulo autônomo, use CreateFromImage(ImmutableArray<Byte>) e GetReference(DocumentationProvider, String, String).