System.Reflection.Metadata 10.0.0-preview.1.25080.5

About

This package provides a low-level .NET (ECMA-335) metadata reader and writer. It's geared for performance and is the ideal choice for building higher-level libraries that intend to provide their own object model, such as compilers. The metadata format is defined by the ECMA-335 - Common Language Infrastructure (CLI) specification and its amendments.

The System.Reflection.Metadata library is included in the .NET Runtime shared framework. The package can be installed when you need to use it in other target frameworks.

How to Use

The following example shows how to read assembly information using PEReader and MetadataReader.

using System;
using System.IO;
using System.Reflection.Metadata;
using System.Reflection.PortableExecutable;

class Program
{
    static void Main()
    {
        // Open the Portable Executable (PE) file
        using var fs = new FileStream("Example.dll", FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
        using var peReader = new PEReader(fs);

        // Display PE header information
        PEHeader header = peReader.PEHeaders.PEHeader;
        Console.WriteLine($"Image base:     0x{header.ImageBase:X}");
        Console.WriteLine($"File alignment: 0x{header.FileAlignment:X}");
        Console.WriteLine($"Subsystem:      {header.Subsystem}");

        // Display .NET metadata information
        if (!peReader.HasMetadata)
        {
            Console.WriteLine("Image does not contain .NET metadata");
            return;
        }

        MetadataReader mr = peReader.GetMetadataReader();
        AssemblyDefinition ad = mr.GetAssemblyDefinition();
        Console.WriteLine($"Assembly name:  {ad.GetAssemblyName().ToString()}");
        Console.WriteLine();
        Console.WriteLine("Assembly attributes:");

        foreach (CustomAttributeHandle attrHandle in ad.GetCustomAttributes())
        {
            CustomAttribute attr = mr.GetCustomAttribute(attrHandle);

            // Display the attribute type full name
            if (attr.Constructor.Kind == HandleKind.MethodDefinition)
            {
                MethodDefinition mdef = mr.GetMethodDefinition((MethodDefinitionHandle)attr.Constructor);
                TypeDefinition tdef = mr.GetTypeDefinition(mdef.GetDeclaringType());
                Console.WriteLine($"{mr.GetString(tdef.Namespace)}.{mr.GetString(tdef.Name)}");
            }
            else if (attr.Constructor.Kind == HandleKind.MemberReference)
            {
                MemberReference mref = mr.GetMemberReference((MemberReferenceHandle)attr.Constructor);

                if (mref.Parent.Kind == HandleKind.TypeReference)
                {
                    TypeReference tref = mr.GetTypeReference((TypeReferenceHandle)mref.Parent);
                    Console.WriteLine($"{mr.GetString(tref.Namespace)}.{mr.GetString(tref.Name)}");
                }
                else if (mref.Parent.Kind == HandleKind.TypeDefinition)
                {
                    TypeDefinition tdef = mr.GetTypeDefinition((TypeDefinitionHandle)mref.Parent);
                    Console.WriteLine($"{mr.GetString(tdef.Namespace)}.{mr.GetString(tdef.Name)}");
                }
            }
        }
    }
}

Main Types

The main types provided by this library are:

  • System.Reflection.Metadata.MetadataReader
  • System.Reflection.PortableExecutable.PEReader
  • System.Reflection.Metadata.Ecma335.MetadataBuilder
  • System.Reflection.PortableExecutable.PEBuilder
  • System.Reflection.PortableExecutable.ManagedPEBuilder

Additional Documentation

Feedback & Contributing

System.Reflection.Metadata is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.

Showing the top 20 packages that depend on System.Reflection.Metadata.

Packages Downloads
Hellang.Middleware.ProblemDetails
Error handling middleware, using RFC7807
877
Hellang.Middleware.ProblemDetails
Error handling middleware, using RFC7807
11,492
Hellang.Middleware.ProblemDetails
Error handling middleware, using RFC7807
12,454
Hellang.Middleware.ProblemDetails
Error handling middleware, using RFC7807
21,227
Microsoft.NETCore.App
A set of .NET API's that are included in the default .NET Core application model. 1a165a1588309bd8c34f77e1f926e6dbf6ae30d0 When using NuGet 3.x this package requires at least version 3.4.
105
Microsoft.NETCore.App
A set of .NET API's that are included in the default .NET Core application model. b61e1596d6afb8168ebd9a46d560af4413c6d57f When using NuGet 3.x this package requires at least version 3.4.
100
Microsoft.NETCore.App
A set of .NET API's that are included in the default .NET Core application model. eb9bc9205169e4c00d218d03167a564a7429921f When using NuGet 3.x this package requires at least version 3.4.
90
Microsoft.NETCore.App
A set of .NET API's that are included in the default .NET Core application model. When using NuGet 3.x this package requires at least version 3.4.
89
Microsoft.NETCore.App
A set of .NET API's that are included in the default .NET Core application model. When using NuGet 3.x this package requires at least version 3.4.
94
Microsoft.NETCore.App
A set of .NET API's that are included in the default .NET Core application model. When using NuGet 3.x this package requires at least version 3.4.
96
Microsoft.TestPlatform.ObjectModel
The Microsoft Test Platform Object Model.
462
Microsoft.TestPlatform.ObjectModel
The Microsoft Test Platform Object Model.
1,756
System.Reflection.MetadataLoadContext
Provides read-only reflection on assemblies in an isolated context with support for assemblies that have different architectures and runtimes. Commonly Used Types: System.Reflection.MetadataLoadContext System.Reflection.MetadataAssemblyResolver
90
System.Reflection.MetadataLoadContext
Provides read-only reflection on assemblies in an isolated context with support for assemblies that have different architectures and runtimes. Commonly Used Types: System.Reflection.MetadataLoadContext System.Reflection.MetadataAssemblyResolver
114
System.Reflection.MetadataLoadContext
Provides read-only reflection on assemblies in an isolated context with support for assemblies that have different architectures and runtimes. Commonly Used Types: System.Reflection.MetadataLoadContext System.Reflection.MetadataAssemblyResolver When using NuGet 3.x this package requires at least version 3.4.
94
System.Reflection.MetadataLoadContext
Provides read-only reflection on assemblies in an isolated context with support for assemblies that have different architectures and runtimes. Commonly Used Types: System.Reflection.MetadataLoadContext System.Reflection.MetadataAssemblyResolver When using NuGet 3.x this package requires at least version 3.4.
95
System.Reflection.MetadataLoadContext
Provides read-only reflection on assemblies in an isolated context with support for assemblies that have different architectures and runtimes. Commonly Used Types: System.Reflection.MetadataLoadContext System.Reflection.MetadataAssemblyResolver When using NuGet 3.x this package requires at least version 3.4.
96
System.Reflection.MetadataLoadContext
Provides read-only reflection on assemblies in an isolated context with support for assemblies that have different architectures and runtimes. Commonly Used Types: System.Reflection.MetadataLoadContext System.Reflection.MetadataAssemblyResolver When using NuGet 3.x this package requires at least version 3.4.
112
System.Reflection.MetadataLoadContext
Provides read-only reflection on assemblies in an isolated context with support for assemblies that target different processor architectures and runtimes. Using MetadataLoadContext enables you to inspect assemblies without loading them into the main execution context. Assemblies in MetadataLoadContext are treated only as metadata, that is, you can read information about their members, but cannot execute any code contained in them.
95

https://go.microsoft.com/fwlink/?LinkID=799421

.NET Framework 4.6.2

.NET 8.0

.NET 9.0

.NET 10.0

  • No dependencies.

.NET Standard 2.0

Version Downloads Last updated
10.0.0-preview.1.25080.5 4 02/27/2025
9.0.2 4 02/27/2025
9.0.1 4 01/16/2025
9.0.0 8 11/14/2024
9.0.0-rc.2.24473.5 8 10/10/2024
9.0.0-rc.1.24431.7 9 09/11/2024
9.0.0-preview.7.24405.7 14 08/13/2024
9.0.0-preview.6.24327.7 13 07/09/2024
9.0.0-preview.5.24306.7 22 06/14/2024
9.0.0-preview.4.24266.19 13 05/23/2024
9.0.0-preview.3.24172.9 14 05/21/2024
9.0.0-preview.2.24128.5 14 03/14/2024
9.0.0-preview.1.24080.9 18 02/19/2024
8.0.1 7 10/09/2024
8.0.0 18 11/16/2023
8.0.0-rc.2.23479.6 16 10/19/2023
8.0.0-rc.1.23419.4 20 09/17/2023
8.0.0-preview.7.23375.6 17 09/02/2023
8.0.0-preview.6.23329.7 21 07/12/2023
8.0.0-preview.5.23280.8 19 07/03/2023
8.0.0-preview.4.23259.5 17 06/04/2023
8.0.0-preview.3.23174.8 21 04/15/2023
8.0.0-preview.2.23128.3 27 03/24/2023
8.0.0-preview.1.23110.8 52 03/02/2023
7.0.2 13 07/03/2023
7.0.1 42 04/02/2023
7.0.0 74 12/08/2022
7.0.0-rc.2.22472.3 31 03/02/2023
7.0.0-rc.1.22426.10 45 09/25/2022
7.0.0-preview.7.22375.6 63 09/25/2022
7.0.0-preview.6.22324.4 76 09/22/2022
7.0.0-preview.5.22301.12 93 01/29/2023
7.0.0-preview.4.22229.4 76 09/22/2022
7.0.0-preview.3.22175.4 63 09/22/2022
7.0.0-preview.2.22152.2 50 09/21/2022
7.0.0-preview.1.22076.8 37 09/23/2022
6.0.2 6 11/13/2024
6.0.2-mauipre.1.22102.15 29 01/29/2023
6.0.2-mauipre.1.22054.8 38 02/26/2023
6.0.1 30 09/21/2022
6.0.0 103 01/29/2023
6.0.0-rc.2.21480.5 48 09/25/2022
6.0.0-rc.1.21451.13 55 10/15/2022
6.0.0-preview.7.21377.19 44 02/27/2023
6.0.0-preview.6.21352.12 63 09/21/2022
6.0.0-preview.5.21301.5 25 08/10/2023
6.0.0-preview.4.21253.7 26 09/21/2022
6.0.0-preview.3.21201.4 32 03/26/2023
6.0.0-preview.2.21154.6 83 09/23/2022
6.0.0-preview.1.21102.12 84 09/23/2022
5.0.0 33,898 06/27/2022
5.0.0-rc.2.20475.5 90 09/23/2022
5.0.0-rc.1.20451.14 28 09/24/2022
5.0.0-preview.8.20407.11 72 09/22/2022
5.0.0-preview.7.20364.11 56 09/23/2022
5.0.0-preview.6.20305.6 53 09/21/2022
5.0.0-preview.5.20278.1 32 09/23/2022
5.0.0-preview.4.20251.6 34 03/03/2023
5.0.0-preview.3.20214.6 96 01/31/2023
5.0.0-preview.2.20160.6 67 09/22/2022
5.0.0-preview.1.20120.5 26 09/23/2022
1.8.1 84 09/23/2022
1.8.0 56 09/23/2022
1.8.0-preview3.19551.4 63 09/25/2022
1.8.0-preview2.19523.17 38 09/25/2022
1.8.0-preview1.19504.10 110 09/23/2022
1.7.0 55 09/26/2022
1.7.0-rc1.19456.4 23 03/06/2023
1.7.0-preview9.19421.4 28 09/23/2022
1.7.0-preview9.19416.11 55 01/26/2023
1.7.0-preview8.19405.3 56 03/04/2023
1.7.0-preview7.19362.9 38 09/25/2022
1.7.0-preview6.19303.8 38 09/25/2022
1.7.0-preview6.19264.9 38 02/27/2023
1.7.0-preview5.19224.8 62 09/26/2022
1.7.0-preview4.19212.13 45 09/24/2022
1.7.0-preview3.19128.7 67 09/22/2022
1.7.0-preview.19073.11 22 09/23/2022
1.7.0-preview.18571.3 26 11/22/2022
1.6.0 14,417 06/27/2022
1.6.0-rc1 31 09/21/2022
1.6.0-preview2-26406-04 41 09/26/2022
1.6.0-preview1-26216-02 37 09/21/2022
1.5.0 44 09/26/2022
1.5.0-preview2-25405-01 41 09/23/2022
1.5.0-preview1-25305-02 113 09/23/2022
1.4.2 31 09/21/2022
1.4.1 32 06/27/2022
1.4.1-preview1-24530-04 74 09/22/2022
1.4.1-beta-24430-01 38 09/22/2022
1.4.1-beta-24227-04 81 09/21/2022
1.3.0 24 06/27/2022
1.3.0-rc2-24027 43 09/24/2022
1.2.1-beta-23918 51 02/28/2023
1.2.0 18 01/29/2023
1.2.0-rc3-23811 21 09/25/2022
1.2.0-rc2-23826 97 09/24/2022
1.1.1-beta-23516 32 09/22/2022
1.1.0 84 02/03/2023
1.1.0-alpha-00015 50 09/24/2022
1.1.0-alpha-00014 43 09/21/2022
1.1.0-alpha-00012 18 09/23/2022
1.1.0-alpha-00009 49 01/07/2023
1.0.23-beta-23409 93 09/23/2022
1.0.23-beta-23225 28 09/24/2022
1.0.22 53 01/29/2023
1.0.22-beta-23109 46 09/25/2022
1.0.22-beta-23019 75 09/21/2022
1.0.21 17 06/27/2022
1.0.19-rc 24 01/24/2023
1.0.18-beta 51 09/24/2022
1.0.17-beta 40 09/24/2022