Leadtools.Codecs Send comments on this topic. | Back to Introduction - All Topics | Help Version 16.5.9.25
ReadTag(String,Int32,Int32) Method
See Also 
Leadtools.Codecs Namespace > RasterCodecs Class > ReadTag Method : ReadTag(String,Int32,Int32) Method



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. Use the same tag that you specified in the WriteTag. Examples of registered tags are:

ValueMeaning
0x8298Copyright comment
0x8769General Exif comments
0x8825Exif GPS comments
0x80A4Annotation TIFF tag

Gets the specified tagged data from a TIFF file.

Syntax

Visual Basic (Declaration) 
Public Overloads Function ReadTag( _
   ByVal fileName As String, _
   ByVal pageNumber As Integer, _
   ByVal id As Integer _
) As RasterTagMetadata
Visual Basic (Usage)Copy Code
Dim instance As RasterCodecs
Dim fileName As String
Dim pageNumber As Integer
Dim id As Integer
Dim value As RasterTagMetadata
 
value = instance.ReadTag(fileName, pageNumber, id)
C# 
public RasterTagMetadata ReadTag( 
   string fileName,
   int pageNumber,
   int id
)
C++/CLI 
public:
RasterTagMetadata ReadTag( 
   String^ fileName,
   int pageNumber,
   int 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. Use the same tag that you specified in the WriteTag. Examples of registered tags are:

ValueMeaning
0x8298Copyright comment
0x8769General Exif comments
0x8825Exif GPS comments
0x80A4Annotation TIFF tag

Return Value

The tag data.

Example

For an example, refer to DeleteTag.

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 (Nothing in Visual Basic).

To read all the tags stored in a file, use RasterCodecs.ReadTags(String,Int32)

You can use RasterCodecs.TagsSupported to check if a certain file format supports tags.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family

See Also