Pull Metadata from an Image - Console C#

This tutorial shows how to create a C# Windows Console application that allows the images's metadata to be accessed using the LEADTOOLS SDK.

Summary This tutorial covers how to use LEADTOOLS Imaging SDK technology in a C# Windows Console application.
Completion Time 30 minutes
Visual Studio Project Download tutorial project (2 KB)
Platform Console C# Application
IDE Visual Studio 2017, 2019
Development License Download LEADTOOLS
Try it in another language

Required Knowledge

Get familiar with the basic steps of creating a project by reviewing the Add References and Set a License tutorial, before working on the Pull Metadata from an Image - Console C# tutorial.

Create the Project and Add the LEADTOOLS References

In Visual Studio, create a new C# Windows Console project, and add the following necessary LEADTOOLS references.

The references needed depend upon the purpose of the project. References can be added by one or the other of the following two methods (but not both). For this project, the following references are needed:

If using NuGet references, this tutorial requires the following NuGet package:

If local DLL references are used, the following DLLs are needed. The DLLs are located at <INSTALL_DIR>\LEADTOOLS21\Bin\Dotnet4\x64:

For a complete list of which Codec DLLs are required for specific formats, refer to File Format Support.

Set the License File

The License unlocks the features needed for the project. It must be set before any toolkit function is called. For details, including tutorials for different platforms, refer to Setting a Runtime License.

There are two types of runtime licenses:


Adding LEADTOOLS NuGet and local references and setting a license are covered in more detail in the Add References and Set a License tutorial.

Gather and Display the Metadata

With the project created, the references added, and the license set, coding can begin.

In Solution Explorer, open Program.cs. Add the following statements to the using block at the top of Program.cs:

// Using block at the top 
using System; 
using System.IO; 
using System.Collections.Generic; 
using Leadtools; 
using Leadtools.Codecs; 

Add a new method called GatherMetadata and call it in the Main method after SetLicense() call. Add the code below to gather and display the metadata of an image.

static void GatherMetadata() 
   string srcFile = @"C:\LEADTOOLS21\Resources\Images\cannon.jpg"; 
   using (var rasterCodecs = new RasterCodecs()) 
   using (var fileInfo = rasterCodecs.GetInformation(srcFile, false)) 
      Console.WriteLine("Format: {0}", fileInfo.Format); 
      // Check if metadata is supported for the specified file format 
      bool isMetadataItemsSupported = RasterCodecs.MetadataItemsSupported(fileInfo.Format); 
      Console.WriteLine("isMetadataItemsSupported: {0}", isMetadataItemsSupported); 
      if (isMetadataItemsSupported) 
         // Read metadata items 
         IDictionary<string, string> metadata = null; 
            metadata = rasterCodecs.ReadMetadataItems(srcFile, 1); 
         catch (Exception ex) 
            Console.WriteLine("Unable to read metadata: {0}", ex.Message); 
         if (metadata != null) 
            Console.WriteLine("Items count: {0}", metadata.Count); 
            foreach (var item in metadata) 
               // Key ex: RasterCodecs.FileMetadataKeyAuthor 
               Console.WriteLine("{0}: {1}", item.Key, item.Value); 

Run the Project

Run the project by pressing F5, or by selecting Debug -> Start Debugging.

If the steps were followed correctly, the application runs and displays information from the sample image within the console. This tutorial uses the sample image from this file path: <INSTALL_DIR>\LEADTOOLS21\Resources\Images\cannon.jpg

Output metadata


This tutorial showed how to load an image and read its metadata items. Also, it covered how to use the RasterCodecs class.

See Also

Help Version 21.0.2023.3.1
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 LEAD Technologies, Inc. All Rights Reserved.