System.Reflection.Metadata 8.0.0

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package System.Reflection.Metadata --version 8.0.0
NuGet\Install-Package System.Reflection.Metadata -Version 8.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="System.Reflection.Metadata" Version="8.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add System.Reflection.Metadata --version 8.0.0
#r "nuget: System.Reflection.Metadata, 8.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install System.Reflection.Metadata as a Cake Addin
#addin nuget:?package=System.Reflection.Metadata&version=8.0.0

// Install System.Reflection.Metadata as a Cake Tool
#tool nuget:?package=System.Reflection.Metadata&version=8.0.0

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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (278)

Showing the top 5 NuGet packages that depend on System.Reflection.Metadata:

Package Downloads
Microsoft.TestPlatform.ObjectModel The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

The Microsoft Test Platform Object Model.

Microsoft.CodeAnalysis.Common The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

A shared package used by the Microsoft .NET Compiler Platform ("Roslyn"). Do not install this package manually, it will be added as a prerequisite by other packages that require it. More details at https://aka.ms/roslyn-packages This package was built from the source at https://github.com/dotnet/roslyn/commit/2b7d172669b2f7e55803b55f317cfcc2d4279d76.

Microsoft.CodeAnalysis.CSharp The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

.NET Compiler Platform ("Roslyn") support for C#, Microsoft.CodeAnalysis.CSharp.dll. More details at https://aka.ms/roslyn-packages This package was built from the source at https://github.com/dotnet/roslyn/commit/2b7d172669b2f7e55803b55f317cfcc2d4279d76.

System.Diagnostics.StackTrace The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides the System.Diagnostics.StackTrace class, which allows interaction with local and remote processes. Commonly Used Types: System.Diagnostics.StackFrame System.Diagnostics.StackTrace When using NuGet 3.x this package requires at least version 3.4.

Microsoft.AspNetCore.Hosting The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

ASP.NET Core hosting infrastructure and startup logic for web applications. This package was built from the source code at https://github.com/aspnet/AspNetCore/tree/be0a4a7f4cf06cbd6ec714bd1d9afee6bdb040a8

GitHub repositories (224)

Showing the top 5 popular GitHub repositories that depend on System.Reflection.Metadata:

Repository Stars
icsharpcode/ILSpy
.NET Decompiler with support for PDB generation, ReadyToRun, Metadata (&more) - cross-platform!
dotnet/roslyn
The Roslyn .NET compiler provides C# and Visual Basic languages with rich code analysis APIs.
dotnet/runtime
.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.
winsw/winsw
A wrapper executable that can run any executable as a Windows service, in a permissive license.
NancyFx/Nancy
Lightweight, low-ceremony, framework for building HTTP based services on .Net and Mono
Version Downloads Last updated
9.0.0-preview.5.24306.7 201 6/11/2024
9.0.0-preview.4.24266.19 542 5/21/2024
9.0.0-preview.3.24172.9 1,158 4/11/2024
9.0.0-preview.2.24128.5 1,042 3/12/2024
9.0.0-preview.1.24080.9 1,251 2/13/2024
8.0.0 3,339,820 11/14/2023
8.0.0-rc.2.23479.6 2,659 10/10/2023
8.0.0-rc.1.23419.4 2,906 9/12/2023
8.0.0-preview.7.23375.6 1,736 8/8/2023
8.0.0-preview.6.23329.7 1,818 7/11/2023
8.0.0-preview.5.23280.8 2,414 6/13/2023
8.0.0-preview.4.23259.5 1,138 5/16/2023
8.0.0-preview.3.23174.8 1,336 4/11/2023
8.0.0-preview.2.23128.3 6,658 3/14/2023
8.0.0-preview.1.23110.8 1,931 2/21/2023
7.0.2 810,157 6/13/2023
7.0.1 487,427 3/14/2023
7.0.0 18,835,664 11/7/2022
7.0.0-rc.2.22472.3 30,869 10/11/2022
7.0.0-rc.1.22426.10 1,377 9/14/2022
7.0.0-preview.7.22375.6 4,024 8/9/2022
7.0.0-preview.6.22324.4 1,286 7/12/2022
7.0.0-preview.5.22301.12 808 6/14/2022
7.0.0-preview.4.22229.4 11,565 5/10/2022
7.0.0-preview.3.22175.4 824 4/13/2022
7.0.0-preview.2.22152.2 2,218 3/14/2022
7.0.0-preview.1.22076.8 883 2/17/2022
6.0.2-mauipre.1.22102.15 1,250 2/15/2022
6.0.2-mauipre.1.22054.8 1,525 1/19/2022
6.0.1 27,534,225 3/8/2022
6.0.0 27,220,441 11/8/2021
6.0.0-rc.2.21480.5 1,216 10/12/2021
6.0.0-rc.1.21451.13 2,070 9/14/2021
6.0.0-preview.7.21377.19 1,525 8/10/2021
6.0.0-preview.6.21352.12 1,093 7/14/2021
6.0.0-preview.5.21301.5 1,026 6/15/2021
6.0.0-preview.4.21253.7 760 5/24/2021
6.0.0-preview.3.21201.4 5,267 4/8/2021
6.0.0-preview.2.21154.6 1,524 3/11/2021
6.0.0-preview.1.21102.12 1,048 2/12/2021
5.0.0 203,339,949 11/9/2020
5.0.0-rc.2.20475.5 14,283 10/13/2020
5.0.0-rc.1.20451.14 8,992 9/14/2020
5.0.0-preview.8.20407.11 271,508 8/25/2020
5.0.0-preview.7.20364.11 4,551 7/21/2020
5.0.0-preview.6.20305.6 1,753 6/25/2020
5.0.0-preview.5.20278.1 1,310 6/10/2020
5.0.0-preview.4.20251.6 2,770 5/18/2020
5.0.0-preview.3.20214.6 1,862 4/23/2020
5.0.0-preview.2.20160.6 11,251 4/2/2020
5.0.0-preview.1.20120.5 9,655 3/16/2020
1.8.1 11,677,702 5/12/2020
1.8.0 9,027,390 12/3/2019
1.8.0-preview3.19551.4 2,073 11/13/2019
1.8.0-preview2.19523.17 1,169 11/1/2019
1.8.0-preview1.19504.10 2,244 10/15/2019
1.7.0 6,673,937 9/23/2019
1.7.0-rc1.19456.4 3,397 9/16/2019
1.7.0-preview9.19421.4 2,389 9/4/2019
1.7.0-preview9.19416.11 814 9/4/2019
1.7.0-preview8.19405.3 3,922 8/13/2019
1.7.0-preview7.19362.9 3,286 7/23/2019
1.7.0-preview6.19303.8 4,607 6/12/2019
1.7.0-preview6.19264.9 832 9/4/2019
1.7.0-preview5.19224.8 6,988 5/6/2019
1.7.0-preview4.19212.13 7,972 4/18/2019
1.7.0-preview3.19128.7 7,064 3/6/2019
1.7.0-preview.19073.11 2,996 1/29/2019
1.7.0-preview.18571.3 10,032 12/3/2018
1.6.0 599,035,427 5/29/2018
1.6.0-rc1 320,929 5/6/2018
1.6.0-preview2-26406-04 366,470 4/10/2018
1.6.0-preview1-26216-02 283,004 2/26/2018
1.5.0 49,454,754 8/11/2017
1.5.0-preview2-25405-01 7,001 6/27/2017
1.5.0-preview1-25305-02 8,988 5/9/2017
1.4.2 163,250,072 1/3/2017
1.4.1 196,435,208 11/15/2016
1.4.1-preview1-24530-04 106,854 10/24/2016
1.4.1-beta-24430-01 561,105 10/13/2016
1.4.1-beta-24227-04 271,998 6/30/2016
1.3.0 296,578,740 6/27/2016
1.3.0-rc2-24027 10,738,104 5/16/2016
1.2.1-beta-23918 5,556 3/18/2016
1.2.0 2,262,323 3/8/2016
1.2.0-rc3-23811 45,778 3/5/2016
1.2.0-rc2-23826 18,821 3/1/2016
1.1.1-beta-23516 31,263 11/18/2015
1.1.0 3,610,345 10/27/2015
1.1.0-alpha-00015 5,310 10/9/2015
1.1.0-alpha-00014 135,642 9/29/2015
1.1.0-alpha-00012 5,360 9/24/2015
1.1.0-alpha-00009 62,767 9/3/2015
1.0.23-beta-23409 4,453 10/15/2015
1.0.23-beta-23225 125,577 9/2/2015
1.0.22 1,503,380 7/29/2015
1.0.22-beta-23109 4,260 7/27/2015
1.0.22-beta-23019 4,694 6/30/2015
1.0.21 5,662,167 5/11/2015
1.0.19-rc 13,322 3/6/2015
1.0.18-beta 651,069 12/10/2014
1.0.17-beta 150,646 10/10/2014