ReadTag(string,int,int) Method

Summary

Gets the specified tagged data from a TIFF file.

Syntax

Objective-C

C++/CLI

Python

public RasterTagMetadata ReadTag( 
   string fileName, 
   int pageNumber, 
   int id 
)

- (nullable LTRasterTagMetadata *)readTag:(NSUInteger)tagId  
                                 fromFile:(NSString *)file  
                               pageNumber:(NSInteger)pageNumber  
                                    error:(NSError **)error

public: 
RasterTagMetadata^ ReadTag(  
   String^ fileName, 
   int pageNumber, 
   int id 
)

def ReadTag(self,fileName,pageNumber,id):

Parameters

fileName
A String containing the input file name.

pageNumber
1-based index of the page from which to read the tag.

id
Tag to identify the data in the TIFF file (or file format that supports Exif metadata). Use the same tag that you specified in the WriteTag. Examples of registered tags are:

Value	Meaning
0x8298	Copyright comment
0x8769	General Exif comments
0x8825	Exif GPS comments
0x80A4	Annotation TIFF tag

Return Value

The tag data.

Remarks

This method is provided to support TIFF tags that you define. If no such tag exists in the image, this method will return a null reference.

To read all the tags stored in a file, use ReadTags

You can use TagsSupported to determine whether a certain file format supports tags.

Example

Java

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.ImageProcessing; 
using Leadtools.ImageProcessing.Color; 
using Leadtools.Svg; 
 
 
 
public void TagExample() 
{ 
   RasterCodecs codecs = new RasterCodecs(); 
 
   string srcFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1.cmp"); 
   string destFileName = Path.Combine(LEAD_VARS.ImagesDir, "Image1_CustomTag.tif"); 
 
   // Convert the source file to TIF 
   Debug.WriteLine("Converting the source file to TIF"); 
   codecs.Convert(srcFileName, destFileName, RasterImageFormat.Tif, 0, 0, 24, null); 
 
   const int customTagId = 0x8000; /* 32768 in decimal */ 
   int customTagValue = 7; 
 
   RasterTagMetadata writeTag = new RasterTagMetadata(); 
   writeTag.Id = customTagId; 
   writeTag.DataType = RasterTagMetadataDataType.Int32; 
   writeTag.FromInt32(new int[] { customTagValue }); 
 
   Debug.WriteLine("Writing the following tag to the file:"); 
   Debug.WriteLine("  ID: {0}", writeTag.Id); 
   Debug.WriteLine("  DataType: {0}", writeTag.DataType); 
   Console.Write("  Data: "); 
   byte[] writeTagData = writeTag.GetData(); 
   for (int i = 0; i < writeTagData.Length; i++) 
      Console.Write("{0:X} ", writeTagData[i]); 
   Debug.WriteLine(" "); 
 
   // Add the tag 
   Debug.WriteLine("Writing the custom tag with data = {0} to the file", customTagValue); 
   codecs.WriteTag(destFileName, 1, writeTag); 
 
   // Read the tag and make sure its in the file 
   Debug.WriteLine("Reading the custom tag from the file"); 
   RasterTagMetadata readTag = codecs.ReadTag(destFileName, 1, customTagId); 
 
   Debug.WriteLine("Tag read from the file:"); 
   Debug.WriteLine("  ID: {0}", readTag.Id); 
   Debug.WriteLine("  DataType: {0}", readTag.DataType); 
   Console.Write("  Data: "); 
   byte[] readTagData = readTag.GetData(); 
   for (int i = 0; i < readTagData.Length; i++) 
      Console.Write("{0:X} ", readTagData[i]); 
   Debug.WriteLine("  "); 
 
   Debug.Assert(writeTag.Id == readTag.Id); 
   Debug.Assert(writeTag.DataType == readTag.DataType); 
   Debug.Assert(writeTagData.Length == writeTagData.Length); 
   for (int i = 0; i < writeTagData.Length; i++) 
      Debug.Assert(writeTagData[i] == readTagData[i]); 
 
   // Delete the tag from the file 
   Debug.WriteLine("Deleting the tag from the file"); 
   codecs.DeleteTag(destFileName, 1, customTagId); 
 
   // Make sure the tag is deleted 
   Debug.WriteLine("Reading the tag from the file again"); 
   readTag = codecs.ReadTag(destFileName, 1, customTagId); 
 
   if (readTag == null) 
      Debug.WriteLine("Tag was not found"); 
   else 
      Debug.WriteLine("Tag is found, this should not happen"); 
 
   Debug.Assert(readTag == null); 
 
   // Clean up 
   codecs.Dispose(); 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS23\Resources\Images"; 
}

 
import java.io.*; 
import java.net.*; 
import java.nio.file.Paths; 
import java.util.*; 
import java.time.Instant; 
import java.time.Duration; 
 
import org.junit.*; 
import org.junit.runner.JUnitCore; 
import org.junit.runner.Result; 
import org.junit.runner.notification.Failure; 
import static org.junit.Assert.*; 
 
import leadtools.*; 
import leadtools.codecs.*; 
import leadtools.codecs.RasterCodecs.FeedCallbackThunk; 
import leadtools.drawing.internal.*; 
import leadtools.imageprocessing.*; 
import leadtools.imageprocessing.color.ChangeIntensityCommand; 
import leadtools.svg.*; 
 
 
public void tagExample() throws IOException { 
   final String LEAD_VARS_IMAGES_DIR = "C:\\LEADTOOLS23\\Resources\\Images"; 
   RasterCodecs codecs = new RasterCodecs(); 
 
   String srcFileName = combine(LEAD_VARS_IMAGES_DIR, "Image1.cmp"); 
   String destFileName = combine(LEAD_VARS_IMAGES_DIR, "Image1_CustomTag.tif"); 
 
   // Convert the source file to TIF 
   System.out.println("Converting the source file to TIF"); 
   codecs.convert(srcFileName, destFileName, RasterImageFormat.TIF, 0, 0, 24, null); 
 
   final int customTagId = 0x8000; // 32768 in decimal // 
   int customTagValue = 7; 
 
   RasterTagMetadata writeTag = new RasterTagMetadata(); 
   writeTag.setId(customTagId); 
   writeTag.setDataType(RasterTagMetadataDataType.INT_32); 
   writeTag.fromInt32(new int[] { customTagValue }); 
 
   System.out.println("Writing the following tag to the file:"); 
   System.out.println("  ID: " + writeTag.getId()); 
   System.out.println("  DataType: " + writeTag.getDataType()); 
   System.out.println("  Data: "); 
   byte[] writeTagData = writeTag.getData(); 
   for (int i = 0; i < writeTagData.length; i++) 
      System.out.println(writeTagData[i]); 
   System.out.println(" "); 
 
   // Add the tag 
   System.out.printf("Writing the custom tag with data = %s to the file%n", customTagValue); 
   ILeadStream destFileStream = LeadStreamFactory.create(destFileName); 
   codecs.writeTag(destFileStream, 1, writeTag); 
 
   // Read the tag and make sure its in the file 
   System.out.println("Reading the custom tag from the file"); 
   RasterTagMetadata readTag = codecs.readTag(destFileStream, 1, customTagId); 
 
   System.out.println("Tag read from the file:"); 
   System.out.println("  ID: " + readTag.getId()); 
   System.out.println("  DataType: +" + readTag.getDataType()); 
   System.out.println("  Data: "); 
   byte[] readTagData = readTag.getData(); 
   for (int i = 0; i < readTagData.length; i++) 
      System.out.println(readTagData[i]); 
   System.out.println("  "); 
 
   assertTrue(writeTag.getId() == readTag.getId()); 
   assertTrue(writeTag.getDataType() == readTag.getDataType()); 
   assertTrue(writeTagData.length == writeTagData.length); 
   for (int i = 0; i < writeTagData.length; i++) 
      assertTrue(writeTagData[i] == readTagData[i]); 
 
   // Delete the tag from the file 
   System.out.println("Deleting the tag from the file"); 
   codecs.deleteTag(destFileStream, 1, customTagId); 
 
   // Make sure the tag is deleted 
   System.out.println("Reading the tag from the file again"); 
   readTag = codecs.readTag(destFileStream, 1, customTagId); 
 
   if (readTag == null) 
      System.out.println("Tag was not found"); 
   else 
      System.out.println("Tag is found, this should not happen"); 
 
   assertTrue(readTag == null); 
 
   // Clean up 
   destFileStream.close(); 
   codecs.dispose(); 
}